Changes between Version 8 and Version 9 of doc/app/userint/output

Timestamp:

Sep 15, 2010 1:27:24 PM (14 years ago)

Author:

suehring

Comment:

--

doc/app/userint/output

@@ -11 +11 @@
 [=#part_1 '''1. Output of user-defined vertical profiles'''] \\\\
 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.\\\\
-   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]). To switch on output of this quantity, the user has to assign the string identifier to the parameter [../../userpar#data_output_pr_user data_output_pr_user], eg.:
-{{{
-data_output_pr_user = 'u*v*',
-}}}
+   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]). To switch on output of this quantity, the user has to assign the string identifier to the parameter [../../userpar#data_output_pr_user data_output_pr_user], eg.:\\\
+{{{data_output_pr_user = 'u*v*'}}}, \\\\
+
    2. For the quantity, an identification number, a physical unit, and the vertical grid on which it is defined (u- or w-grid), has to be assigned (subroutine [../int#user_check_data_output_pr user_check]\\ [../int#user_check_data_output_pr _data_output_pr]): \\\\
-{{{
-CASE ( 'u*v*' )
-   index = pr_palm + 1                                             ! identification number
-   dopr_index(var_count) = index
-   dopr_unit(var_count)  = 'm2/s2'                                 ! physical unit
-   hom(:,2,index,:)      = SPREAD( zu, 2, statistic_regions+1 )    ! vertical grid
-}}}
+   {{{CASE ( 'u*v*' )}}} \\
+       {{{index = pr_palm +}}} [[span(1 ,style=color: red)]]                                            {{{! identification number}}} \\
+       {{{dopr_index(var_count) = index}}} \\
+       {{{dopr_unit(var_count)  =}}} '[[span(m2s2,style=color: red)]]'                                  {{{! physical unit}}} \\
+       {{{hom(:,2,index,:)      = SPREAD(}}} [[span(zu,style=color: red)]]{{{, 2, statistic_regions+1 )    ! vertical grid }}}
 
    Here only the those parts in [[span(red ,style=color: red)]] color have to be given by the user appropriately.\\
    The identification number (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 [../../userpar#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).
 
-   3. The quantity has to be calculated for all gridpoints (subroutine user_statistics):
-{{{
-!$OMP DO
-   DO  i = nxl, nxr
-      DO  j = nys, nyn
-         DO  k = nzb_s_inner(j,i)+1, nzt
-            sums_l(k,pr_palm+1,tn) = sums_l(k,pr_palm+1,tn) +           &
-                   ( 0.5 * ( u(k,j,i) + u(k,j,i+1) ) - hom(k,1,1,sr) ) * &
-                   ( 0.5 * ( v(k,j,i) + v(k,j+1,i) ) - hom(k,1,2,sr) )   &
-                   * rmask(j,i,sr)
-         ENDDO
-      ENDDO
-   ENDDO
-}}}
+   3. The quantity has to be calculated for all gridpoints (subroutine user_statistics): \\\\
+   {{{!$OMP DO}}} 
+      {{{DO  i = nxl, nxr}}} 
+         {{{DO  j = nys, nyn}}} 
+            {{{DO  k = nzb_s_inner(j,i)+1, nzt}}}  
+               {{{sums_l(k,pr_palm+1,tn) = sums_l(k,pr_palm+1,tn) +}}}              {{{             & }}} 
+                      [[span(({{{0.5*(u(k,j,i)+u(k,j,i+1))-hom(k,1,1,sr))*&}}},style=color: red)]]   \\
+                      [[span(({{{0.5*(v(k,j,i)+v(k,j+1,i))-hom(k,1,2,sr))   &}}},style=color: red)]]   \\
+                      {{{* rmask(j,i,sr)}}}  
+            {{{ENDDO}}} \\
+         {{{ENDDO}}}  \\
+      {{{ENDDO}}} \\\\
+
    Once again, only those parts in red have to be adjusted by the user.\\
    The turbulent resolved-scale momentum flux ''u*v*'' is defined as the product of the deviations of the horizontal velocities from their respective horizontally averaged mean values. These mean values are stored in array {{{hom(..,1,1,sr)}}} and {{{hom(..,1,2,sr)}}} for the u- and v-component, respectively. Since due to the staggered grid, u and v are not defined at the same gridpoints, they have to be interpolated appropriately (here to the center of the gridbox). The result of the calculation is stored in array {{{sums_l}}}. The second index of this array is the identification number of the profile which must match the one given in the previous step 2.