Changes between Version 63 and Version 64 of doc/app/userint/output

Timestamp:

Oct 14, 2010 9:49:38 AM (14 years ago)

Author:

weinreis

Comment:

--

doc/app/userint/output

@@ -61 +61 @@
    {{{ ts_value(dots_num_palm+2,sr) = ABS( v_max ) }}} \\\\
 
-[=#part_3 '''3. Output of user-defined 2d cross sections or 3d volume data'''] \\
+[=#part_3 '''3. Output of user-defined 2d cross sections, 3d volume data or masked data'''] \\
 
 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.
@@ -140 +140 @@
          {{{ ENDDO }}} \\
        
-   8. For output of 2d cross sections, the gridpoint data of the quantity has to be resorted to array {{{local_pf}}} in subroutine [../int#user_data_output_2d user_data_output_2d]. Also the vertical grid, on which the quantity is defined, has to be set again: \\
+   8. For output of '''2d cross sections''', the gridpoint data of the quantity has to be resorted to array {{{local_pf}}} in subroutine [../int#user_data_output_2d user_data_output_2d]. Also the vertical grid, on which the quantity is defined, has to be set again: \\
 
    {{{ CASE ( 'u2_xy', 'u2_xz', 'u2_yz' ) }}} \\
@@ -186 +186 @@
       Note that {{{two_d = .TRUE.}}} is necessary for output of a 2d data slice. \\
 
-   9. For output of 3d volume data, the gridpoint data of the quantity has to be resorted to {{{array local_pf}}} in subroutine [../int#user_data_output_3d user_data_output_3d].:
+   9. For output of '''3d volume data''', the gridpoint data of the quantity has to be resorted to {{{array local_pf}}} in subroutine [../int#user_data_output_3d user_data_output_3d].:
 
    {{{ CASE ( 'u2' ) }}} \\
@@ -209 +209 @@
    The {{{ELSE}}} case is only needed in case that output of time-averaged data is requested.
 
-
-  10. In case of job chains, the sum array has to be written to the (binary) restart file (local filename [../../iofiles#BINOUT BINOUT]) in subroutine [../int#user_last_actions user_last_actions]:
+   10. For output of '''masked data''', the gridpoint data of the quantity has to be resorted to {{{array local_pf}}} in subroutine [../int#user_data_output_mask user_data_output_mask].:
+
+   {{{ CASE ( 'u2' ) }}} \\
+        {{{ IF ( av == 0 )  THEN }}} \\
+           {{{ DO  i = 1, mask_size_l(mid,1) }}} \\
+              {{{ DO  j = 1, mask_size_l(mid,2) }}} \\
+                 {{{ DO  k = 1, mask_size_l(mid,3) }}} \\
+                     {{{ local_pf(i,j,k) = u2(mask_k(mid,k), & }}} \\
+                                         {{{ mask_j(mid,j),mask_i(mid,i)) }}} \\
+                  {{{ ENDDO }}} \\
+               {{{ ENDDO }}} \\
+            {{{ ENDDO }}} \\
+         {{{ ELSE }}} \\
+           {{{ DO  i = 1, mask_size_l(mid,1) }}} \\
+              {{{ DO  j = 1, mask_size_l(mid,2) }}} \\
+                 {{{ DO  k = 1, mask_size_l(mid,3) }}} \\
+                     {{{ local_pf(i,j,k) = u2_av(mask_k(mid,k), & }}} \\
+                                            {{{ mask_j(mid,j),mask_i(mid,i)) }}} \\
+                  {{{ ENDDO }}} \\
+              {{{ ENDDO }}} \\
+            {{{ ENDDO }}} \\
+         {{{ ENDIF }}} \\ 
+
+   The {{{ELSE}}} case is only needed in case that output of time-averaged data is requested.
+
+  11. In case of job chains, the sum array has to be written to the (binary) restart file (local filename [../../iofiles#BINOUT BINOUT]) in subroutine [../int#user_last_actions user_last_actions]:
 
   {{{    IF ( ALLOCATED( u2_av ) )  THEN }}}\\