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


Ignore:
Timestamp:
Sep 13, 2010 9:07:12 AM (14 years ago)
Author:
kanani
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • doc/app/initialization_parameters

    v3 v4  
    33
    44
    5 '''mode'''
    6 Standard table:\\
    7 ||='''Parameter Name'''  =||='''Type'''  =||='''Default Value'''  =||='''Explanation'''  =||
    8 |----------------
    9 {{{#!td style="vertical-align:top; text-align:left;width: 150px"
    10 [=#averaging_interval '''averaging_interval''']
    11 }}}
    12 {{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
    13 R
    14 }}}
    15 {{{#!td style="vertical-align:top; text-align:left;style="width: 100px"
    16 0.0
    17 }}}
    18 {{{#!td
    19 Averaging interval for all output of temporally averaged data (in s).\\\\
    20 This parameter defines the time interval length for temporally averaged data (vertical profiles, spectra, 2d cross-sections, 3d volume data). By default, data are not subject to temporal averaging. The interval length is limited by the parameter
    21 [[#dt_data_output_av dt_data_output_av]]. In any case, '''averaging_interval <= dt_data_output_av''' must hold.\\\\
    22 If an interval is defined, then by default the average is calculated from the data values of all timesteps lying within this interval. The number of time levels entering into the average can be reduced with the parameter [#dt_averaging_input dt_averaging_input].\\\\
    23 If an averaging interval can not be completed at the end of a run, it will be finished at the beginning of the next restart run. Thus for restart runs, averaging intervals do not necessarily begin at the beginning of the run.\\\\
    24 Parameters [#averaging_interval_pr averaging_interval_pr] and [#averaging_interval_sp averaging_interval_sp] can be used to define different averaging intervals for vertical profile data and spectra, respectively.
    25 }}}
    26 |----------------
    27 {{{#!td style="vertical-align:top"
    28 [=#<insert_parameter_name> '''<insert_parameter_name>''']
    29 }}}
    30 {{{#!td style="vertical-align:top"
    31 <insert type>
    32 }}}
    33 {{{#!td style="vertical-align:top"
    34 <insert value>
    35 }}}
    36 {{{#!td
    37 <insert explanation>
    38 }}}
    39 Table row with nesting:\\
    40 {{{#!td style="vertical-align:top"
    41 [=#<insert_parameter_name> '''<insert_parameter_name>''']
    42 }}}
    43 {{{#!td style="vertical-align:top"
    44 <insert type>
    45 }}}
    46 {{{#!td style="vertical-align:top"
    47 <insert value>
    48 }}}
    49 {{{#!td
    50 <insert explanation>
    51 ||=C1   =||=C2    =||
    52 ||Text1  ||Text2  ||
    53 <insert explanation>
    54 }}}
    55 '''grid'''
    56 
    57 '''numerics'''
    58 
    59 '''boundary conditions'''
    60 
    61 '''initialization'''
    62 
    63 '''topography'''
    64 
    65 '''canopy'''
    66 
    67 '''others'''
     5'''Mode:'''\\
     6||='''Parameter Name'''  =||='''Type'''  =||='''Default Value'''  =||='''Explanation'''  =||
     7|----------------
     8{{{#!td style="vertical-align:top; text-align:left;width: 150px"
     9[=#averaging_interval '''averaging_interval''']
     10}}}
     11{{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
     12R
     13}}}
     14{{{#!td style="vertical-align:top; text-align:left;style="width: 100px"
     150.0
     16}}}
     17{{{#!td
     18Averaging interval for all output of temporally averaged data (in s).\\\\
     19This parameter defines the time interval length for temporally averaged data (vertical profiles, spectra, 2d cross-sections, 3d volume data). By default, data are not subject to temporal averaging. The interval length is limited by the parameter
     20[[#dt_data_output_av dt_data_output_av]]. In any case, '''averaging_interval <= dt_data_output_av''' must hold.\\\\
     21If an interval is defined, then by default the average is calculated from the data values of all timesteps lying within this interval. The number of time levels entering into the average can be reduced with the parameter [#dt_averaging_input dt_averaging_input].\\\\
     22If an averaging interval can not be completed at the end of a run, it will be finished at the beginning of the next restart run. Thus for restart runs, averaging intervals do not necessarily begin at the beginning of the run.\\\\
     23Parameters [#averaging_interval_pr averaging_interval_pr] and [#averaging_interval_sp averaging_interval_sp] can be used to define different averaging intervals for vertical profile data and spectra, respectively.
     24}}}
     25|----------------
     26{{{#!td style="vertical-align:top"
     27[=#<insert_parameter_name> '''<insert_parameter_name>''']
     28}}}
     29{{{#!td style="vertical-align:top"
     30<insert type>
     31}}}
     32{{{#!td style="vertical-align:top"
     33<insert value>
     34}}}
     35{{{#!td
     36<insert explanation>
     37}}}
     38Table row with nesting:\\
     39{{{#!td style="vertical-align:top"
     40[=#<insert_parameter_name> '''<insert_parameter_name>''']
     41}}}
     42{{{#!td style="vertical-align:top"
     43<insert type>
     44}}}
     45{{{#!td style="vertical-align:top"
     46<insert value>
     47}}}
     48{{{#!td
     49<insert explanation>
     50||=C1   =||=C2    =||
     51||Text1  ||Text2  ||
     52<insert explanation>
     53}}}
     54
     55'''Grid:'''\\
     56||='''Parameter Name'''  =||='''Type'''  =||='''Default Value'''  =||='''Explanation'''  =||
     57|----------------
     58{{{#!td style="vertical-align:top; text-align:left;width: 150px"
     59[=#averaging_interval '''averaging_interval''']
     60}}}
     61{{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
     62R
     63}}}
     64{{{#!td style="vertical-align:top; text-align:left;style="width: 100px"
     650.0
     66}}}
     67{{{#!td
     68Averaging interval for all output of temporally averaged data (in s).\\\\
     69This parameter defines the time interval length for temporally averaged data (vertical profiles, spectra, 2d cross-sections, 3d volume data). By default, data are not subject to temporal averaging. The interval length is limited by the parameter
     70[[#dt_data_output_av dt_data_output_av]]. In any case, '''averaging_interval <= dt_data_output_av''' must hold.\\\\
     71If an interval is defined, then by default the average is calculated from the data values of all timesteps lying within this interval. The number of time levels entering into the average can be reduced with the parameter [#dt_averaging_input dt_averaging_input].\\\\
     72If an averaging interval can not be completed at the end of a run, it will be finished at the beginning of the next restart run. Thus for restart runs, averaging intervals do not necessarily begin at the beginning of the run.\\\\
     73Parameters [#averaging_interval_pr averaging_interval_pr] and [#averaging_interval_sp averaging_interval_sp] can be used to define different averaging intervals for vertical profile data and spectra, respectively.
     74}}}
     75|----------------
     76{{{#!td style="vertical-align:top"
     77[=#<insert_parameter_name> '''<insert_parameter_name>''']
     78}}}
     79{{{#!td style="vertical-align:top"
     80<insert type>
     81}}}
     82{{{#!td style="vertical-align:top"
     83<insert value>
     84}}}
     85{{{#!td
     86<insert explanation>
     87}}}
     88Table row with nesting:\\
     89{{{#!td style="vertical-align:top"
     90[=#<insert_parameter_name> '''<insert_parameter_name>''']
     91}}}
     92{{{#!td style="vertical-align:top"
     93<insert type>
     94}}}
     95{{{#!td style="vertical-align:top"
     96<insert value>
     97}}}
     98{{{#!td
     99<insert explanation>
     100||=C1   =||=C2    =||
     101||Text1  ||Text2  ||
     102<insert explanation>
     103}}}
     104
     105'''Numerics:'''\\
     106||='''Parameter Name'''  =||='''Type'''  =||='''Default Value'''  =||='''Explanation'''  =||
     107|----------------
     108{{{#!td style="vertical-align:top; text-align:left;width: 150px"
     109[=#averaging_interval '''averaging_interval''']
     110}}}
     111{{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
     112R
     113}}}
     114{{{#!td style="vertical-align:top; text-align:left;style="width: 100px"
     1150.0
     116}}}
     117{{{#!td
     118Averaging interval for all output of temporally averaged data (in s).\\\\
     119This parameter defines the time interval length for temporally averaged data (vertical profiles, spectra, 2d cross-sections, 3d volume data). By default, data are not subject to temporal averaging. The interval length is limited by the parameter
     120[[#dt_data_output_av dt_data_output_av]]. In any case, '''averaging_interval <= dt_data_output_av''' must hold.\\\\
     121If an interval is defined, then by default the average is calculated from the data values of all timesteps lying within this interval. The number of time levels entering into the average can be reduced with the parameter [#dt_averaging_input dt_averaging_input].\\\\
     122If an averaging interval can not be completed at the end of a run, it will be finished at the beginning of the next restart run. Thus for restart runs, averaging intervals do not necessarily begin at the beginning of the run.\\\\
     123Parameters [#averaging_interval_pr averaging_interval_pr] and [#averaging_interval_sp averaging_interval_sp] can be used to define different averaging intervals for vertical profile data and spectra, respectively.
     124}}}
     125|----------------
     126{{{#!td style="vertical-align:top"
     127[=#<insert_parameter_name> '''<insert_parameter_name>''']
     128}}}
     129{{{#!td style="vertical-align:top"
     130<insert type>
     131}}}
     132{{{#!td style="vertical-align:top"
     133<insert value>
     134}}}
     135{{{#!td
     136<insert explanation>
     137}}}
     138Table row with nesting:\\
     139{{{#!td style="vertical-align:top"
     140[=#<insert_parameter_name> '''<insert_parameter_name>''']
     141}}}
     142{{{#!td style="vertical-align:top"
     143<insert type>
     144}}}
     145{{{#!td style="vertical-align:top"
     146<insert value>
     147}}}
     148{{{#!td
     149<insert explanation>
     150||=C1   =||=C2    =||
     151||Text1  ||Text2  ||
     152<insert explanation>
     153}}}
     154
     155'''Boundary conditions:'''\\
     156||='''Parameter Name'''  =||='''Type'''  =||='''Default Value'''  =||='''Explanation'''  =||
     157|----------------
     158{{{#!td style="vertical-align:top; text-align:left;width: 150px"
     159[=#averaging_interval '''averaging_interval''']
     160}}}
     161{{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
     162R
     163}}}
     164{{{#!td style="vertical-align:top; text-align:left;style="width: 100px"
     1650.0
     166}}}
     167{{{#!td
     168Averaging interval for all output of temporally averaged data (in s).\\\\
     169This parameter defines the time interval length for temporally averaged data (vertical profiles, spectra, 2d cross-sections, 3d volume data). By default, data are not subject to temporal averaging. The interval length is limited by the parameter
     170[[#dt_data_output_av dt_data_output_av]]. In any case, '''averaging_interval <= dt_data_output_av''' must hold.\\\\
     171If an interval is defined, then by default the average is calculated from the data values of all timesteps lying within this interval. The number of time levels entering into the average can be reduced with the parameter [#dt_averaging_input dt_averaging_input].\\\\
     172If an averaging interval can not be completed at the end of a run, it will be finished at the beginning of the next restart run. Thus for restart runs, averaging intervals do not necessarily begin at the beginning of the run.\\\\
     173Parameters [#averaging_interval_pr averaging_interval_pr] and [#averaging_interval_sp averaging_interval_sp] can be used to define different averaging intervals for vertical profile data and spectra, respectively.
     174}}}
     175|----------------
     176{{{#!td style="vertical-align:top"
     177[=#<insert_parameter_name> '''<insert_parameter_name>''']
     178}}}
     179{{{#!td style="vertical-align:top"
     180<insert type>
     181}}}
     182{{{#!td style="vertical-align:top"
     183<insert value>
     184}}}
     185{{{#!td
     186<insert explanation>
     187}}}
     188Table row with nesting:\\
     189{{{#!td style="vertical-align:top"
     190[=#<insert_parameter_name> '''<insert_parameter_name>''']
     191}}}
     192{{{#!td style="vertical-align:top"
     193<insert type>
     194}}}
     195{{{#!td style="vertical-align:top"
     196<insert value>
     197}}}
     198{{{#!td
     199<insert explanation>
     200||=C1   =||=C2    =||
     201||Text1  ||Text2  ||
     202<insert explanation>
     203}}}
     204
     205'''Initialization:'''\\
     206||='''Parameter Name'''  =||='''Type'''  =||='''Default Value'''  =||='''Explanation'''  =||
     207|----------------
     208{{{#!td style="vertical-align:top; text-align:left;width: 150px"
     209[=#averaging_interval '''averaging_interval''']
     210}}}
     211{{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
     212R
     213}}}
     214{{{#!td style="vertical-align:top; text-align:left;style="width: 100px"
     2150.0
     216}}}
     217{{{#!td
     218Averaging interval for all output of temporally averaged data (in s).\\\\
     219This parameter defines the time interval length for temporally averaged data (vertical profiles, spectra, 2d cross-sections, 3d volume data). By default, data are not subject to temporal averaging. The interval length is limited by the parameter
     220[[#dt_data_output_av dt_data_output_av]]. In any case, '''averaging_interval <= dt_data_output_av''' must hold.\\\\
     221If an interval is defined, then by default the average is calculated from the data values of all timesteps lying within this interval. The number of time levels entering into the average can be reduced with the parameter [#dt_averaging_input dt_averaging_input].\\\\
     222If an averaging interval can not be completed at the end of a run, it will be finished at the beginning of the next restart run. Thus for restart runs, averaging intervals do not necessarily begin at the beginning of the run.\\\\
     223Parameters [#averaging_interval_pr averaging_interval_pr] and [#averaging_interval_sp averaging_interval_sp] can be used to define different averaging intervals for vertical profile data and spectra, respectively.
     224}}}
     225|----------------
     226{{{#!td style="vertical-align:top"
     227[=#<insert_parameter_name> '''<insert_parameter_name>''']
     228}}}
     229{{{#!td style="vertical-align:top"
     230<insert type>
     231}}}
     232{{{#!td style="vertical-align:top"
     233<insert value>
     234}}}
     235{{{#!td
     236<insert explanation>
     237}}}
     238Table row with nesting:\\
     239{{{#!td style="vertical-align:top"
     240[=#<insert_parameter_name> '''<insert_parameter_name>''']
     241}}}
     242{{{#!td style="vertical-align:top"
     243<insert type>
     244}}}
     245{{{#!td style="vertical-align:top"
     246<insert value>
     247}}}
     248{{{#!td
     249<insert explanation>
     250||=C1   =||=C2    =||
     251||Text1  ||Text2  ||
     252<insert explanation>
     253}}}
     254
     255'''Topography:'''\\
     256||='''Parameter Name'''  =||='''Type'''  =||='''Default Value'''  =||='''Explanation'''  =||
     257|----------------
     258{{{#!td style="vertical-align:top; text-align:left;width: 150px"
     259[=#averaging_interval '''averaging_interval''']
     260}}}
     261{{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
     262R
     263}}}
     264{{{#!td style="vertical-align:top; text-align:left;style="width: 100px"
     2650.0
     266}}}
     267{{{#!td
     268Averaging interval for all output of temporally averaged data (in s).\\\\
     269This parameter defines the time interval length for temporally averaged data (vertical profiles, spectra, 2d cross-sections, 3d volume data). By default, data are not subject to temporal averaging. The interval length is limited by the parameter
     270[[#dt_data_output_av dt_data_output_av]]. In any case, '''averaging_interval <= dt_data_output_av''' must hold.\\\\
     271If an interval is defined, then by default the average is calculated from the data values of all timesteps lying within this interval. The number of time levels entering into the average can be reduced with the parameter [#dt_averaging_input dt_averaging_input].\\\\
     272If an averaging interval can not be completed at the end of a run, it will be finished at the beginning of the next restart run. Thus for restart runs, averaging intervals do not necessarily begin at the beginning of the run.\\\\
     273Parameters [#averaging_interval_pr averaging_interval_pr] and [#averaging_interval_sp averaging_interval_sp] can be used to define different averaging intervals for vertical profile data and spectra, respectively.
     274}}}
     275|----------------
     276{{{#!td style="vertical-align:top"
     277[=#<insert_parameter_name> '''<insert_parameter_name>''']
     278}}}
     279{{{#!td style="vertical-align:top"
     280<insert type>
     281}}}
     282{{{#!td style="vertical-align:top"
     283<insert value>
     284}}}
     285{{{#!td
     286<insert explanation>
     287}}}
     288Table row with nesting:\\
     289{{{#!td style="vertical-align:top"
     290[=#<insert_parameter_name> '''<insert_parameter_name>''']
     291}}}
     292{{{#!td style="vertical-align:top"
     293<insert type>
     294}}}
     295{{{#!td style="vertical-align:top"
     296<insert value>
     297}}}
     298{{{#!td
     299<insert explanation>
     300||=C1   =||=C2    =||
     301||Text1  ||Text2  ||
     302<insert explanation>
     303}}}
     304
     305'''Canopy:'''\\
     306||='''Parameter Name'''  =||='''Type'''  =||='''Default Value'''  =||='''Explanation'''  =||
     307|----------------
     308{{{#!td style="vertical-align:top; text-align:left;width: 150px"
     309[=#averaging_interval '''averaging_interval''']
     310}}}
     311{{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
     312R
     313}}}
     314{{{#!td style="vertical-align:top; text-align:left;style="width: 100px"
     3150.0
     316}}}
     317{{{#!td
     318Averaging interval for all output of temporally averaged data (in s).\\\\
     319This parameter defines the time interval length for temporally averaged data (vertical profiles, spectra, 2d cross-sections, 3d volume data). By default, data are not subject to temporal averaging. The interval length is limited by the parameter
     320[[#dt_data_output_av dt_data_output_av]]. In any case, '''averaging_interval <= dt_data_output_av''' must hold.\\\\
     321If an interval is defined, then by default the average is calculated from the data values of all timesteps lying within this interval. The number of time levels entering into the average can be reduced with the parameter [#dt_averaging_input dt_averaging_input].\\\\
     322If an averaging interval can not be completed at the end of a run, it will be finished at the beginning of the next restart run. Thus for restart runs, averaging intervals do not necessarily begin at the beginning of the run.\\\\
     323Parameters [#averaging_interval_pr averaging_interval_pr] and [#averaging_interval_sp averaging_interval_sp] can be used to define different averaging intervals for vertical profile data and spectra, respectively.
     324}}}
     325|----------------
     326{{{#!td style="vertical-align:top"
     327[=#<insert_parameter_name> '''<insert_parameter_name>''']
     328}}}
     329{{{#!td style="vertical-align:top"
     330<insert type>
     331}}}
     332{{{#!td style="vertical-align:top"
     333<insert value>
     334}}}
     335{{{#!td
     336<insert explanation>
     337}}}
     338Table row with nesting:\\
     339{{{#!td style="vertical-align:top"
     340[=#<insert_parameter_name> '''<insert_parameter_name>''']
     341}}}
     342{{{#!td style="vertical-align:top"
     343<insert type>
     344}}}
     345{{{#!td style="vertical-align:top"
     346<insert value>
     347}}}
     348{{{#!td
     349<insert explanation>
     350||=C1   =||=C2    =||
     351||Text1  ||Text2  ||
     352<insert explanation>
     353}}}
     354
     355'''Others:'''\\
     356||='''Parameter Name'''  =||='''Type'''  =||='''Default Value'''  =||='''Explanation'''  =||
     357|----------------
     358{{{#!td style="vertical-align:top; text-align:left;width: 150px"
     359[=#averaging_interval '''averaging_interval''']
     360}}}
     361{{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
     362R
     363}}}
     364{{{#!td style="vertical-align:top; text-align:left;style="width: 100px"
     3650.0
     366}}}
     367{{{#!td
     368Averaging interval for all output of temporally averaged data (in s).\\\\
     369This parameter defines the time interval length for temporally averaged data (vertical profiles, spectra, 2d cross-sections, 3d volume data). By default, data are not subject to temporal averaging. The interval length is limited by the parameter
     370[[#dt_data_output_av dt_data_output_av]]. In any case, '''averaging_interval <= dt_data_output_av''' must hold.\\\\
     371If an interval is defined, then by default the average is calculated from the data values of all timesteps lying within this interval. The number of time levels entering into the average can be reduced with the parameter [#dt_averaging_input dt_averaging_input].\\\\
     372If an averaging interval can not be completed at the end of a run, it will be finished at the beginning of the next restart run. Thus for restart runs, averaging intervals do not necessarily begin at the beginning of the run.\\\\
     373Parameters [#averaging_interval_pr averaging_interval_pr] and [#averaging_interval_sp averaging_interval_sp] can be used to define different averaging intervals for vertical profile data and spectra, respectively.
     374}}}
     375|----------------
     376{{{#!td style="vertical-align:top"
     377[=#<insert_parameter_name> '''<insert_parameter_name>''']
     378}}}
     379{{{#!td style="vertical-align:top"
     380<insert type>
     381}}}
     382{{{#!td style="vertical-align:top"
     383<insert value>
     384}}}
     385{{{#!td
     386<insert explanation>
     387}}}
     388Table row with nesting:\\
     389{{{#!td style="vertical-align:top"
     390[=#<insert_parameter_name> '''<insert_parameter_name>''']
     391}}}
     392{{{#!td style="vertical-align:top"
     393<insert type>
     394}}}
     395{{{#!td style="vertical-align:top"
     396<insert value>
     397}}}
     398{{{#!td
     399<insert explanation>
     400||=C1   =||=C2    =||
     401||Text1  ||Text2  ||
     402<insert explanation>
     403}}}