Changes between Version 80 and Version 81 of doc/app/maskedoutput

Timestamp:

Feb 24, 2021 3:39:53 PM (4 years ago)

Author:

wagner

Comment:

--

doc/app/maskedoutput

@@ -5 +5 @@
 From release 3.7a (r483) output of masked data is implemented in PALM. This feature allows to output quantities at different mask locations, e.g. 3d volume data or 2d cross sections of arbitrary extension within the model domain; 0d or 1d data at any positions and of any amount.\\
 NetCDF4 file format is already available for masked data output.\\
-Default quantities (instantaneous and time averaged) are declared with the parameter [../d3par#data_output_masks data_output_masks], user-defined quantities can be output with [../userpar#data_output_masks_user data_output_masks_user] (see also [[../userint/output|User-defined output quantities]]).\\\\
+Default quantities (instantaneous and time averaged) are declared with the parameter [../runtime_parameters#data_output_masks data_output_masks], user-defined quantities can be output with [../userpar#data_output_masks_user data_output_masks_user] (see also [[../userint/output|User-defined output quantities]]).\\\\
 Since r3436, terrain-following masked output is implemented. This allows to output masked quantities at a specified height above the surface.
 
 
 == Output steering ==
-Different [../d3par runtime parameters] steer the output of the quantities assigned with [../d3par#data_output_masks data_output_masks] and/or [../userpar#data_output_masks_user data_output_masks_user]:[=#list]
-\\\\
-||[../d3par#mask_x mask_x] ||all x-coordinates of mask locations (in multiples of mask scale) ||
-||[../d3par#mask_y mask_y] ||all y-coordinates of mask locations (in multiples of mask scale) ||
-||[../d3par#mask_z mask_z] ||all z-coordinates of mask locations (in multiples of mask scale) ||
-||[../d3par#mask_x_loop mask_x_loop] ||loop begin, end and stride for x-coordinates of mask locations for masks (in multiples of mask scale) ||
-||[../d3par#mask_y_loop mask_y_loop] ||loop begin, end and stride for y-coordinates of mask locations for masks (in multiples of mask scale) ||
-||[../d3par#mask_z_loop mask_z_loop] ||loop begin, end and stride for z-coordinates of mask locations for masks (in multiples of mask scale) ||
-||[../d3par#mask_k_over_surface mask_k_over_surface] ||vertical grid index above a surface to use for terrain-following masked output ||
+Different [../d3par runtime parameters] steer the output of the quantities assigned with [../runtime_parameters#data_output_masks data_output_masks] and/or [../userpar#data_output_masks_user data_output_masks_user]:[=#list]
+\\\\
+||[../runtime_parameters#mask_x mask_x] ||all x-coordinates of mask locations (in multiples of mask scale) ||
+||[../runtime_parameters#mask_y mask_y] ||all y-coordinates of mask locations (in multiples of mask scale) ||
+||[../runtime_parameters#mask_z mask_z] ||all z-coordinates of mask locations (in multiples of mask scale) ||
+||[../runtime_parameters#mask_x_loop mask_x_loop] ||loop begin, end and stride for x-coordinates of mask locations for masks (in multiples of mask scale) ||
+||[../runtime_parameters#mask_y_loop mask_y_loop] ||loop begin, end and stride for y-coordinates of mask locations for masks (in multiples of mask scale) ||
+||[../runtime_parameters#mask_z_loop mask_z_loop] ||loop begin, end and stride for z-coordinates of mask locations for masks (in multiples of mask scale) ||
+||[../runtime_parameters#mask_k_over_surface mask_k_over_surface] ||vertical grid index above a surface to use for terrain-following masked output ||
 These parameters define the masks. Each mask can be steered with a separate set of x-, y- and z-parameters. By default all gridpoints along the respective direction are used.
 \\\\
-||[../d3par#mask_scale_x mask_scale_x] ||scaling length for masked data output in x-direction ||
-||[../d3par#mask_scale_y mask_scale_y] ||scaling length for masked data output in y-direction ||
-||[../d3par#mask_scale_z mask_scale_z] ||scaling length for masked data output in z-direction ||
+||[../runtime_parameters#mask_scale_x mask_scale_x] ||scaling length for masked data output in x-direction ||
+||[../runtime_parameters#mask_scale_y mask_scale_y] ||scaling length for masked data output in y-direction ||
+||[../runtime_parameters#mask_scale_z mask_scale_z] ||scaling length for masked data output in z-direction ||
 The scaling lengths can be used to scale the parameters which defines the masks ('''mask_x''', '''mask_y''', '''mask_z''', '''mask_x_loop''', '''mask_y_loop''' or '''mask_z_loop'''). The scaling lengths apply for all masks. 
 \\\\ 
-||[../d3par#dt_domask dt_domask] ||temporal interval at which instantaneous masked data shall be output (in s) ||
-||[../d3par#skip_time_domask skip_time_domask] ||no output of masked data before this interval has passed (in s) ||
-The time intervals of the output times for each mask are determined with '''dt_domask'''. Individual time interval for output of temporally averaged data can be assigned using the parameter [../d3par#dt_data_output_av dt_data_output_av]. The length of the averaging interval is controlled with [../d3par#averaging_interval averaging_interval]. So far no particular parameters are existent for steering the time averaged output of each separate mask.
+||[../runtime_parameters#dt_domask dt_domask] ||temporal interval at which instantaneous masked data shall be output (in s) ||
+||[../runtime_parameters#skip_time_domask skip_time_domask] ||no output of masked data before this interval has passed (in s) ||
+The time intervals of the output times for each mask are determined with '''dt_domask'''. Individual time interval for output of temporally averaged data can be assigned using the parameter [../runtime_parameters#dt_data_output_av dt_data_output_av]. The length of the averaging interval is controlled with [../runtime_parameters#averaging_interval averaging_interval]. So far no particular parameters are existent for steering the time averaged output of each separate mask.
 \\\\\\
 An umlimited amount of different masks can be defined. Each mask is output to one local file:
@@ -69 +69 @@
     mask_y_loop(1,:) = 800., 1000., 50. ,/
 }}}
-If [../d3par#mask_x mask_x], [../d3par#mask_y mask_y], [../d3par#mask_z mask_z] or [../d3par#mask_x_loop mask_x_loop], [../d3par#mask_y_loop mask_y_loop], [../d3par#mask_z_loop mask_z_loop] are not assigned, all gridpoints are used along the corresponding direction.\\
-Output is done at t = [../d3par#dt_data_output dt_data_output] since [../d3par#dt_domask dt_domask] is not assigned.
+If [../runtime_parameters#mask_x mask_x], [../runtime_parameters#mask_y mask_y], [../runtime_parameters#mask_z mask_z] or [../runtime_parameters#mask_x_loop mask_x_loop], [../runtime_parameters#mask_y_loop mask_y_loop], [../runtime_parameters#mask_z_loop mask_z_loop] are not assigned, all gridpoints are used along the corresponding direction.\\
+Output is done at t = [../runtime_parameters#dt_data_output dt_data_output] since [../runtime_parameters#dt_domask dt_domask] is not assigned.
 \\\\
 === 2. Output of two different masks ===
@@ -99 +99 @@
     skip_time_domask = 3600.,3600.,/
 }}}
-Output starts after 1h simulation time (see [../d3par#skip_time_domask skip_time_domask]) for both masks and is done every 10 minutes for '''mask 1''' and every 30 minutes for '''mask 2''' (see [../d3par#dt_domask dt_domask]).
+Output starts after 1h simulation time (see [../runtime_parameters#skip_time_domask skip_time_domask]) for both masks and is done every 10 minutes for '''mask 1''' and every 30 minutes for '''mask 2''' (see [../runtime_parameters#dt_domask dt_domask]).
 \\\\
 === [=#E3]3. Output of three different masks ===
@@ -131 +131 @@
     skip_time_domask = 0.,3600.,3600.,/
 }}}
-Output starts from the beginning for '''mask 1''' and after 1h simulation time (see [../d3par#skip_time_domask skip_time_domask]) for '''mask 2''' and '''3'''. It is done every 30 minutes for '''mask 1''' and at time intervals of [../d3par#dt_data_output dt_data_output] for '''mask 2''' and '''3''' (see [../d3par#dt_domask dt_domask]).
+Output starts from the beginning for '''mask 1''' and after 1h simulation time (see [../runtime_parameters#skip_time_domask skip_time_domask]) for '''mask 2''' and '''3'''. It is done every 30 minutes for '''mask 1''' and at time intervals of [../runtime_parameters#dt_data_output dt_data_output] for '''mask 2''' and '''3''' (see [../runtime_parameters#dt_domask dt_domask]).
 \\\\
 === 4. Output of three different masks with scaling length===
@@ -164 +164 @@
     skip_time_domask = 0.,3600.,3600.,/
 }}}
-Output starts from the beginning for '''mask 1''' and after 1h simulation time (see [../d3par#skip_time_domask skip_time_domask]) for '''mask 2''' and '''3'''. It is done every 30 minutes for '''mask 1''' and at time intervals of [../d3par#dt_data_output dt_data_output] for '''mask 2''' and '''3''' (see [../d3par#dt_domask dt_domask]).\\\\
-Since [[../d3par#mask_scale_x|mask_scale_x]] and [../d3par#mask_scale_y mask_scale_y] are assigned, the parameters for steering the mask locations along x- and y-direction (here [../d3par#mask_x mask_x] and [../d3par#mask_y mask_y]) has to be given in multiples of [../d3par#mask_scale_x mask_scale_x] and [../d3par#mask_scale_y mask_scale_y].
+Output starts from the beginning for '''mask 1''' and after 1h simulation time (see [../runtime_parameters#skip_time_domask skip_time_domask]) for '''mask 2''' and '''3'''. It is done every 30 minutes for '''mask 1''' and at time intervals of [../runtime_parameters#dt_data_output dt_data_output] for '''mask 2''' and '''3''' (see [../runtime_parameters#dt_domask dt_domask]).\\\\
+Since [[../runtime_parameters#mask_scale_x|mask_scale_x]] and [../runtime_parameters#mask_scale_y mask_scale_y] are assigned, the parameters for steering the mask locations along x- and y-direction (here [../runtime_parameters#mask_x mask_x] and [../runtime_parameters#mask_y mask_y]) has to be given in multiples of [../runtime_parameters#mask_scale_x mask_scale_x] and [../runtime_parameters#mask_scale_y mask_scale_y].
 \\\\
 === 5. Output of four different masks with user-defined quantities ===
@@ -205 +205 @@
     data_output_masks_user(4,:) = 'u2',
 }}}
-Output starts from the beginning for '''mask 1''' and after 1h simulation time (see [../d3par#skip_time_domask skip_time_domask]) for '''mask 2, 3''' and '''4'''. It is done every 30 minutes for '''mask 1''' and at time intervals of [../d3par#dt_data_output dt_data_output] for '''mask 2, 3''' and '''4''' (see [../d3par#dt_domask dt_domask]).
+Output starts from the beginning for '''mask 1''' and after 1h simulation time (see [../runtime_parameters#skip_time_domask skip_time_domask]) for '''mask 2, 3''' and '''4'''. It is done every 30 minutes for '''mask 1''' and at time intervals of [../runtime_parameters#dt_data_output dt_data_output] for '''mask 2, 3''' and '''4''' (see [../runtime_parameters#dt_domask dt_domask]).
 === 6. Output of terrain-following mask ===
 '''Mask 1:''' xy cross section from x = 500m to x = 1000m and from y = 1000m to 2000m at the second, fith and tenth grid point above the surface. Output of instantaneous and time averaged data of the three wind components.\\
@@ -227 +227 @@
     skip_time_domask = 3600.,/
 }}}
-Output starts after 1h simulation time (see [../d3par#skip_time_domask skip_time_domask]) for both masks and is done every 10 minutes for '''mask 1''' and every 30 minutes for '''mask 2''' (see [../d3par#dt_domask dt_domask]).
+Output starts after 1h simulation time (see [../runtime_parameters#skip_time_domask skip_time_domask]) for both masks and is done every 10 minutes for '''mask 1''' and every 30 minutes for '''mask 2''' (see [../runtime_parameters#dt_domask dt_domask]).