Changes between Version 50 and Version 51 of doc/app/userint/int

Timestamp:

Oct 14, 2010 10:00:28 AM (14 years ago)

Author:

weinreis

Comment:

--

doc/app/userint/int

@@ -194 +194 @@
 {{{#!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.\\
-See [wiki:chapter_354 chapter 3.5.4] about creating user-defined output quantities.
+See [[../output|User-defined output quantities]] about creating user-defined output quantities.
 }}}
 |----------------
@@ -205 +205 @@
 {{{#!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.\\
-See [wiki:chapter_354 chapter 3.5.4] about creating user-defined output quantities.
+See [[../output|User-defined output quantities]] about creating user-defined output quantities.
 }}}
 |----------------
@@ -243 +243 @@
 {{{#!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.\\
-See [wiki:chapter_354 chapter 3.5.4] about creating user-defined output quantities.
+See [[../output|User-defined output quantities]] about creating user-defined output quantities.
 }}}
 |----------------
@@ -254 +254 @@
 {{{#!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 [../../d3par#)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 [wiki:chapter_354 chapter 3.5.4] about creating user-defined output quantities.
+See chapter [[../output|User-defined output quantities]] about creating user-defined output quantities.
+}}}
+|----------------
+{{{#!td style="vertical-align:top; text-align:left;width: 150px"
+{{{data_output_mask.f90}}} at the end of the {{{CASE}}} structure
+}}}
+{{{#!td style="vertical-align:top; text-align:left;style="width: 50px"
+[=#user_data_output_mask {{{user_data_output_mask}}}]\\{{{( av, variable, found,}}}\\{{{local_pf)}}}
+}}}
+{{{#!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.\\
+See chapter [[../output|User-defined output quantities]] about creating user-defined output quantities.
 }}}
 |----------------
@@ -265 +276 @@
 {{{#!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'.''\\
-See [wiki:chapter_354 chapter 3.5.4] about creating user-defined output quantities. 
+See [[../output|User-defined output quantities]] about creating user-defined output quantities. 
 }}}
 |----------------
@@ -276 +287 @@
 {{{#!td
 Resorts user-defined quantities (to be output as dvrp objects; see [../../userpar#data_output_user data_output_user]) and [../../dvrpar#mode_dvrp mode_dvrp]) with indices {{{(k,j,i)}}} to a temporary array {{{local_pf}}} with indices {{{(i,j,k)}}}. The array {{{local_pf}}} is then handed back to the calling subroutine {{{data_output_dvrp.f90}}}.\\
-See [wiki:chapter_354 chapter 3.5.4] about creating user-defined output quantities.
+See [[../output|User-defined output quantities]] about creating user-defined output quantities.
 }}}
 |----------------