Changeset 3552


Ignore:
Timestamp:
Nov 22, 2018 10:28:35 AM (3 years ago)
Author:
suehring
Message:

further variables documented

Location:
palm/trunk/SOURCE
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • palm/trunk/SOURCE/header.f90

    r3529 r3552  
    2020! Current revisions:
    2121! -----------------
    22 !
     22! variables documented
    2323!
    2424! Former revisions:
     
    515515
    516516   
    517     CHARACTER (LEN=2)  ::  do2d_mode           !<
     517    CHARACTER (LEN=2)  ::  do2d_mode           !< mode of 2D data output (xy, xz, yz)
    518518   
    519     CHARACTER (LEN=5)  ::  section_chr         !<
     519    CHARACTER (LEN=5)  ::  section_chr         !< string indicating grid information where to output 2D slices
    520520   
    521     CHARACTER (LEN=10) ::  coor_chr            !<
    522     CHARACTER (LEN=10) ::  host_chr            !<
     521    CHARACTER (LEN=10) ::  coor_chr            !< string for subsidence velocities in large-scale forcing
     522    CHARACTER (LEN=10) ::  host_chr            !< string for hostname
    523523   
    524     CHARACTER (LEN=16) ::  begin_chr           !<
     524    CHARACTER (LEN=16) ::  begin_chr           !< string indication start time for the data output
    525525   
    526     CHARACTER (LEN=26) ::  ver_rev             !<
    527 
    528     CHARACTER (LEN=32) ::  cpl_name            !<
     526    CHARACTER (LEN=26) ::  ver_rev             !< string for run identification
     527
     528    CHARACTER (LEN=32) ::  cpl_name            !< name of child domain (nesting mode only)
    529529   
    530     CHARACTER (LEN=40) ::  output_format       !<
     530    CHARACTER (LEN=40) ::  output_format       !< netcdf format
    531531   
    532     CHARACTER (LEN=70) ::  char1               !<
    533     CHARACTER (LEN=70) ::  char2               !<
    534     CHARACTER (LEN=70) ::  dopr_chr            !<
    535     CHARACTER (LEN=70) ::  do2d_xy             !<
    536     CHARACTER (LEN=70) ::  do2d_xz             !<
    537     CHARACTER (LEN=70) ::  do2d_yz             !<
    538     CHARACTER (LEN=70) ::  do3d_chr            !<
    539     CHARACTER (LEN=70) ::  domask_chr          !<
    540     CHARACTER (LEN=70) ::  run_classification  !<
     532    CHARACTER (LEN=70) ::  char1               !< dummy varialbe used for various strings
     533    CHARACTER (LEN=70) ::  char2               !< string containing informating about the advected distance in case of Galilei transformation
     534    CHARACTER (LEN=70) ::  dopr_chr            !< string indicating profile output variables
     535    CHARACTER (LEN=70) ::  do2d_xy             !< string indicating 2D-xy output variables
     536    CHARACTER (LEN=70) ::  do2d_xz             !< string indicating 2D-xz output variables
     537    CHARACTER (LEN=70) ::  do2d_yz             !< string indicating 2D-yz output variables
     538    CHARACTER (LEN=70) ::  do3d_chr            !< string indicating 3D output variables
     539    CHARACTER (LEN=70) ::  domask_chr          !< string indicating masked output variables
     540    CHARACTER (LEN=70) ::  run_classification  !< string classifying type of run, e.g. nested, coupled, etc.
    541541   
    542     CHARACTER (LEN=85) ::  r_upper             !<
    543     CHARACTER (LEN=85) ::  r_lower             !<
     542    CHARACTER (LEN=85) ::  r_upper             !< string indicating model top boundary condition for various quantities
     543    CHARACTER (LEN=85) ::  r_lower             !< string indicating bottom boundary condition for various quantities
    544544   
    545     CHARACTER (LEN=86) ::  coordinates         !<
    546     CHARACTER (LEN=86) ::  gradients           !<
    547     CHARACTER (LEN=86) ::  slices              !<
    548     CHARACTER (LEN=86) ::  temperatures        !<
    549     CHARACTER (LEN=86) ::  ugcomponent         !<
    550     CHARACTER (LEN=86) ::  vgcomponent         !<
    551 
    552     CHARACTER (LEN=1), DIMENSION(1:3) ::  dir = (/ 'x', 'y', 'z' /)  !<
    553 
    554     INTEGER(iwp) ::  av             !<
    555     INTEGER(iwp) ::  bh             !<
    556     INTEGER(iwp) ::  blx            !<
    557     INTEGER(iwp) ::  bly            !<
    558     INTEGER(iwp) ::  bxl            !<
    559     INTEGER(iwp) ::  bxr            !<
    560     INTEGER(iwp) ::  byn            !<
    561     INTEGER(iwp) ::  bys            !<
    562     INTEGER(iwp) ::  ch             !<
    563     INTEGER(iwp) ::  count          !<
    564     INTEGER(iwp) ::  cpl_parent_id  !<
    565     INTEGER(iwp) ::  cwx            !<
    566     INTEGER(iwp) ::  cwy            !<
    567     INTEGER(iwp) ::  cxl            !<
    568     INTEGER(iwp) ::  cxr            !<
    569     INTEGER(iwp) ::  cyn            !<
    570     INTEGER(iwp) ::  cys            !<
    571     INTEGER(iwp) ::  dim            !<
    572     INTEGER(iwp) ::  i              !<
    573     INTEGER(iwp) ::  io             !<
    574     INTEGER(iwp) ::  l              !<
    575     INTEGER(iwp) ::  ll             !<
    576     INTEGER(iwp) ::  my_cpl_id      !<
    577     INTEGER(iwp) ::  n              !<
    578     INTEGER(iwp) ::  ncpl           !<
    579     INTEGER(iwp) ::  npe_total      !<
     545    CHARACTER (LEN=86) ::  coordinates         !< string indicating height coordinates for profile-prescribed variables
     546    CHARACTER (LEN=86) ::  gradients           !< string indicating gradients of profile-prescribed variables between the prescribed height coordinates
     547    CHARACTER (LEN=86) ::  slices              !< string indicating grid coordinates of profile-prescribed subsidence velocity
     548    CHARACTER (LEN=86) ::  temperatures        !< string indicating profile-prescribed subsidence velocities
     549    CHARACTER (LEN=86) ::  ugcomponent         !< string indicating profile-prescribed geostrophic u-component
     550    CHARACTER (LEN=86) ::  vgcomponent         !< string indicating profile-prescribed geostrophic v-component
     551
     552    CHARACTER (LEN=1), DIMENSION(1:3) ::  dir = (/ 'x', 'y', 'z' /)  !< string indicating masking steps along certain direction
     553
     554    INTEGER(iwp) ::  av             !< index indicating average output quantities
     555    INTEGER(iwp) ::  bh             !< building height in generic single-building setup
     556    INTEGER(iwp) ::  blx            !< building width in grid points along x in generic single-building setup
     557    INTEGER(iwp) ::  bly            !< building width in grid points along y in generic single-building setup
     558    INTEGER(iwp) ::  bxl            !< index for left building wall in generic single-building setup
     559    INTEGER(iwp) ::  bxr            !< index for right building wall in generic single-building setup
     560    INTEGER(iwp) ::  byn            !< index for north building wall in generic single-building setup
     561    INTEGER(iwp) ::  bys            !< index for south building wall in generic single-building setup
     562    INTEGER(iwp) ::  ch             !< canyon depth in generic street-canyon setup
     563    INTEGER(iwp) ::  count          !< number of masked output locations
     564    INTEGER(iwp) ::  cpl_parent_id  !< parent ID for the respective child model
     565    INTEGER(iwp) ::  cwx            !< canyon width along x in generic street-canyon setup
     566    INTEGER(iwp) ::  cwy            !< canyon width along y in generic street-canyon setup
     567    INTEGER(iwp) ::  cxl            !< index for left canyon wall in generic street-canyon setup
     568    INTEGER(iwp) ::  cxr            !< index for right canyon wall in generic street-canyon setup
     569    INTEGER(iwp) ::  cyn            !< index for north canyon wall in generic street-canyon setup
     570    INTEGER(iwp) ::  cys            !< index for south canyon wall in generic street-canyon setup
     571    INTEGER(iwp) ::  dim            !< running index for masking output locations
     572    INTEGER(iwp) ::  i              !< running index for various loops
     573    INTEGER(iwp) ::  io             !< file unit of HEADER file
     574    INTEGER(iwp) ::  l              !< substring length
     575    INTEGER(iwp) ::  ll             !< substring length
     576    INTEGER(iwp) ::  my_cpl_id      !< run id in a nested model setup
     577    INTEGER(iwp) ::  n              !< running index over number of couplers in a nested model setup
     578    INTEGER(iwp) ::  ncpl           !< number of coupler in a nested model setup
     579    INTEGER(iwp) ::  npe_total      !< number of total PEs in a coupler (parent + child)
    580580   
    581581
    582     REAL(wp) ::  cpuseconds_per_simulated_second  !<
     582    REAL(wp) ::  cpuseconds_per_simulated_second  !< CPU time (in s) per simulated second
    583583    REAL(wp) ::  lower_left_coord_x               !< x-coordinate of nest domain
    584584    REAL(wp) ::  lower_left_coord_y               !< y-coordinate of nest domain
  • palm/trunk/SOURCE/init_pegrid.f90

    r3543 r3552  
    2020! Current revisions:
    2121! ------------------
    22 !
     22! variables documented
    2323!
    2424! Former revisions:
     
    289289    IMPLICIT NONE
    290290
    291     INTEGER(iwp) ::  i                        !<
    292     INTEGER(iwp) ::  id_inflow_l              !<
     291    INTEGER(iwp) ::  i                        !< running index over number of processors or number of multigrid level
     292    INTEGER(iwp) ::  id_inflow_l              !< ID indicating processors located at the left inflow boundary
    293293    INTEGER(iwp) ::  id_outflow_l             !< local value of id_outflow
    294294    INTEGER(iwp) ::  id_outflow_source_l      !< local value of id_outflow_source
    295     INTEGER(iwp) ::  id_recycling_l           !<
     295    INTEGER(iwp) ::  id_recycling_l           !< ID indicating processors located at the recycling plane
    296296    INTEGER(iwp) ::  id_stg_left_l            !< left lateral boundary local core id in case of turbulence generator 
    297297    INTEGER(iwp) ::  id_stg_north_l           !< north lateral boundary local core id in case of turbulence generator 
    298298    INTEGER(iwp) ::  id_stg_right_l           !< right lateral boundary local core id in case of turbulence generator 
    299299    INTEGER(iwp) ::  id_stg_south_l           !< south lateral boundary local core id in case of turbulence generator 
    300     INTEGER(iwp) ::  ind(5)                   !<
    301     INTEGER(iwp) ::  j                        !<
    302     INTEGER(iwp) ::  k                        !<
    303     INTEGER(iwp) ::  maximum_grid_level_l     !<
    304     INTEGER(iwp) ::  mg_levels_x              !<
    305     INTEGER(iwp) ::  mg_levels_y              !<
    306     INTEGER(iwp) ::  mg_levels_z              !<
    307     INTEGER(iwp) ::  mg_switch_to_pe0_level_l !<
    308     INTEGER(iwp) ::  nnx_y                    !<
    309     INTEGER(iwp) ::  nny_x                    !<
    310     INTEGER(iwp) ::  nny_z                    !<
    311     INTEGER(iwp) ::  nnz_x                    !<
    312     INTEGER(iwp) ::  nnz_y                    !<
    313     INTEGER(iwp) ::  numproc_sqr              !<
    314     INTEGER(iwp) ::  nxl_l                    !<
    315     INTEGER(iwp) ::  nxr_l                    !<
    316     INTEGER(iwp) ::  nyn_l                    !<
    317     INTEGER(iwp) ::  nys_l                    !<
    318     INTEGER(iwp) ::  nzb_l                    !<
    319     INTEGER(iwp) ::  nzt_l                    !<
    320 !$  INTEGER(iwp) ::  omp_get_num_threads      !<
    321 
    322     INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  ind_all !<
    323     INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  nxlf    !<
    324     INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  nxrf    !<
    325     INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  nynf    !<
    326     INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  nysf    !<
    327 
    328     INTEGER(iwp), DIMENSION(2) ::  pdims_remote         !<
     300    INTEGER(iwp) ::  ind(5)                   !< array containing the subdomain bounds
     301    INTEGER(iwp) ::  j                        !< running index, used for various loops
     302    INTEGER(iwp) ::  k                        !< number of vertical grid points in different multigrid level
     303    INTEGER(iwp) ::  maximum_grid_level_l     !< maximum number of grid level without switching to PE 0
     304    INTEGER(iwp) ::  mg_levels_x              !< maximum number of grid level allowed along x-direction
     305    INTEGER(iwp) ::  mg_levels_y              !< maximum number of grid level allowed along y-direction
     306    INTEGER(iwp) ::  mg_levels_z              !< maximum number of grid level allowed along z-direction
     307    INTEGER(iwp) ::  mg_switch_to_pe0_level_l !< maximum number of grid level with switching to PE 0
     308    INTEGER(iwp) ::  nnx_y                    !< quotient of number of grid points along x-direction and number of PEs used along y-direction
     309    INTEGER(iwp) ::  nny_x                    !< quotient of number of grid points along y-direction and number of PEs used along x-direction
     310    INTEGER(iwp) ::  nny_z                    !< quotient of number of grid points along y-direction and number of PEs used along x-direction
     311    INTEGER(iwp) ::  nnz_x                    !< quotient of number of grid points along z-direction and number of PEs used along x-direction
     312    INTEGER(iwp) ::  nnz_y                    !< quotient of number of grid points along z-direction and number of PEs used along x-direction
     313    INTEGER(iwp) ::  numproc_sqr              !< square root of the number of processors
     314    INTEGER(iwp) ::  nxl_l                    !< lower index bound along x-direction on subdomain and different multigrid level
     315    INTEGER(iwp) ::  nxr_l                    !< upper index bound along x-direction on subdomain and different multigrid level
     316    INTEGER(iwp) ::  nyn_l                    !< lower index bound along y-direction on subdomain and different multigrid level
     317    INTEGER(iwp) ::  nys_l                    !< upper index bound along y-direction on subdomain and different multigrid level
     318    INTEGER(iwp) ::  nzb_l                    !< lower index bound along z-direction on subdomain and different multigrid level
     319    INTEGER(iwp) ::  nzt_l                    !< upper index bound along z-direction on subdomain and different multigrid level
     320!$  INTEGER(iwp) ::  omp_get_num_threads      !< number of OpenMP threads
     321
     322    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  ind_all !< dummy array containing index bounds on subdomain, used for gathering
     323    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  nxlf    !< lower index bound allong x-direction for every PE
     324    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  nxrf    !< upper index bound allong x-direction for every PE
     325    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  nynf    !< lower index bound allong y-direction for every PE
     326    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  nysf    !< lower index bound allong y-direction for every PE
     327
     328    INTEGER(iwp), DIMENSION(2) ::  pdims_remote         !< number of PEs used for coupled model (only in atmospher-ocean coupling)
    329329    INTEGER(iwp)               ::  lcoord(2)            !< PE coordinates of left neighbor along x and y
    330330    INTEGER(iwp)               ::  rcoord(2)            !< PE coordinates of right neighbor along x and y
  • palm/trunk/SOURCE/netcdf_data_input_mod.f90

    r3543 r3552  
    2020! Current revisions:
    2121! -----------------
    22 !
     22! variables documented and unused variables removed
    2323!
    2424! Former revisions:
     
    306306       INTEGER(iwp) ::  tind_p !< time index for following time in mesoscale-offline nesting
    307307
    308        LOGICAL      ::  init         = .FALSE.
    309        LOGICAL      ::  from_file    = .FALSE.
     308       LOGICAL      ::  init         = .FALSE. !< flag indicating that offline nesting is already initialized
    310309
    311310       REAL(wp), DIMENSION(:), ALLOCATABLE ::  surface_pressure !< time dependent surface pressure
     
    11711170       INTEGER(iwp) ::  val      !< value of the attribute
    11721171       
    1173        LOGICAL ::  global                 !< flag indicating a global or a variable's attribute
     1172       LOGICAL ::  global        !< flag indicating a global or a variable's attribute
    11741173
    11751174#if defined ( __netcdf )
     
    31353134       IMPLICIT NONE
    31363135
    3137        CHARACTER(LEN=100), DIMENSION(:), ALLOCATABLE ::  var_names
     3136       CHARACTER(LEN=100), DIMENSION(:), ALLOCATABLE ::  var_names !< string containing all variables on file
    31383137     
    31393138       INTEGER(iwp) ::  id_dynamic !< NetCDF id of dynamic input file
     
    32813280       INTEGER(iwp) ::  num_vars   !< number of variables in netcdf input file
    32823281       INTEGER(iwp) ::  t          !< running index time dimension
    3283 
    3284        nest_offl%from_file = MERGE( .TRUE., .FALSE., input_pids_dynamic )
    32853282!
    32863283!--    Skip input if no forcing from larger-scale models is applied.
     
    50305027       INTEGER(iwp)                ::  id_var           !< dimension id
    50315028
    5032        REAL(wp), DIMENSION(:), INTENT(INOUT) ::  var  !< variable to be read
     5029       REAL(wp), DIMENSION(:), INTENT(INOUT) ::  var    !< variable to be read
    50335030#if defined( __netcdf )
    50345031
     
    53955392                                                         !< to its reverse memory access
    53965393
    5397        REAL(wp), DIMENSION(:,:,:), INTENT(INOUT) ::  var  !< variable to be read
     5394       REAL(wp), DIMENSION(:,:,:), INTENT(INOUT) ::  var !< variable to be read
    53985395#if defined( __netcdf )
    53995396
     
    58745871       IMPLICIT NONE
    58755872
    5876        CHARACTER(LEN=6) ::  message_identifier
    5877        CHARACTER(LEN=*) ::  routine_name
    5878        CHARACTER(LEN=*), OPTIONAL ::  name
     5873       CHARACTER(LEN=6) ::  message_identifier !< string for the error number
     5874       CHARACTER(LEN=*) ::  routine_name       !< routine name where the error happened
     5875       CHARACTER(LEN=*), OPTIONAL ::  name     !< name of variable where reading failed
    58795876
    58805877       INTEGER(iwp) ::  errno
  • palm/trunk/SOURCE/sum_up_3d_data.f90

    r3525 r3552  
    2020! Current revisions:
    2121! -----------------
    22 !
     22! variables documented
    2323!
    2424! Former revisions:
     
    309309    INTEGER(iwp) ::  j   !< grid index y direction
    310310    INTEGER(iwp) ::  k   !< grid index x direction
    311     INTEGER(iwp) ::  m   !< running index surface type
    312     INTEGER(iwp) ::  n   !<
    313 
    314     REAL(wp)     ::  mean_r !<
    315     REAL(wp)     ::  s_r2   !<
    316     REAL(wp)     ::  s_r3   !<
     311    INTEGER(iwp) ::  m   !< running index over surfacle elements
     312    INTEGER(iwp) ::  n   !< running index over number of particles per grid box
     313
     314    REAL(wp)     ::  mean_r !< mean-particle radius witin grid box
     315    REAL(wp)     ::  s_r2   !< mean-particle radius witin grid box to the power of two
     316    REAL(wp)     ::  s_r3   !< mean-particle radius witin grid box to the power of three
    317317
    318318    CHARACTER (LEN=varnamelength) ::  trimvar  !< TRIM of output-variable string
Note: See TracChangeset for help on using the changeset viewer.