Changes between Version 237 and Version 238 of doc/app/runtime_parameters

Timestamp:

Nov 28, 2013 7:41:15 AM (12 years ago)

Author:

maronga

Comment:

--

doc/app/runtime_parameters

@@ -198 +198 @@
 ||w ||w-component of the velocity ||m/s || ||
 '''Example:'''
-  '''data_output_masks (1,:)''' = '' 'u', 'v', 'u_av', 'v_av', ''\\
-  '''data_output_masks (2,:)''' = '' 'w', 'w_av', ''\\
-  '''data_output_masks (3,:)''' = '' 'pt', 'u', 'v', 'w', ''\\\\
+  '''data_output_masks(1,:)''' = '' 'u', 'v', 'u_av', 'v_av', ''\\
+  '''data_output_masks(2,:)''' = '' 'w', 'w_av', ''\\
+  '''data_output_masks(3,:)''' = '' 'pt', 'u', 'v', 'w', ''\\\\
   This example will create the following output:\\
   '''Mask 1''': Instantaneous data of u- and v-velocity component (by default on file [[../iofiles#DATA_MASK_01_NETCDF|DATA_MASK_01_NETCDF]]) and temporally averaged 
@@ -708 +708 @@
 This 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.\\\\
 '''Example:'''
-   '''mask_x (1,:)''' = ''50., 100., 500., 550., 600.''\\
-   '''mask_x (2,:)''' = ''1000.''\\\\
+   '''mask_x(1,:)''' = ''50., 100., 500., 550., 600.''\\
+   '''mask_x(2,:)''' = ''1000.''\\\\
    This example will create outputs at the specified points (at xu-grid in m, if [#mask_scale_x mask_scale_x] is not used; outputs on 
    the x-grid are shifted by half of the grid spacing forward (e.g. x = ''75.0, 125.0, 525.0, 575.0, 625.0,'' if [[../inipar#dx|dx]]=
    ''50.0'')).
-If 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.'').\\\\
+If 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.'').\\\\
 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].\\\\
@@ -733 +733 @@
 This 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.\\\\
 '''Example:'''
-   '''mask_y (1,:)''' = ''50., 100., 500., 550., 600.''\\
-   '''mask_y (2,:)''' = ''1000.''\\\\
+   '''mask_y(1,:)''' = ''50., 100., 500., 550., 600.''\\
+   '''mask_y(2,:)''' = ''1000.''\\\\
    This example will create outputs at the specified points (at yv-grid in m, if [#mask_scale_x mask_scale_x] is not used; outputs on 
    the y-grid are shifted by half of the grid spacing forward (e.g. y = ''75.0, 125.0, 525.0, 575.0, 625.0,'' if [[../inipar#dy|dy]]=
    ''50.0'')).
-If 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.'').\\\\
+If 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.'').\\\\
 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].\\\\
@@ -758 +758 @@
 This 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.\\\\
 '''Example:'''
-   '''mask_z (1,:)''' = ''50., 100., 500., 550., 600.''\\
-   '''mask_z (2,:)''' = ''1000.''\\\\
+   '''mask_z(1,:)''' = ''50., 100., 500., 550., 600.''\\
+   '''mask_z(2,:)''' = ''1000.''\\\\
    This example will create outputs at the specified points (at zw-grid in m, if [#mask_scale_x mask_scale_x] is not used; outputs on 
    the zu-grid are shifted by half of the grid spacing downward (e.g. zu = ''25.0, 75.0, 475.0, 525.0, 575.0'', if [[../inipar#dz|dz]]= ''50.0'')).
-If 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.'').\\\\
+If 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.'').\\\\
 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].\\\\
@@ -781 +781 @@
 Loop begin, end and stride for x-coordinates of mask locations for masks (in multiples of [#mask_scale_x mask_scale_x]).\\\\
 This parameter should be used, if masked data are to be output at periodic positions. 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.''\\ 
+'''mask_x_loop(1,:)''' = ''0.0,2000.,100.''\\ 
 This example will create outputs every 100m along x-direction (at xu-grid in m, if [#mask_scale_x mask_scale_x] is not used; outputs on the x-grid are shifted by half of the grid spacing forward).\\\\
 For each mask a separate '''mask_x_loop''' has to be assigned.\\\\
@@ -801 +801 @@
 Loop begin, end and stride for y-coordinates of mask locations for masks (in multiples of [#mask_scale_y mask_scale_y]).\\\\
 This parameter should be used, if masked data are to be output at periodic positions (e.g. every 100m along y-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_y_loop (1,:)''' = ''0.0,2000.,100.''\\ 
+'''mask_y_loop(1,:)''' = ''0.0,2000.,100.''\\ 
 This example will create outputs every 100m along y-direction (at yv-grid in m, if [#mask_scale_x mask_scale_x] is not used; outputs on the y-grid are shifted by half of the grid spacing forward).\\\\
 For each mask a separate '''mask_y_loop''' has to be assigned.\\\\
@@ -821 +821 @@
 Loop begin, end and stride for z-coordinates of mask locations for masks (in multiples of [#mask_scale_z mask_scale_z]).\\\\
 This parameter should be used, if masked data are to be output at periodic positions (e.g. every 100m along z-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_z_loop (1,:)''' = ''0.0,2000.,100.''\\ 
+'''mask_z_loop(1,:)''' = ''0.0,2000.,100.''\\ 
 This example will create outputs every 100m along z-direction (at zw-grid in m, if [#mask_scale_x mask_scale_x] is not used; outputs on the zu-grid are shifted by half of the grid spacing downward).\\\\
 For each mask a separate '''mask_z_loop''' has to be assigned.\\\\