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


Ignore:
Timestamp:
Jul 24, 2018 8:17:25 AM (6 years ago)
Author:
sward
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • doc/app/agent_parameters

    v2 v3  
    1313}}}
    1414{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
    15 100*.F.
    16 }}}
    17 {{{#!td
     15100 * .F.
     16}}}
     17{{{#!td
     18Flag for agents within a group to have random targets outside of model domain.\\\\
    1819One logical value per agent [#number_of_agent_groups group]. If .T., each agent in that group will have a random target just outside the model domain. Otherwise a target (see [#at_x at_x]/[#at_y at_y]) must be set manually for each agent group.
    1920}}}
     
    2930}}}
    3031{{{#!td
    31 Distance along x between agents within an agent source (in m).
     32Distance along x between agents within an agent source (in m).\\\\
     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.\\\\
     34To add a random element to these release points, see [#random_start_position_agents random_start_position_agents].
    3235}}}
    3336|----------------
     
    5962|----------------
    6063{{{#!td style="vertical-align:top; text-align:left;width: 150px"
    61 [=#PARAMETER '''PARAMETER''']
    62 }}}
    63 {{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
    64 DATA TYPE
    65 }}}
    66 {{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
    67 DEFAULT VALUE
    68 }}}
    69 {{{#!td
    70 EXPLANATION
    71 }}}
    72 |----------------
    73 {{{#!td style="vertical-align:top; text-align:left;width: 150px"
    74 [=#PARAMETER '''PARAMETER''']
    75 }}}
    76 {{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
    77 DATA TYPE
    78 }}}
    79 {{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
    80 DEFAULT VALUE
    81 }}}
    82 {{{#!td
    83 EXPLANATION
    84 }}}
    85 |----------------
    86 {{{#!td style="vertical-align:top; text-align:left;width: 150px"
    87 [=#PARAMETER '''PARAMETER''']
    88 }}}
    89 {{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
    90 DATA TYPE
    91 }}}
    92 {{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
    93 DEFAULT VALUE
    94 }}}
    95 {{{#!td
    96 EXPLANATION
    97 }}}
    98 |----------------
    99 {{{#!td style="vertical-align:top; text-align:left;width: 150px"
    100 [=#PARAMETER '''PARAMETER''']
    101 }}}
    102 {{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
    103 DATA TYPE
    104 }}}
    105 {{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
    106 DEFAULT VALUE
    107 }}}
    108 {{{#!td
    109 EXPLANATION
    110 }}}
    111 |----------------
    112 {{{#!td style="vertical-align:top; text-align:left;width: 150px"
    113 [=#PARAMETER '''PARAMETER''']
    114 }}}
    115 {{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
    116 DATA TYPE
    117 }}}
    118 {{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
    119 DEFAULT VALUE
    120 }}}
    121 {{{#!td
    122 EXPLANATION
    123 }}}
    124 |----------------
    125 {{{#!td style="vertical-align:top; text-align:left;width: 150px"
    126 [=#PARAMETER '''PARAMETER''']
    127 }}}
    128 {{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
    129 DATA TYPE
    130 }}}
    131 {{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
    132 DEFAULT VALUE
    133 }}}
    134 {{{#!td
    135 EXPLANATION
    136 }}}
    137 |----------------
    138 {{{#!td style="vertical-align:top; text-align:left;width: 150px"
    139 [=#PARAMETER '''PARAMETER''']
    140 }}}
    141 {{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
    142 DATA TYPE
    143 }}}
    144 {{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
    145 DEFAULT VALUE
    146 }}}
    147 {{{#!td
    148 EXPLANATION
    149 }}}
    150 |----------------
    151 {{{#!td style="vertical-align:top; text-align:left;width: 150px"
    152 [=#PARAMETER '''PARAMETER''']
    153 }}}
    154 {{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
    155 DATA TYPE
    156 }}}
    157 {{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
    158 DEFAULT VALUE
    159 }}}
    160 {{{#!td
    161 EXPLANATION
    162 }}}
    163 |----------------
    164 {{{#!td style="vertical-align:top; text-align:left;width: 150px"
    165 [=#PARAMETER '''PARAMETER''']
    166 }}}
    167 {{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
    168 DATA TYPE
    169 }}}
    170 {{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
    171 DEFAULT VALUE
    172 }}}
    173 {{{#!td
    174 EXPLANATION
    175 }}}
    176 |----------------
    177 {{{#!td style="vertical-align:top; text-align:left;width: 150px"
    178 [=#PARAMETER '''PARAMETER''']
    179 }}}
    180 {{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
    181 DATA TYPE
    182 }}}
    183 {{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
    184 DEFAULT VALUE
    185 }}}
    186 {{{#!td
    187 EXPLANATION
    188 }}}
    189 |----------------
    190 {{{#!td style="vertical-align:top; text-align:left;width: 150px"
    191 [=#PARAMETER '''PARAMETER''']
    192 }}}
    193 {{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
    194 DATA TYPE
    195 }}}
    196 {{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
    197 DEFAULT VALUE
    198 }}}
    199 {{{#!td
    200 EXPLANATION
    201 }}}
    202 |----------------
    203 {{{#!td style="vertical-align:top; text-align:left;width: 150px"
    204 [=#PARAMETER '''PARAMETER''']
    205 }}}
    206 {{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
    207 DATA TYPE
    208 }}}
    209 {{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
    210 DEFAULT VALUE
    211 }}}
    212 {{{#!td
    213 EXPLANATION
    214 }}}
    215 |----------------
    216 {{{#!td style="vertical-align:top; text-align:left;width: 150px"
    217 [=#PARAMETER '''PARAMETER''']
    218 }}}
    219 {{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
    220 DATA TYPE
    221 }}}
    222 {{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
    223 DEFAULT VALUE
    224 }}}
    225 {{{#!td
    226 EXPLANATION
    227 }}}
    228 |----------------
    229 {{{#!td style="vertical-align:top; text-align:left;width: 150px"
    230 [=#PARAMETER '''PARAMETER''']
    231 }}}
    232 {{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
    233 DATA TYPE
    234 }}}
    235 {{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
    236 DEFAULT VALUE
    237 }}}
    238 {{{#!td
    239 EXPLANATION
    240 }}}
     64[=#agent_time_unlimited '''agent_time_unlimited''']
     65}}}
     66{{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
     67L
     68}}}
     69{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
     70.F.
     71}}}
     72{{{#!td
     73Flag to determine number of unlimited dimensions in NetCDF output file.\\\\
     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 * [/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"
     81DATA TYPE
     82}}}
     83{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
     84DEFAULT VALUE
     85}}}
     86{{{#!td
     87EXPLANATION
     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"
     94DATA TYPE
     95}}}
     96{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
     97DEFAULT VALUE
     98}}}
     99{{{#!td
     100EXPLANATION
     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"
     107DATA TYPE
     108}}}
     109{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
     110DEFAULT VALUE
     111}}}
     112{{{#!td
     113EXPLANATION
     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"
     120DATA TYPE
     121}}}
     122{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
     123DEFAULT VALUE
     124}}}
     125{{{#!td
     126EXPLANATION
     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"
     133DATA TYPE
     134}}}
     135{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
     136DEFAULT VALUE
     137}}}
     138{{{#!td
     139EXPLANATION
     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"
     146DATA TYPE
     147}}}
     148{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
     149DEFAULT VALUE
     150}}}
     151{{{#!td
     152EXPLANATION
     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"
     159DATA TYPE
     160}}}
     161{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
     162DEFAULT VALUE
     163}}}
     164{{{#!td
     165EXPLANATION
     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"
     172DATA TYPE
     173}}}
     174{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
     175DEFAULT VALUE
     176}}}
     177{{{#!td
     178EXPLANATION
     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"
     185DATA TYPE
     186}}}
     187{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
     188DEFAULT VALUE
     189}}}
     190{{{#!td
     191EXPLANATION
     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"
     198DATA TYPE
     199}}}
     200{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
     201DEFAULT VALUE
     202}}}
     203{{{#!td
     204EXPLANATION
     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"
     211DATA TYPE
     212}}}
     213{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
     214DEFAULT VALUE
     215}}}
     216{{{#!td
     217EXPLANATION
     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"
     224DATA TYPE
     225}}}
     226{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
     227DEFAULT VALUE
     228}}}
     229{{{#!td
     230EXPLANATION
     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"
     237DATA TYPE
     238}}}
     239{{{#!td style="vertical-align:top; text-align:left;style="width: 75px"
     240DEFAULT VALUE
     241}}}
     242{{{#!td
     243EXPLANATION
     244}}}