Changes between Version 97 and Version 98 of doc/app/userint/output
- Timestamp:
- Feb 27, 2021 11:28:04 AM (4 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
doc/app/userint/output
v97 v98 14 14 == 1. Output of user-defined vertical profiles 15 15 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.\\ 16 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 [../../user par#data_output_pr_user data_output_pr_user], eg.:\\16 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 [../../user_parameters#data_output_pr_user data_output_pr_user], eg.:\\ 17 17 18 18 {{{ data_output_pr_user = 'u*v*' }}}, \\ … … 26 26 {{{hom(:,2,user_pr_index,:) = SPREAD(}}} [[span({{{zu}}},style=color: red)]]{{{, 2, statistic_regions+1 ) ! vertical grid }}} 27 27 28 The identification number (user_pr_index) must be within the range [ {{{pr_palm+1 , pr_palm+max_pr_user}}} ], where {{{max_pr_user}}} is the number of user-defined profiles as given by parameter [../../user par#data_output_pr_user data_output_pr_user] in the respective PALM run. The physical unit has to be given with respect to the netCDF conventions. If no unit is given, PALM will abort. The vertical grid has to be either {{{zu}}} ({{{u}}}-grid) or {{{zw}}} ({{{w}}}-grid).28 The identification number (user_pr_index) must be within the range [ {{{pr_palm+1 , pr_palm+max_pr_user}}} ], where {{{max_pr_user}}} is the number of user-defined profiles as given by parameter [../../user_parameters#data_output_pr_user data_output_pr_user] in the respective PALM run. The physical unit has to be given with respect to the netCDF conventions. If no unit is given, PALM will abort. The vertical grid has to be either {{{zu}}} ({{{u}}}-grid) or {{{zw}}} ({{{w}}}-grid). 29 29 30 30 3. The quantity has to be calculated for all grid points (subroutine user_statistics): \\\\ … … 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. 85 85 86 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 [../../user par#data_output_user data_output_user], eg.: \\86 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 [../../user_parameters#data_output_user data_output_user], eg.: \\ 87 87 88 88 {{{ data_output_user = 'u2', 'u2_xy_av' }}} … … 90 90 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]).\\ 91 91 92 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 [../../user par#data_output_masks_user data_output_masks_user], eg.: \\92 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 [../../user_parameters#data_output_masks_user data_output_masks_user], eg.: \\ 93 93 94 94 {{{ data_output_masks_user(1,:) = 'u2', }}} … … 319 319 C. 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 package parameter [../../spectra_parameters#data_output_sp data_output_sp]). To switch on output of this quantity, the user has to assign the string identifier to the package parameter [../../spectra_parameters#data_output_sp data_output_sp], eg.: 320 320 {{{ data_output_sp = 'u*v*' }}} 321 Item A. and item B. as prerequisites for C. require a naming convention of identical identifiers, e.g. [../../user par#data_output_pr_user data_output_pr_user]='' 'u*v*','' [../../userpar#data_output_user data_output_user] ='' 'u*v*' ''and [../../spectra_parameters#data_output_sp data_output_sp]='' 'u*v*'.'' This naming convention applies only in case of user-defined spectra.321 Item A. and item B. as prerequisites for C. require a naming convention of identical identifiers, e.g. [../../user_parameters#data_output_pr_user data_output_pr_user]='' 'u*v*','' [../../user_parameters#data_output_user data_output_user] ='' 'u*v*' ''and [../../spectra_parameters#data_output_sp data_output_sp]='' 'u*v*'.'' This naming convention applies only in case of user-defined spectra. 322 322 323 323 2. Edit the subroutine as follows:
