Scalars and multipliers
The following parameters scale or multiply values set in other areas of the configuration file or other input files. This can be especially useful for understanding the sensitivities of disease dynamics to input data without requiring modifications to those base values. For example, one might set x_Birth to a value less than 1 to simulate a lower future birth rate due to increased economic prosperity and available medical technology.
Note
1 2 3 4 5 6 7 8 9 10 11 | |
| Parameter | Example | Description | Type | Min | Max | Default |
|---|---|---|---|---|---|---|
| Birth_Rate_Time_Dependence | link | A scale factor for BirthRate that allows it to be altered by time or season. Enable_Birth must be set to true (1). Possible values are: NONE Birth rate does not vary by time. SINUSOIDAL_FUNCTION_OF_TIME Allows birth rate to be time-dependent, following a sinusoidal shape defined by \(1 + \sin \text{Birth\_Rate\_Sinusoidal\_Forcing\_Amplitude} \times \sin(2 \pi \times (\text{day} - \sin \text{Birth\_Rate\_Sinusoidal\_Forcing\_Phase})/365)\). Set Birth_Rate_Sinusoidal_Forcing_Amplitude and Birth_Rate_Sinusoidal_Forcing_Phase. ANNUAL_BOXCAR_FUNCTION Allows birth rate to follow a boxcar function. The scale factor will be equal to 1 except for a single interval in which it is equal to a given constant equal to 1 + Birth_Rate_Boxcar_Forcing_Amplitude. Set Birth_Rate_Boxcar_Forcing_Amplitude, Birth_Rate_Boxcar_Forcing_End_Time, and Birth_Rate_Boxcar_Forcing_Start_Time. |
enum | nan | nan | NONE |
| Infectivity_Exponential_Baseline | link | The scale factor applied to Base_Infectivity at the beginning of a simulation, before the infectivity begins to grow exponentially. Infectivity_Scale_Type must be set to EXPONENTIAL_FUNCTION_OF_TIME. | float | 0 | 1 | 0 |
| Infectivity_Exponential_Delay | link | The number of days before infectivity begins to ramp up exponentially. When Enable_Infectivity_Scaling_Exponential configuration parameter is enabled, Infectivity_Exponential_Delay is an expected parameter. | float | 0 | 3.4e+38 | 0 |
| Infectivity_Exponential_Rate | link | The daily rate of exponential growth to approach to full infectivity after the delay set by Infectivity_Exponential_Delay has passed. When Enable_Infectivity_Scaling_Exponential configuration parameter is enabled, Infectivity_Exponential_Rate is an expected parameter. | float | 0 | 3.4e+38 | 0 |
| Population_Scale_Type | link | The method to use for scaling the initial population specified in the demographics input file. Possible values are: USE_INPUT_FILE Turns off population scaling and uses InitialPopulation in the demographics file (see parameters). FIXED_SCALING Enables Base_Population_Scale_Factor. |
enum | nan | nan | USE_INPUT_FILE |
| Post_Infection_Acquisition_Multiplier | link | The multiplicative reduction in the probability of reacquiring disease. At the time of recovery, the immunity against acquisition is multiplied by Acquisition_Blocking_Immunity_Decay_Rate x (1 - Post_Infection_Acquisition_Multiplier). Enable_Immunity must be set to 1 (true). | float | 0 | 1 | 0 |
| Post_Infection_Mortality_Multiplier | link | The multiplicative reduction in the probability of dying from infection after getting reinfected. At the time of recovery, the immunity against mortality is multiplied by Mortality_Blocking_Immunity_Decay_Rate x (1 - Post_Infection_Mortality_Multiplier). Enable_Immunity must be set to 1 (true). | float | 0 | 1 | 0 |
| Post_Infection_Transmission_Multiplier | link | The multiplicative reduction in the probability of transmitting infection after getting reinfected. At the time of recovery, the immunity against transmission is multiplied by Transmission_Blocking_Immunity_Decay_Rate x (1 - Post_Infection_Transmission_Multiplier). Enable_Immunity must be set to 1 (true). | float | 0 | 1 | 0 |
| x_Air_Migration | link | Scale factor for the rate of migration by air, as provided by the migration file. Enable_Air_Migration must be set to 1. | float | 0 | 3.4e+38 | 1 |
| x_Base_Population | link | Scale factor for InitialPopulation in the demographics file (see parameters). If Population_Scale_Type is set to FIXED_SCALING, the initial simulation population is uniformly scaled over the entire area to adjust for historical or future population density. | float | 0 | 3.4e+38 | 1 |
| x_Birth | link | Scale factor for birth rate, as provided by the demographics file (see parameters). Enable_Birth must be set to 1. | float | 0 | 3.4e+38 | 1 |
| x_Family_Migration | link | Scale factor for the rate of migration by families, as provided by the migration file. Enable_Family_Migration must be set to true (1). | float | 0 | 3.4e+38 | 1 |
| x_Local_Migration | link | Scale factor for rate of migration by foot travel, as provided by the migration file. Enable_Local_Migration must be set to 1. | float | 0 | 3.4e+38 | 1 |
| x_Other_Mortality | link | Scale factor for mortality from causes other than the disease being simulated. Base mortality is provided by the demographics file (see parameters). Enable_Natural_Mortality must be set to 1. | float | 0 | 3.4e+38 | 1 |
| x_Regional_Migration | link | Scale factor for the rate of migration by road vehicle, as provided by the migration file. Enable_Regional_Migration must be set to 1. | float | 0 | 3.4e+38 | 1 |
| x_Sea_Migration | link | Scale factor for the rate of migration by sea, as provided by the migration file. Enable_Sea_Migration must be set to 1. | float | 0 | 3.4e+38 | 1 |