Changes between Version 3 and Version 4 of doc/app/userint/output


Ignore:
Timestamp:
Sep 15, 2010 11:32:19 AM (14 years ago)
Author:
suehring
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • doc/app/userint/output

    v3 v4  
    99   4. [#part_4 dvrp objects], and
    1010   5. [#part_5 spectra]. \\\\
    11 [=#part_1 1. Output of user-defined vertical profiles] \\\\
    12 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.
    13 
    14    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 data_output_pr). To switch on output of this quantity, the user has to assign the string identifier to the parameter data_output_pr_user, eg.:
    15 
    16           data_output_pr_user = 'u*v*',
    17 
    18    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 user_check_data_output_pr):
    19 
    20           CASE ( 'u*v*' )
    21              index = pr_palm + 1                                             ! identification number
    22              dopr_index(var_count) = index
    23              dopr_unit(var_count)  = 'm2/s2'                                 ! physical unit
    24              hom(:,2,index,:)      = SPREAD( zu, 2, statistic_regions+1 )    ! vertical grid
    25 
    26       Here only the those parts in red color have to be given by the user appropriately.
    27       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 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).
     11[=#part_1 '''1. Output of user-defined vertical profiles'''] \\\\
     12This 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.\\\\
     13   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.:
     14{{{
     15data_output_pr_user = 'u*v*',
     16}}}
     17   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_data_output_pr]):
     18{{{
     19CASE ( 'u*v*' )
     20   index = pr_palm + [[span(1 ,style=color: red)]]                 ! identification number
     21   dopr_index(var_count) = index
     22   dopr_unit(var_count)  = '[[span(m2s2 ,style=color: blue)]]'     ! physical unit
     23   hom(:,2,index,:)      = SPREAD( [[span(zu ,style=color: blue)]], 2, statistic_regions+1 )    ! vertical grid
     24}}}
     25      Here only the those parts in [[span(red ,style=color: blue)]] color have to be given by the user appropriately.
     26      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).
    2827
    2928   3. The quantity has to be calculated for all gridpoints (subroutine user_statistics):