Changes between Version 60 and Version 61 of doc/app/userint/int

Timestamp:

Feb 27, 2021 11:40:48 AM (4 years ago)

Author:

wagner

Comment:

--

doc/app/userint/int

@@ -183 +183 @@
 Horizontal averages of vertical profiles of user-defined quantities can be computed here. Also, additional time series quantities can be calculated. They have to be defined before in routine [#user_init user_init]. The routine is called once for each defined  statistic_region (see [../../initialization_parameters#statistic_regions statistic_regions]).\\
 The routine contains some simple examples (as comment lines) in order to demonstrate how to use it.\\\\
-Profile sums have to be stored in the array {{{sums_l}}}. The profile identification number (second index of array {{{sums_l}}}) must be within the range [ {{{pr_palm+1}}} , {{{pr_palm+max_pr_user}}} ], where {{{pr_palm}}} is an internal parameter and  {{{max_pr_user}}} is the number of user-defined profiles as given by parameter [../../userpar#data_output_pr_user data_output_pr_user] in the respective {{{PALM}}} run. \\
+Profile sums have to be stored in the array {{{sums_l}}}. The profile identification number (second index of array {{{sums_l}}}) must be within the range [ {{{pr_palm+1}}} , {{{pr_palm+max_pr_user}}} ], where {{{pr_palm}}} is an internal parameter and  {{{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. \\
 These additional profiles are further processed (e.g. temporally averaged), like the standard profiles, in {{{flow_statistics}}}.
 }}}
@@ -204 +204 @@
 }}}
 {{{#!td
-Here the physical {{{unit}}}(s) of user-defined 2d/3d output quantities (see [../../userpar#data_output_user data_output_user]) have to be set. Input parameter {{{variable}}} contains the string identifier of the respective variable. For those variables not recognized by the user, the parameter {{{unit}}} is set to ''illegal'', which tells the calling routine that the output variable is not defined and leads to a program abort.\\
+Here the physical {{{unit}}}(s) of user-defined 2d/3d output quantities (see [../../user_parameters#data_output_user data_output_user]) have to be set. Input parameter {{{variable}}} contains the string identifier of the respective variable. For those variables not recognized by the user, the parameter {{{unit}}} is set to ''illegal'', which tells the calling routine that the output variable is not defined and leads to a program abort.\\
 See [[../output|User-defined output quantities]] about creating user-defined output quantities.
 }}}
@@ -215 +215 @@
 }}}
 {{{#!td
-Here the physical {{{unit}}}(s) and vertical grid (u- or w-grid) of user-defined vertical profile output quantities (see [../../userpar#data_output_pr_user data_output_pr_user]) have to be set. Input parameter {{{variable}}} contains the string identifier of the respective variable. Parameter {{{var_count}}} contains the internal profile number and must not be changed by the user. For those variables not recognized by the user, the parameter {{{unit}}} is set to "illegal", which tells the calling routine that the output variable is not defined and leads to a program abort.\\
+Here the physical {{{unit}}}(s) and vertical grid (u- or w-grid) of user-defined vertical profile output quantities (see [../../user_parameters#data_output_pr_user data_output_pr_user]) have to be set. Input parameter {{{variable}}} contains the string identifier of the respective variable. Parameter {{{var_count}}} contains the internal profile number and must not be changed by the user. For those variables not recognized by the user, the parameter {{{unit}}} is set to "illegal", which tells the calling routine that the output variable is not defined and leads to a program abort.\\
 See [[../output|User-defined output quantities]] about creating user-defined output quantities.
 }}}
@@ -226 +226 @@
 }}}
 {{{#!td
-Set the grid on which user-defined output quantities (see [../../userpar#data_output_user data_output_user]) are defined. Input parameter {{{variable}}} contains the string identifier of the respective variable. Allowed values are'' 'x' ''and'' 'xu' ''for {{{grid_x}}},'' 'y' ''and'' 'yv' ''for {{{grid_y}}}, and'' 'zu' ''and'' 'zw' ''for {{{grid_z}}}. The output parameter {{{found}}} has to be set ''.TRUE.'' by the user, otherwise, an error message will appear in the job protocol for the respective output quantity.\\
+Set the grid on which user-defined output quantities (see [../../user_parameters#data_output_user data_output_user]) are defined. Input parameter {{{variable}}} contains the string identifier of the respective variable. Allowed values are'' 'x' ''and'' 'xu' ''for {{{grid_x}}},'' 'y' ''and'' 'yv' ''for {{{grid_y}}}, and'' 'zu' ''and'' 'zw' ''for {{{grid_z}}}. The output parameter {{{found}}} has to be set ''.TRUE.'' by the user, otherwise, an error message will appear in the job protocol for the respective output quantity.\\
 
 Example:
@@ -253 +253 @@
 }}}
 {{{#!td
-Resorts user-defined quantities (to be output as cross-section data; see [../../userpar#data_output_user data_output_user]) with indices {{{(k,j,i)}}} to a temporary array {{{local_pf}}} with indices {{{(i,j,k)}}} and sets the grid on which they are defined. Depending on the value of input parameter {{{av}}} resorting is done for instantaneous ({{{av}}}=''0'') or time averaged data ({{{av}}}=''1''). Input parameter {{{variable}}} contains the string identifier of the respective variable. Allowed values for grid are'' 'zu' ''and'' 'zw'.'' The output parameter {{{found}}} has to be set ''.TRUE.'' by the user, otherwise, an error message will appear in the job protocol for the respective output quantity.\\
+Resorts user-defined quantities (to be output as cross-section data; see [../../user_parameters#data_output_user data_output_user]) with indices {{{(k,j,i)}}} to a temporary array {{{local_pf}}} with indices {{{(i,j,k)}}} and sets the grid on which they are defined. Depending on the value of input parameter {{{av}}} resorting is done for instantaneous ({{{av}}}=''0'') or time averaged data ({{{av}}}=''1''). Input parameter {{{variable}}} contains the string identifier of the respective variable. Allowed values for grid are'' 'zu' ''and'' 'zw'.'' The output parameter {{{found}}} has to be set ''.TRUE.'' by the user, otherwise, an error message will appear in the job protocol for the respective output quantity.\\
 See [[../output|User-defined output quantities]] about creating user-defined output quantities.
 }}}
@@ -264 +264 @@
 }}}
 {{{#!td
-Resorts user-defined quantities (to be output as volume data; see [../../userpar#data_output_user data_output_user]) with indices {{{(k,j,i)}}} to a temporary array {{{local_pf}}} with indices {{{(i,j,k)}}} and sets the grid on which they are defined. Depending on the value of input parameter {{{av}}} resorting is done for instantaneous ({{{av}}}=''0'') or time averaged data ({{{av}}}=''1''). Input parameter {{{variable}}} contains the string identifier of the respective variable. The input parameter {{{nz_do}}} defines the upper limit of vertical grid index {{{k}}} of the output array (see [../../runtime_parameters#)nz_do3d nz_do3d]. The output parameter found has to be set ''.TRUE.'' by the user, otherwise, an error message will appear in the job protocol for the respective output quantity.\\
+Resorts user-defined quantities (to be output as volume data; see [../../user_parameters#data_output_user data_output_user]) with indices {{{(k,j,i)}}} to a temporary array {{{local_pf}}} with indices {{{(i,j,k)}}} and sets the grid on which they are defined. Depending on the value of input parameter {{{av}}} resorting is done for instantaneous ({{{av}}}=''0'') or time averaged data ({{{av}}}=''1''). Input parameter {{{variable}}} contains the string identifier of the respective variable. The input parameter {{{nz_do}}} defines the upper limit of vertical grid index {{{k}}} of the output array (see [../../runtime_parameters#)nz_do3d nz_do3d]. The output parameter found has to be set ''.TRUE.'' by the user, otherwise, an error message will appear in the job protocol for the respective output quantity.\\
 See chapter [[../output|User-defined output quantities]] about creating user-defined output quantities.
 }}}
@@ -275 +275 @@
 }}}
 {{{#!td
-Resorts user-defined quantities (to be output as masked data; see [../../userpar#data_output_masks_user data_output_masks_user]) with indices {{{(k,j,i)}}} to a temporary array {{{local_pf}}} with indices {{{(i,j,k)}}} and sets the grid on which they are defined. Depending on the value of input parameter {{{av}}} resorting is done for instantaneous ({{{av}}}=''0'') or time averaged data ({{{av}}}=''1''). Input parameter {{{variable}}} contains the string identifier of the respective variable. The output parameter found has to be set ''.TRUE.'' by the user, otherwise an error message will appear in the job protocol for the respective output quantity.\\
+Resorts user-defined quantities (to be output as masked data; see [../../user_parameters#data_output_masks_user data_output_masks_user]) with indices {{{(k,j,i)}}} to a temporary array {{{local_pf}}} with indices {{{(i,j,k)}}} and sets the grid on which they are defined. Depending on the value of input parameter {{{av}}} resorting is done for instantaneous ({{{av}}}=''0'') or time averaged data ({{{av}}}=''1''). Input parameter {{{variable}}} contains the string identifier of the respective variable. The output parameter found has to be set ''.TRUE.'' by the user, otherwise an error message will appear in the job protocol for the respective output quantity.\\
 See chapter [[../output|User-defined output quantities]] about creating user-defined output quantities.
 }}}
@@ -286 +286 @@
 }}}
 {{{#!td
-Sum up and time-average of user-defined output quantities (see [../../userpar#data_output_user data_output_user]) as well as allocation of the arrays necessary for storing the respective averages. Input parameter {{{variable}}} contains the string identifier of the respective variable. Depending on the requested action, input parameter mode has the value'' 'allocate', 'sum', ''or'' 'average'.''\\
+Sum up and time-average of user-defined output quantities (see [../../user_parameters#data_output_user data_output_user]) as well as allocation of the arrays necessary for storing the respective averages. Input parameter {{{variable}}} contains the string identifier of the respective variable. Depending on the requested action, input parameter mode has the value'' 'allocate', 'sum', ''or'' 'average'.''\\
 See [[../output|User-defined output quantities]] about creating user-defined output quantities. 
 }}}