| 4 | | A very typical request of users is the calculation and output of quantities which are not part of {{{PALM}}}'s standard output. The basic user interface includes a number of subroutines which allow the calculation of user-defined quantities and output of these quantities as 1. (horizontally averaged) [#part_1 vertical profiles], 2. [#part_2 time series], 3. [#part_3 2d cross section], [#part_3 3d volume data] or [#part_3 mask data], 4. [#part_4 dvrp objects], 5. [#part_5 spectra] and 6. [#part_6 virtual flights]. The respective subroutines contain sample code lines (written as comment lines) for defining, calculating and output of such quantities.\\\\ |
| 5 | | 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].\\\\ |
| 6 | | The following parts of this chapter explains step-by-step how to modify/extend the respective default user interface subroutines in order to generate the respective output:\\ |
| 7 | | 1. (horizontally averaged) [#part_1 vertical profiles] |
| 8 | | 2. [#part_2 time series] |
| 9 | | 3. [#part_3 2d cross section], [#part_3 3d volume data] or [#part_3 masked data] |
| 10 | | 4. [#part_4 dvrp objects] |
| 11 | | 5. [#part_5 spectra] |
| 12 | | 6. [#part_6 virtual flights]\\\\ |
| | 4 | A very typical request of users is the calculation and output of quantities which are not part of PALM's standard output. The basic user interface includes a number of subroutines which allow the calculation of user-defined quantities and output of these quantities as:\\ |
| | 5 | 1. [#a1.Outputofuser-definedverticalprofiles (horizontally averaged) vertical profiles] |
| | 6 | 2. [#a2.Outputofuser-definedtimeseries time series] |
| | 7 | 3. [#a3.Outputofuser-defined2dcrosssections3dvolumedataormaskeddata 2d cross section, 3d volume data or masked data] |
| | 8 | 4. [#a4.Outputofuser-definedDVRPobjects dvrp objects] |
| | 9 | 5. [#a5.Outputofuser-definedspectra spectra] |
| | 10 | 6. [#a6.Outputofuser-definedflightmeasurements virtual flights]\\ |
| | 11 | |
| | 12 | This is explaines step-by-step in the following. 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].\\\\ |
| 17 | | 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.:\\ |
| | 17 | 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.:\\ |
| 67 | | 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. |
| 68 | | |
| 69 | | 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.: \\ |
| | 67 | 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. |
| | 68 | |
| | 69 | 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.: \\ |
