Changes between Version 171 and Version 172 of doc/app/runtime_parameters

Timestamp:

Sep 16, 2010 2:05:34 PM (15 years ago)

Author:

weinreis

Comment:

--

doc/app/runtime_parameters

@@ -656 +656 @@
 }}}
 {{{#!td
-All x-coordinates of mask positions (in m).\\\\
+All x-coordinates of mask positions (in multiples of [#mask_scale_x mask_scale_x]).\\\\
 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.\\\\
 '''Example:'''
    '''mask_x''' (1,:) = ''0., 50., 100., 500., 550., 600.''\\
    '''mask_x''' (2,:) = ''1000.''\\\\
-   This example will create outputs at the specified points (in m) of the model domain.
-If you use [#mask_scale_x mask_scale_x] '''mask_x''' has to be assigned in position[m]/'''mask_scale_x''' (e.g. '''mask_scale_x''' = ''10.0'' -> '''mask_x (1,:)''' = ''0., 5., 10., 50., 55., 60.'').\\\\
-By default all grid points in x-direction are taken for output.\\\\
+   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.
+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.'').\\\\
+The default results in output at every grid point along the x-direction, i.e. from 0 to nx.\\\\
 If you want to output quantities at positions with constant spaces (e.g. every 100m), use the parameter [#mask_x_loop mask_x_loop].\\\\
-Locations for y-direction can be assigned with the parameters [#mask_y mask_y] or [#mask_y_loop mask_y_loop]. Locations for z-direction can be assigned with the parameters [#mask_z mask_z] or [#mask_z_loop mask_z_loop].
+Locations for y-direction can be assigned with the parameters [#mask_y mask_y] or [#mask_y_loop mask_y_loop]. Locations for z-direction can be assigned with the parameters [#mask_z mask_z] or [#mask_z_loop mask_z_loop].\\\\
+Further examples are given [../maskedoutput#Examples here].
 }}}
 |----------------
@@ -678 +679 @@
 }}}
 {{{#!td
-All y-coordinates of mask positions (in m).\\\\
+All y-coordinates of mask positions (in multiples of [#mask_scale_y mask_scale_y]).\\\\
 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.\\\\
 '''Example:'''
@@ -685 +686 @@
    This example will create outputs at the specified points (in m) of the model domain.
 If you use [#mask_scale_y mask_scale_y] '''mask_y''' has to be assigned in position[m]/'''mask_scale_y''' (e.g. '''mask_scale_y''' = ''10.0'' -> '''mask_y (1,:)''' = ''0., 5., 10., 50., 55., 60.'').\\\\
-By default all grid points in y-direction are taken for output.\\\\
+The default results in output at every grid point along the y-direction, i.e. from 0 to ny.\\\\
 If you want to output quantities at positions with constant spaces (e.g. every 100m), use the parameter [#mask_y_loop mask_y_loop].\\\\
 Locations for x-direction can be assigned with the parameters [#mask_x mask_x] or [#mask_x_loop mask_x_loop]. Locations for z-direction can be assigned with the parameters [#mask_z mask_z] or [#mask_z_loop mask_z_loop].
@@ -700 +701 @@
 }}}
 {{{#!td
-All z-coordinates of mask positions (in m).\\\\
+All z-coordinates of mask positions (in multiples of [#mask_scale_z mask_scale_z]).\\\\
 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.\\\\
 '''Example:'''
@@ -707 +708 @@
    This example will create outputs at the specified points (in m) of the model domain.
 If you use [#mask_scale_z mask_scale_z] '''mask_z''' has to be assigned in position[m]/'''mask_scale_z''' (e.g. '''mask_scale_z''' = ''10.0'' -> '''mask_z (1,:)''' = ''0., 5., 10., 50., 55., 60.'').\\\\
-By default all grid points in z-direction are taken for output.\\\\
+The default results in output at every grid point along the z-direction, i.e. from 0 to nz.\\\\
 If you want to output quantities at positions with constant spaces (e.g. every 100m), use the parameter [#mask_z_loop mask_z_loop].\\\\
 Locations for x-direction can be assigned with the parameters [#mask_x mask_x] or [#mask_x_loop mask_x_loop]. Locations for y-direction can be assigned with the parameters [#mask_y mask_y] or [#mask_y_loop mask_y_loop].
@@ -722 +723 @@
 }}}
 {{{#!td
-loop begin, end and stride for x-coordinates of
-mask locations for masks (in multiples of mask scale).
-The default results in output at every grid point along
-the respective dimension, i.e. from 0 to nx.
-Note: if mask_x is also specified,
-mask_x_loop will be ignored!
+Loop begin, end and stride for x-coordinates of mask locations for masks (in multiples of [#mask_scale_x mask_scale_x]).\\\\
+The default results in output at every grid point along the x-direction, i.e. from 0 to nx.
+'''Note:''' If mask_x is also specified, mask_x_loop will be ignored!
 }}}
 |----------------