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

Timestamp:

Sep 16, 2010 10:10:28 AM (15 years ago)

Author:

weinreis

Comment:

--

doc/app/runtime_parameters

@@ -139 +139 @@
 {{{#!td
 Quantities for which masked data are to be output.\\\\
-Up to 20 different masks can be defined (see [[../maskedoutput|Masked data output]]). For each mask (up to 100) different instantaneous or temporally averaged quantities can be output. The masks are steered with the parameters [#mask_x mask_x], [#mask_y mask_y], [#mask_z mask_z], [#mask_x_loop mask_x_loop], [#mask_y_loop mask_y_loop] and [#mask_z_loop mask_z_loop]. It is possible to scale the masked data with a specified factor for each direction (see [#mask_scale_x mask_scale_x], [#mask_scale_y mask_scale_y] and [#mask_scale_z mask_scale_z]).\\\\
+Up to 20 different masks can be defined (see [[../maskedoutput|Masked data output]]). For each mask (up to 100) different instantaneous or temporally averaged quantities can be output. The masks are steered with the parameters [#mask_x mask_x], [#mask_y mask_y], [#mask_z mask_z], [#mask_x_loop mask_x_loop], [#mask_y_loop mask_y_loop] and [#mask_z_loop mask_z_loop]. It is possible to scale the masked data with a specified length for each direction (see [#mask_scale_x mask_scale_x], [#mask_scale_y mask_scale_y] and [#mask_scale_z mask_scale_z]).\\\\
 By default, masked data are output to local files [[../iofiles#DATA_MASK_01_NETCDF|DATA_MASK_01_NETCDF]], [[../iofiles#DATA_MASK_02_NETCDF|DATA_MASK_02_NETCDF]], ... and [[../iofiles#DATA_MASK_20_NETCDF|DATA_MASK_20_NETCDF]]. If the user has switched on the output of temporally averaged data, these are written seperately to local files [[../iofiles#DATA_MASK_01_AV_NETCDF|DATA_MASK_01_AV_NETCDF]], [[../iofiles#DATA_MASK_02_AV_NETCDF|DATA_MASK_02_AV_NETCDF]], ... and [[../iofiles#DATA_MASK_20_AV_NETCDF|DATA_MASK_20_AV_NETCDF]]. The file's format is netCDF. Further details about processing netCDF data are given in chapter [[4.5.1]].\\\\
 The following quantities are available for output by default:\\\\
@@ -608 +608 @@
 This parameter defines the length which scales the positions of the masked data in x-direction.\\\\
 '''Example:'''
-   '''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.)
+   '''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.).
 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].
 }}}
@@ -622 +622 @@
 }}}
 {{{#!td
-scaling length for masked data output in y-direction
+Scaling length for masked data output in y-direction.\\\\
+This parameter defines the length which scales the positions of the masked data in y-direction.\\\\
+'''Example:'''
+   '''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.).
+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].
 }}}
 |----------------
@@ -635 +639 @@
 }}}
 {{{#!td
-scaling length for masked data output in z-direction
+Scaling length for masked data output in z-direction.\\\\
+This parameter defines the length which scales the positions of the masked data in z-direction.\\\\
+'''Example:'''
+   '''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.).
+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].
 }}}
 |----------------