Changes between Version 95 and Version 96 of doc/app/userint/output

Timestamp:

Feb 24, 2021 3:34:16 PM (4 years ago)

Author:

wagner

Comment:

--

doc/app/userint/output

@@ -9 +9 @@
    5. [#a6.Outputofuser-definedflightmeasurements virtual flights]\\
 
-In the following, the generation of such output quantities is explained step by step. Furthermore, the respective subroutines already contain sample code lines (written as comment lines) for defining, calculating and output of such quantities. Output times, averaging intervals, etc. are steered by the same variables as used for the standard PALM output quantities, e.g. [../../d3par#dt_data_output dt_data_output].\\\\
+In the following, the generation of such output quantities is explained step by step. Furthermore, the respective subroutines already contain sample code lines (written as comment lines) for defining, calculating and output of such quantities. Output times, averaging intervals, etc. are steered by the same variables as used for the standard PALM output quantities, e.g. [../../runtime_parameters#dt_data_output dt_data_output].\\\\
 
 
 == 1. Output of user-defined vertical profiles
 This example shows the output of the quantity "turbulent resolved-scale horizontal momentum flux" (''u*v*''). If more than one user-defined quantity shall be output, the following steps have to be carried out in the same way for each of the quantities.\\
-   1. The quantity has to be given a unique string identifier, e.g.'' 'u*v*'.'' This identifier must be different from the identifiers used for the PALM standard output (see list in description of parameter [../../d3par#data_output_pr data_output_pr]). The identifier must not contain more than '''20''' characters. In case that 2d cross section output is defined on one single level only (see chapter 3, paragraph 9, further below), the identifier string must contain an asterisk ({{{"*"}}}). To switch on output of the quantity, the user has to assign the string identifier to the parameter [../../userpar#data_output_pr_user data_output_pr_user], eg.:\\
+   1. The quantity has to be given a unique string identifier, e.g.'' 'u*v*'.'' This identifier must be different from the identifiers used for the PALM standard output (see list in description of parameter [../../runtime_parameters#data_output_pr data_output_pr]). The identifier must not contain more than '''20''' characters. In case that 2d cross section output is defined on one single level only (see chapter 3, paragraph 9, further below), the identifier string must contain an asterisk ({{{"*"}}}). To switch on output of the quantity, the user has to assign the string identifier to the parameter [../../userpar#data_output_pr_user data_output_pr_user], eg.:\\
 
    {{{ data_output_pr_user = 'u*v*' }}}, \\
@@ -84 +84 @@
 This example shows the output of the quantity "square of the u-component" ('''Note:''' this quantity could of course easily be calculated from the u-component by postprocessing the PALM output so that calculation within PALM is not necessarily required). If more than one user-defined quantity shall be output, the following steps have to be carried out in the same way for each of the quantities.
 
-   1. For output of '''2d cross sections''' and '''3d volume data''', the quantity has to be given a unique string identifier, e.g.'' 'u2'.'' This identifier must be different from the identifiers used for the PALM standard output (see list in description of parameter [../../d3par#data_output data_output]). The identifier must not contain more than '''20''' characters. To switch on output of this quantity, the user has to assign the string identifier to the parameter [../../userpar#data_output_user data_output_user], eg.: \\
+   1. For output of '''2d cross sections''' and '''3d volume data''', the quantity has to be given a unique string identifier, e.g.'' 'u2'.'' This identifier must be different from the identifiers used for the PALM standard output (see list in description of parameter [../../runtime_parameters#data_output data_output]). The identifier must not contain more than '''20''' characters. To switch on output of this quantity, the user has to assign the string identifier to the parameter [../../userpar#data_output_user data_output_user], eg.: \\
 
    {{{ data_output_user = 'u2',  'u2_xy_av' }}} 
 
-   The pure string'' 'u2' ''switches on the output of instantaneous 3d volume data. Output of cross section data and time averaged data is switched on by additionally appending the strings'' '_xy', '_xz', '_yz', ''and/or'' '_av' ''(for a detailed explanation see parameter [../../d3par#data_output data_output]).\\
-
-   2. For output of '''masked data''', the quantity has to be given a unique string identifier, e.g.'' 'u2'.'' This identifier must be different from the identifiers used for the PALM standard output (see list in description of parameter [../../d3par#data_output_masks data_output_masks]). To switch on output of this quantity, the user has to assign the string identifier to the parameter [../../userpar#data_output_masks_user data_output_masks_user], eg.: \\
+   The pure string'' 'u2' ''switches on the output of instantaneous 3d volume data. Output of cross section data and time averaged data is switched on by additionally appending the strings'' '_xy', '_xz', '_yz', ''and/or'' '_av' ''(for a detailed explanation see parameter [../../runtime_parameters#data_output data_output]).\\
+
+   2. For output of '''masked data''', the quantity has to be given a unique string identifier, e.g.'' 'u2'.'' This identifier must be different from the identifiers used for the PALM standard output (see list in description of parameter [../../runtime_parameters#data_output_masks data_output_masks]). To switch on output of this quantity, the user has to assign the string identifier to the parameter [../../userpar#data_output_masks_user data_output_masks_user], eg.: \\
 
    {{{ data_output_masks_user(1,:) = 'u2', }}}