Changes between Version 184 and Version 185 of doc/app/runtime_parameters


Ignore:
Timestamp:
Sep 16, 2010 5:16:04 PM (15 years ago)
Author:
weinreis
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • doc/app/runtime_parameters

    v184 v185  
    610610}}}
    611611{{{#!td
    612 Scaling length for masked data output in x-direction.\\\\
    613 This parameter defines the length which scales the positions of the masked data in x-direction.\\\\
     612Scaling length for masked data output along x-direction.\\\\
     613This parameter defines the length which scales the positions of the masked data along x-direction.\\\\
    614614'''Example:'''
    615    '''mask_scale_x''' = ''10.'' will scale the positions (e.g. 0.m, 500.m, 1000.m) for masked output in x-direction by ''10.0'' (-> 0., 50., 100.).
    616 For scaling the masked data in y-direction use [#mask_scale_y mask_scale_y]. For scaling the masked data in z-direction use [#mask_scale_z mask_scale_z].
     615   '''mask_scale_x''' = ''10.'' will scale the positions (e.g. 0.m, 500.m, 1000.m) for masked output along x-direction by ''10.0'' (-> 0., 50., 100.).
     616For scaling the masked data along y-direction use [#mask_scale_y mask_scale_y]. For scaling the masked data along z-direction use [#mask_scale_z mask_scale_z].
    617617}}}
    618618|----------------
     
    627627}}}
    628628{{{#!td
    629 Scaling length for masked data output in y-direction.\\\\
    630 This parameter defines the length which scales the positions of the masked data in y-direction.\\\\
     629Scaling length for masked data output along y-direction.\\\\
     630This parameter defines the length which scales the positions of the masked data along y-direction.\\\\
    631631'''Example:'''
    632    '''mask_scale_y''' = ''10.'' will scale the positions (e.g. 0.m, 500.m, 1000.m) for masked output in y-direction by ''10.0'' (-> 0., 50., 100.).
    633 For scaling the masked data in x-direction use [#mask_scale_x mask_scale_x]. For scaling the masked data in z-direction use [#mask_scale_z mask_scale_z].
     632   '''mask_scale_y''' = ''10.'' will scale the positions (e.g. 0.m, 500.m, 1000.m) for masked output along y-direction by ''10.0'' (-> 0., 50., 100.).
     633For scaling the masked data along x-direction use [#mask_scale_x mask_scale_x]. For scaling the masked data along z-direction use [#mask_scale_z mask_scale_z].
    634634}}}
    635635|----------------
     
    644644}}}
    645645{{{#!td
    646 Scaling length for masked data output in z-direction.\\\\
    647 This parameter defines the length which scales the positions of the masked data in z-direction.\\\\
     646Scaling length for masked data output along z-direction.\\\\
     647This parameter defines the length which scales the positions of the masked data along z-direction.\\\\
    648648'''Example:'''
    649    '''mask_scale_z''' = ''10.'' will scale the positions (e.g. 0.m, 500.m, 1000.m) for masked output in z-direction by ''10.0'' (-> 0., 50., 100.).
    650 For scaling the masked data in x-direction use [#mask_scale_x mask_scale_x]. For scaling the masked data in y-direction use [#mask_scale_y mask_scale_y].
     649   '''mask_scale_z''' = ''10.'' will scale the positions (e.g. 0.m, 500.m, 1000.m) for masked output along z-direction by ''10.0'' (-> 0., 50., 100.).
     650For scaling the masked data along x-direction use [#mask_scale_x mask_scale_x]. For scaling the masked data along y-direction use [#mask_scale_y mask_scale_y].
    651651}}}
    652652|----------------
     
    662662{{{#!td
    663663All x-coordinates of mask positions (in multiples of [#mask_scale_x mask_scale_x]).\\\\
    664 This parameter defines all positions in x-direction where quantities for masked data are to be output (see [#data_output_mask data_output_mask]). For each mask a separate '''mask_x''' has to be assigned.\\\\
     664This parameter defines all positions along x-direction where quantities for masked data are to be output (see [#data_output_mask data_output_mask]). For each mask a separate '''mask_x''' has to be assigned.\\\\
    665665'''Example:'''
    666666   '''mask_x (1,:)''' = ''0., 50., 100., 500., 550., 600.''\\
    667667   '''mask_x (2,:)''' = ''1000.''\\\\
    668668   This example will create outputs at the specified points (in m, if [#mask_scale_x mask_scale_x] is not used) of the model domain.
    669 If you use [#mask_scale_x mask_scale_x] '''mask_x''' has to be assigned in "grid point position in x-direction [m]/'''mask_scale_x''' " (e.g. '''mask_scale_x''' = ''10.0'' -> '''mask_x (1,:)''' = ''0., 5., 10., 50., 55., 60.'').\\\\
     669If you use [#mask_scale_x mask_scale_x] '''mask_x''' has to be assigned in "grid point position along x-direction [m]/'''mask_scale_x''' " (e.g. '''mask_scale_x''' = ''10.0'' -> '''mask_x (1,:)''' = ''0., 5., 10., 50., 55., 60.'').\\\\
    670670The default results in output at every grid point along the x-direction, i.e. from 0 to nx.\\\\
    671671If you want to output quantities at positions with constant spaces (e.g. every 100m), use the parameter [#mask_x_loop mask_x_loop].\\\\
     
    685685{{{#!td
    686686All y-coordinates of mask positions (in multiples of [#mask_scale_y mask_scale_y]).\\\\
    687 This parameter defines all positions in y-direction where quantities for masked data are to be output (see [#data_output_mask data_output_mask]). For each mask a separate '''mask_y''' has to be assigned.\\\\
     687This parameter defines all positions along y-direction where quantities for masked data are to be output (see [#data_output_mask data_output_mask]). For each mask a separate '''mask_y''' has to be assigned.\\\\
    688688'''Example:'''
    689689   '''mask_y (1,:)''' = ''0., 50., 100., 500., 550., 600.''\\
    690690   '''mask_y (2,:)''' = ''1000.''\\\\
    691691   This example will create outputs at the specified points (in m, if [#mask_scale_y mask_scale_y] is not used) of the model domain.
    692 If you use [#mask_scale_y mask_scale_y] '''mask_y''' has to be assigned in "grid point position in y-direction [m]/'''mask_scale_y''' " (e.g. '''mask_scale_y''' = ''10.0'' -> '''mask_y (1,:)''' = ''0., 5., 10., 50., 55., 60.'').\\\\
     692If you use [#mask_scale_y mask_scale_y] '''mask_y''' has to be assigned in "grid point position along y-direction [m]/'''mask_scale_y''' " (e.g. '''mask_scale_y''' = ''10.0'' -> '''mask_y (1,:)''' = ''0., 5., 10., 50., 55., 60.'').\\\\
    693693The default results in output at every grid point along the y-direction, i.e. from 0 to ny.\\\\
    694694If you want to output quantities at positions with constant spaces (e.g. every 100m), use the parameter [#mask_y_loop mask_y_loop].\\\\
     
    708708{{{#!td
    709709All z-coordinates of mask positions (in multiples of [#mask_scale_z mask_scale_z]).\\\\
    710 This parameter defines all positions in z-direction where quantities for masked data are to be output (see [#data_output_mask data_output_mask]). For each mask a separate '''mask_z''' has to be assigned.\\\\
     710This parameter defines all positions along z-direction where quantities for masked data are to be output (see [#data_output_mask data_output_mask]). For each mask a separate '''mask_z''' has to be assigned.\\\\
    711711'''Example:'''
    712712   '''mask_z (1,:)''' = ''0., 50., 100., 500., 550., 600.''\\
    713713   '''mask_z (2,:)''' = ''1000.''\\\\
    714714   This example will create outputs at the specified points (in m, if [#mask_scale_z mask_scale_z] is not used) of the model domain.
    715 If you use [#mask_scale_z mask_scale_z] '''mask_z''' has to be assigned in "grid point position in z-direction [m]/'''mask_scale_z''' " (e.g. '''mask_scale_z''' = ''10.0'' -> '''mask_z (1,:)''' = ''0., 5., 10., 50., 55., 60.'').\\\\
     715If you use [#mask_scale_z mask_scale_z] '''mask_z''' has to be assigned in "grid point position along z-direction [m]/'''mask_scale_z''' " (e.g. '''mask_scale_z''' = ''10.0'' -> '''mask_z (1,:)''' = ''0., 5., 10., 50., 55., 60.'').\\\\
    716716The default results in output at every grid point along the z-direction, i.e. from 0 to nz.\\\\
    717717If you want to output quantities at positions with constant spaces (e.g. every 100m), use the parameter [#mask_z_loop mask_z_loop].\\\\
     
    731731{{{#!td
    732732Loop begin, end and stride for x-coordinates of mask locations for masks (in multiples of [#mask_scale_x mask_scale_x]).\\\\
    733 This parameter can be used, if mask
    734 The default results in output at every grid point along the x-direction, i.e. from 0 to nx.
     733This parameter should be used, if masked data are to be output at periodic positions (e.g. every 100m along x-direction). The first parameter assigns the start position (e.g. 0m), the second one the end position (e.g. 2000m) and the third one the stride (e.g. 100m) -> '''mask_x_loop (1,:)''' = ''0.0,2000.,100.''.\\\\
     734For each mask a separate '''mask_x_loop''' has to be assigned.\\\\
     735The default results in output at every grid point along the x-direction, i.e. from 0 to nx.\\\\
    735736'''Note:''' If mask_x is also specified, mask_x_loop will be ignored.\\\\
    736737Further examples are given in [../maskedoutput#Examples Masked data output].