Changes between Version 3 and Version 4 of doc/app/agent_parameters


Ignore:
Timestamp:
Jul 25, 2018 6:59:08 AM (6 years ago)
Author:
sward
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • doc/app/agent_parameters

    v3 v4  
    3131{{{#!td
    3232Distance along x between agents within an agent source (in m).\\\\
    33 Each agent source is defined as an area from x = [#asl asl] to [#asr asr] and y = [#ass ass] to [#asn asn]. The first agent is released at x = asl; y = ass. More agents are released at x = asl + N * adx (x <= asr) and y = ass + N * ady (y <= asn), forming a raster.\\\\
     33Each agent source is defined as an area from x = [#asl asl] to [#asr asr] and y = [#ass ass] to [#asn asn]. The first agent is released at x = asl; y = ass. More agents are released at x = asl + N * '''adx''' (x <= asr) and y = ass + N * ady (y <= asn), forming a raster.\\\\
    3434To add a random element to these release points, see [#random_start_position_agents random_start_position_agents].
    3535}}}
     
    7272{{{#!td
    7373Flag to determine number of unlimited dimensions in NetCDF output file.\\\\
    74 In the agent NetCDF output file only the number of agents is an unlimited dimension by default. Contrarily, the time dimension is estimated as having a size of 1.2 * [/app/d3par#end_time end_time] / [#dt_write_agent_data dt_write_agent_data] by default. If this flag is set to .T., both dimensions are set as unlimited. This requires NetCDF4, HDF5 and results in a much larger output file. This might be necessary for restart runs (not implemented so far) or
    75 }}}
    76 |----------------
    77 {{{#!td style="vertical-align:top; text-align:left;width: 150px"
    78 [=#PARAMETER '''PARAMETER''']
    79 }}}
    80 {{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
    81 DATA TYPE
    82 }}}
    83 {{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
    84 DEFAULT VALUE
    85 }}}
    86 {{{#!td
    87 EXPLANATION
    88 }}}
    89 |----------------
    90 {{{#!td style="vertical-align:top; text-align:left;width: 150px"
    91 [=#PARAMETER '''PARAMETER''']
    92 }}}
    93 {{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
    94 DATA TYPE
    95 }}}
    96 {{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
    97 DEFAULT VALUE
    98 }}}
    99 {{{#!td
    100 EXPLANATION
    101 }}}
    102 |----------------
    103 {{{#!td style="vertical-align:top; text-align:left;width: 150px"
    104 [=#PARAMETER '''PARAMETER''']
    105 }}}
    106 {{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
    107 DATA TYPE
    108 }}}
    109 {{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
    110 DEFAULT VALUE
    111 }}}
    112 {{{#!td
    113 EXPLANATION
    114 }}}
    115 |----------------
    116 {{{#!td style="vertical-align:top; text-align:left;width: 150px"
    117 [=#PARAMETER '''PARAMETER''']
    118 }}}
    119 {{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
    120 DATA TYPE
    121 }}}
    122 {{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
    123 DEFAULT VALUE
    124 }}}
    125 {{{#!td
    126 EXPLANATION
    127 }}}
    128 |----------------
    129 {{{#!td style="vertical-align:top; text-align:left;width: 150px"
    130 [=#PARAMETER '''PARAMETER''']
    131 }}}
    132 {{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
    133 DATA TYPE
    134 }}}
    135 {{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
    136 DEFAULT VALUE
    137 }}}
    138 {{{#!td
    139 EXPLANATION
    140 }}}
    141 |----------------
    142 {{{#!td style="vertical-align:top; text-align:left;width: 150px"
    143 [=#PARAMETER '''PARAMETER''']
    144 }}}
    145 {{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
    146 DATA TYPE
    147 }}}
    148 {{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
    149 DEFAULT VALUE
    150 }}}
    151 {{{#!td
    152 EXPLANATION
    153 }}}
    154 |----------------
    155 {{{#!td style="vertical-align:top; text-align:left;width: 150px"
    156 [=#PARAMETER '''PARAMETER''']
    157 }}}
    158 {{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
    159 DATA TYPE
    160 }}}
    161 {{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
    162 DEFAULT VALUE
    163 }}}
    164 {{{#!td
    165 EXPLANATION
    166 }}}
    167 |----------------
    168 {{{#!td style="vertical-align:top; text-align:left;width: 150px"
    169 [=#PARAMETER '''PARAMETER''']
    170 }}}
    171 {{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
    172 DATA TYPE
    173 }}}
    174 {{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
    175 DEFAULT VALUE
    176 }}}
    177 {{{#!td
    178 EXPLANATION
    179 }}}
    180 |----------------
    181 {{{#!td style="vertical-align:top; text-align:left;width: 150px"
    182 [=#PARAMETER '''PARAMETER''']
    183 }}}
    184 {{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
    185 DATA TYPE
    186 }}}
    187 {{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
    188 DEFAULT VALUE
    189 }}}
    190 {{{#!td
    191 EXPLANATION
    192 }}}
    193 |----------------
    194 {{{#!td style="vertical-align:top; text-align:left;width: 150px"
    195 [=#PARAMETER '''PARAMETER''']
    196 }}}
    197 {{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
    198 DATA TYPE
    199 }}}
    200 {{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
    201 DEFAULT VALUE
    202 }}}
    203 {{{#!td
    204 EXPLANATION
    205 }}}
    206 |----------------
    207 {{{#!td style="vertical-align:top; text-align:left;width: 150px"
    208 [=#PARAMETER '''PARAMETER''']
    209 }}}
    210 {{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
    211 DATA TYPE
    212 }}}
    213 {{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
    214 DEFAULT VALUE
    215 }}}
    216 {{{#!td
    217 EXPLANATION
    218 }}}
    219 |----------------
    220 {{{#!td style="vertical-align:top; text-align:left;width: 150px"
    221 [=#PARAMETER '''PARAMETER''']
    222 }}}
    223 {{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
    224 DATA TYPE
    225 }}}
    226 {{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
    227 DEFAULT VALUE
    228 }}}
    229 {{{#!td
    230 EXPLANATION
    231 }}}
    232 |----------------
    233 {{{#!td style="vertical-align:top; text-align:left;width: 150px"
    234 [=#PARAMETER '''PARAMETER''']
    235 }}}
    236 {{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
    237 DATA TYPE
    238 }}}
    239 {{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
    240 DEFAULT VALUE
    241 }}}
    242 {{{#!td
    243 EXPLANATION
    244 }}}
     74In the agent NetCDF output file only the number of agents is an unlimited dimension by default. Contrarily, the time dimension is estimated as having a size of 1.2 * [/wiki/doc/app/d3par#end_time end_time] / [#dt_write_agent_data dt_write_agent_data] by default. If this flag is set to .T., both dimensions are set as unlimited. This requires NetCDF4, HDF5 and results in a much larger output file.
     75}}}
     76|----------------
     77{{{#!td style="vertical-align:top; text-align:left;width: 150px"
     78[=#alloc_factor_mas '''alloc_factor_mas''']
     79}}}
     80{{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
     81R
     82}}}
     83{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
     8420.0
     85}}}
     86{{{#!td
     87Factor (in percent) describing the memory allocated additionally to the memory needed for initial agents at a given grid cell.\\\\
     88Implementation is the same as [/wiki/doc/app/parpar#alloc_factor alloc_factor]. Check for reference.
     89}}}
     90|----------------
     91{{{#!td style="vertical-align:top; text-align:left;width: 150px"
     92[=#asl '''asl''']
     93}}}
     94{{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
     95R(100)
     96}}}
     97{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
     98100 * 9999999.9
     99}}}
     100{{{#!td
     101Left border of agent source(s) (in m).\\\\
     102Check [#adx adx] for information of agent sources.
     103}}}
     104|----------------
     105{{{#!td style="vertical-align:top; text-align:left;width: 150px"
     106[=#asn '''asn''']
     107}}}
     108{{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
     109R(100)
     110}}}
     111{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
     112100 * 9999999.9
     113}}}
     114{{{#!td
     115North border of agent source(s) (in m).\\\\
     116Check [#adx adx] for information of agent sources.
     117}}}
     118|----------------
     119{{{#!td style="vertical-align:top; text-align:left;width: 150px"
     120[=#asr '''asr''']
     121}}}
     122{{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
     123R(100)
     124}}}
     125{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
     126100 * 9999999.9
     127}}}
     128{{{#!td
     129Right border of agent source(s) (in m).\\\\
     130Check [#adx adx] for information of agent sources.
     131}}}
     132|----------------
     133{{{#!td style="vertical-align:top; text-align:left;width: 150px"
     134[=#ass '''ass''']
     135}}}
     136{{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
     137R(100)
     138}}}
     139{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
     140100 * 9999999.9
     141}}}
     142{{{#!td
     143South border of agent source(s) (in m).\\\\
     144Check [#adx adx] for information of agent sources.
     145}}}
     146|----------------
     147{{{#!td style="vertical-align:top; text-align:left;width: 150px"
     148[=#PARAMETER '''PARAMETER''']
     149}}}
     150{{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
     151DATA TYPE
     152}}}
     153{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
     154DEFAULT VALUE
     155}}}
     156{{{#!td
     157EXPLANATION
     158}}}
     159|----------------
     160{{{#!td style="vertical-align:top; text-align:left;width: 150px"
     161[=#PARAMETER '''PARAMETER''']
     162}}}
     163{{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
     164DATA TYPE
     165}}}
     166{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
     167DEFAULT VALUE
     168}}}
     169{{{#!td
     170EXPLANATION
     171}}}
     172|----------------
     173{{{#!td style="vertical-align:top; text-align:left;width: 150px"
     174[=#PARAMETER '''PARAMETER''']
     175}}}
     176{{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
     177DATA TYPE
     178}}}
     179{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
     180DEFAULT VALUE
     181}}}
     182{{{#!td
     183EXPLANATION
     184}}}
     185|----------------
     186{{{#!td style="vertical-align:top; text-align:left;width: 150px"
     187[=#PARAMETER '''PARAMETER''']
     188}}}
     189{{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
     190DATA TYPE
     191}}}
     192{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
     193DEFAULT VALUE
     194}}}
     195{{{#!td
     196EXPLANATION
     197}}}
     198|----------------
     199{{{#!td style="vertical-align:top; text-align:left;width: 150px"
     200[=#PARAMETER '''PARAMETER''']
     201}}}
     202{{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
     203DATA TYPE
     204}}}
     205{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
     206DEFAULT VALUE
     207}}}
     208{{{#!td
     209EXPLANATION
     210}}}
     211|----------------
     212{{{#!td style="vertical-align:top; text-align:left;width: 150px"
     213[=#PARAMETER '''PARAMETER''']
     214}}}
     215{{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
     216DATA TYPE
     217}}}
     218{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
     219DEFAULT VALUE
     220}}}
     221{{{#!td
     222EXPLANATION
     223}}}
     224|----------------
     225{{{#!td style="vertical-align:top; text-align:left;width: 150px"
     226[=#PARAMETER '''PARAMETER''']
     227}}}
     228{{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
     229DATA TYPE
     230}}}
     231{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
     232DEFAULT VALUE
     233}}}
     234{{{#!td
     235EXPLANATION
     236}}}
     237|----------------
     238{{{#!td style="vertical-align:top; text-align:left;width: 150px"
     239[=#PARAMETER '''PARAMETER''']
     240}}}
     241{{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
     242DATA TYPE
     243}}}
     244{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
     245DEFAULT VALUE
     246}}}
     247{{{#!td
     248EXPLANATION
     249}}}
     250|----------------
     251{{{#!td style="vertical-align:top; text-align:left;width: 150px"
     252[=#PARAMETER '''PARAMETER''']
     253}}}
     254{{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
     255DATA TYPE
     256}}}
     257{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
     258DEFAULT VALUE
     259}}}
     260{{{#!td
     261EXPLANATION
     262}}}
     263|----------------
     264{{{#!td style="vertical-align:top; text-align:left;width: 150px"
     265[=#PARAMETER '''PARAMETER''']
     266}}}
     267{{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
     268DATA TYPE
     269}}}
     270{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
     271DEFAULT VALUE
     272}}}
     273{{{#!td
     274EXPLANATION
     275}}}
     276|----------------
     277{{{#!td style="vertical-align:top; text-align:left;width: 150px"
     278[=#PARAMETER '''PARAMETER''']
     279}}}
     280{{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
     281DATA TYPE
     282}}}
     283{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
     284DEFAULT VALUE
     285}}}
     286{{{#!td
     287EXPLANATION
     288}}}