Repository navigation
Update references and documentation of dampings #1597
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -87,6 +87,21 @@ school closures, or social distancing. This is done by adding ``Damping``\s to t | |||||
| group-specific reductions are possible through setting particular rows or columns differently. With a constant | ||||||
| reduction factor :math:`r`, the reduced contact rate is :math:`(1-r) * c_{i,j}`. | ||||||
|
|
||||||
| Each ``Damping`` also has a *level* and a *type*, given as ``DampingLevel`` and ``DampingType``. You set them with ``mio::DampingLevel(level)`` and | ||||||
| ``mio::DampingType(type)``, where ``level`` and ``type`` are integers. They control how dampings that are | ||||||
| active at the same time are combined: | ||||||
|
|
||||||
| - **Same level, different type:** the dampings are *added*. Use this for measures that act on separate parts of | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| the contacts, e.g., a school closure and an office closure. | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| - **Different levels:** the dampings are combined *multiplicatively*. Use this for measures that act on the same | ||||||
| contacts, e.g., a mask mandate on top of closures. The total reduction of two levels with sums :math:`a` and | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why "with sum"? Do you mean "with factors"? |
||||||
| :math:`b` is :math:`1 - (1-a)(1-b)`. | ||||||
| - **Same level and same type:** the newer damping *replaces* the older one from its start time on. Use this to | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| tighten or relax a measure. | ||||||
|
|
||||||
| If no level or type is given, both are ``0``. In that case every new damping replaces the previous one. | ||||||
|
|
||||||
|
|
||||||
| .. dropdown:: :fa:`gears` Expert's settings | ||||||
|
|
||||||
| In some settings, contact rates cannot be reduced to zero to keep essential sectors of the society running. In this | ||||||
|
|
||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -117,6 +117,12 @@ where each entry represents the contact frequency between two age groups. | |||||
| (num_groups, num_groups)) | ||||||
|
|
||||||
| Then, dampings can be added as a relative factor to (partially) reduce the contacts defined by the ``ContactPatterns`` beginning at a time step ``t=30``. | ||||||
| Besides the coefficients and the start time, every damping has a ``level`` and a ``type``. They decide how dampings that are active at the same time are combined: | ||||||
|
|
||||||
| - **Same level, different type:** the reductions are added (e.g., measures that act on separate parts of the contacts). | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| - **Different levels:** the reductions are combined multiplicatively, :math:`1 - (1-a)(1-b)` (e.g., measures that act | ||||||
| on top of an already existing measure). | ||||||
| - **Same level and type:** the newer damping replaces the older one from its start time on (e.g., to tighten or relax a measure). | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| .. code-block:: python | ||||||
|
|
||||||
|
|
||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.