Changes between Version 17 and Version 18 of doc/app/userint/output

Timestamp:

Sep 15, 2010 3:16:38 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]): \\\\
@@ -50 +51 @@
 
    {{{dots_num_palm = dots_num}}} \\
-   {{{dots_num = dots_num}}} [[span(+2,style=color: red)]] \\\\
-
-   Only those parts in [[span(red,style=color: red)]] have to be adjusted by the user. \\\\
+   {{{dots_num = dots_num}}} [[span(+2,style=color: red)]] \\
+
+   Only those parts in [[span(red,style=color: red)]] have to be adjusted by the user. \\
 
    2. These quantities are calculated and output in subroutine [../int#user_statistics user_statistics] for every statistic region {{{sr}}} defined by the user, but at least for the region "total domain":
@@ -63 +64 @@
 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.
 
-   1. 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]). 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.:
+   1. 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]). 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.: \\
+
    {{{data_output_user = 'u2',  'u2_xy_av' }}} \\
 
-      The pure string'' 'u2' ''switches on the output of instantaneous 3d volume data. Output of cross section data and time averaged data is switched on by additionally appending the strings'' '_xy', '_xz', '_yz', ''and/or'' '_av' ''(for a detailed explanation see parameter [../../d3par#data_output data_output]).\\\\
-   2. In order to store the quantities' grid point data within PALM, a 3d data array has to be declared in module [../int#user_module user]:
+   The pure string'' 'u2' ''switches on the output of instantaneous 3d volume data. Output of cross section data and time averaged data is switched on by additionally appending the strings'' '_xy', '_xz', '_yz', ''and/or'' '_av' ''(for a detailed explanation see parameter [../../d3par#data_output data_output]).\\\\
+   2. In order to store the quantities' grid point data within PALM, a 3d data array has to be declared in module [../int#user_module user]: \\
+
    {{{REAL, DIMENSION(:,:,:), ALLOCATABLE ::  u2, u2_av }}} \\
 
-      The second array {{{u2_av}}} is needed in case that output of time averaged data is requested. It is used to store the sum of the data of the respective time levels over which the average has to be carried out. \\\\
-   3. The data array has to be allocated in subroutine [../int#user_init user_init]:
+   The second array {{{u2_av}}} is needed in case that output of time averaged data is requested. It is used to store the sum of the data of the respective time levels over which the average has to be carried out. \\\\
+   3. The data array has to be allocated in subroutine [../int#user_init user_init]: \\
+
    {{{ALLOCATE( u2(nzb:nzt+1,nys-1:nyn+1,nxl-1:nxr+1) ) }}} \\
 
-      In case that output of time averaged data is requested, the array containing the sum has possibly to be read from the restart file (local filename [../../iofiles#BININ BININ) by executing the following code in [../int#user_init user_init]: \\
-
-      {{{IF ( initializing_actions == 'read_restart_data' )  THEN }}} \\
-         {{{    READ ( 13 )  field_char }}} \\
-         {{{    DO  WHILE ( TRIM( field_char ) /= '*** end user ***' ) }}} \\
+   In case that output of time averaged data is requested, the array containing the sum has possibly to be read from the restart file (local filename [../../iofiles#BININ BININ]) by executing the following code in [../int#user_init user_init]: 
+
+   {{{IF ( initializing_actions == 'read_restart_data' )  THEN }}} \\
+      {{{    READ ( 13 )  field_char }}} \\
+      {{{    DO  WHILE ( TRIM( field_char ) /= '*** end user ***' ) }}} \\
              
-            {{{    SELECT CASE ( TRIM( field_char ) ) }}} \\
-
-              {{{     CASE ( 'u2_av' ) }}} \\
-                 {{{     ALLOCATE( u2_av(nzb:nzt+1,nys-1:nyn+1,nxl-1:nxr+1) ) }}} \\
-                 {{{     READ ( 13 )  u2_av }}} \\
-
-              {{{     CASE DEFAULT }}} \\
-                 {{{     PRINT*, '+++ user_init: unknown variable named "', & }}} \\
-                 {{{             TRIM( field_char ), '" found in' }}} \\
-                 {{{     PRINT*, '               data from prior run on PE ', myid }}} \\
-                 {{{     CALL local_stop }}} \\
-
-            {{{    END SELECT  }}} \\
-         {{{    ENDDO }}} \\
-      {{{    ENDIF }}} \\
+         {{{    SELECT CASE ( TRIM( field_char ) ) }}} \\
+
+           {{{     CASE ( 'u2_av' ) }}} \\
+              {{{     ALLOCATE( u2_av(nzb:nzt+1,nys-1:nyn+1,nxl-1:nxr+1) ) }}} \\
+              {{{     READ ( 13 )  u2_av }}} \\
+
+           {{{     CASE DEFAULT }}} \\
+              {{{     PRINT*, '+++ user_init: unknown variable named "', & }}} 
+                 [[span(   {{{TRIM( field_char ), '" found in' }}},style=color: black)]] \\
+              {{{     PRINT*, '               data from prior run on PE ', myid }}} \\
+              {{{     CALL local_stop }}} \\
+          {{{    END SELECT  }}} \\
+      {{{    ENDDO }}} \\
+   {{{    ENDIF }}} \\
 
    4. The quantity has to be given a unit (subroutine user_check_data_output):