Ignore:
Timestamp:
Oct 7, 2015 11:56:08 PM (6 years ago)
Author:
knoop
Message:

Code annotations made doxygen readable

File:
1 edited

Legend:

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

    r1676 r1682  
    1  SUBROUTINE header
    2 
     1!> @file header.f90
    32!--------------------------------------------------------------------------------!
    43! This file is part of PALM.
     
    2019! Current revisions:
    2120! -----------------
    22 !
     21! Code annotations made doxygen readable
    2322!
    2423! Former revisions:
     
    195194! Description:
    196195! ------------
    197 ! Writing a header with all important information about the actual run.
    198 ! This subroutine is called three times, two times at the beginning
    199 ! (writing information on files RUN_CONTROL and HEADER) and one time at the
    200 ! end of the run, then writing additional information about CPU-usage on file
    201 ! header.
     196!> Writing a header with all important information about the actual run.
     197!> This subroutine is called three times, two times at the beginning
     198!> (writing information on files RUN_CONTROL and HEADER) and one time at the
     199!> end of the run, then writing additional information about CPU-usage on file
     200!> header.
    202201!-----------------------------------------------------------------------------!
     202 SUBROUTINE header
     203 
    203204
    204205    USE arrays_3d,                                                             &
     
    268269    IMPLICIT NONE
    269270
    270     CHARACTER (LEN=1)  ::  prec                !:
     271    CHARACTER (LEN=1)  ::  prec                !<
    271272   
    272     CHARACTER (LEN=2)  ::  do2d_mode           !:
     273    CHARACTER (LEN=2)  ::  do2d_mode           !<
    273274   
    274     CHARACTER (LEN=5)  ::  section_chr         !:
     275    CHARACTER (LEN=5)  ::  section_chr         !<
    275276   
    276     CHARACTER (LEN=10) ::  coor_chr            !:
    277     CHARACTER (LEN=10) ::  host_chr            !:
     277    CHARACTER (LEN=10) ::  coor_chr            !<
     278    CHARACTER (LEN=10) ::  host_chr            !<
    278279   
    279     CHARACTER (LEN=16) ::  begin_chr           !:
     280    CHARACTER (LEN=16) ::  begin_chr           !<
    280281   
    281     CHARACTER (LEN=26) ::  ver_rev             !:
     282    CHARACTER (LEN=26) ::  ver_rev             !<
    282283   
    283     CHARACTER (LEN=40) ::  output_format       !:
     284    CHARACTER (LEN=40) ::  output_format       !<
    284285   
    285     CHARACTER (LEN=70) ::  char1               !:
    286     CHARACTER (LEN=70) ::  char2               !:
    287     CHARACTER (LEN=70) ::  dopr_chr            !:
    288     CHARACTER (LEN=70) ::  do2d_xy             !:
    289     CHARACTER (LEN=70) ::  do2d_xz             !:
    290     CHARACTER (LEN=70) ::  do2d_yz             !:
    291     CHARACTER (LEN=70) ::  do3d_chr            !:
    292     CHARACTER (LEN=70) ::  domask_chr          !:
    293     CHARACTER (LEN=70) ::  run_classification  !:
     286    CHARACTER (LEN=70) ::  char1               !<
     287    CHARACTER (LEN=70) ::  char2               !<
     288    CHARACTER (LEN=70) ::  dopr_chr            !<
     289    CHARACTER (LEN=70) ::  do2d_xy             !<
     290    CHARACTER (LEN=70) ::  do2d_xz             !<
     291    CHARACTER (LEN=70) ::  do2d_yz             !<
     292    CHARACTER (LEN=70) ::  do3d_chr            !<
     293    CHARACTER (LEN=70) ::  domask_chr          !<
     294    CHARACTER (LEN=70) ::  run_classification  !<
    294295   
    295     CHARACTER (LEN=85) ::  roben               !:
    296     CHARACTER (LEN=85) ::  runten              !:
     296    CHARACTER (LEN=85) ::  roben               !<
     297    CHARACTER (LEN=85) ::  runten              !<
    297298   
    298     CHARACTER (LEN=86) ::  coordinates         !:
    299     CHARACTER (LEN=86) ::  gradients           !:
    300     CHARACTER (LEN=86) ::  leaf_area_density   !:
    301     CHARACTER (LEN=86) ::  roots               !:
    302     CHARACTER (LEN=86) ::  slices              !:
    303     CHARACTER (LEN=86) ::  temperatures        !:
    304     CHARACTER (LEN=86) ::  ugcomponent         !:
    305     CHARACTER (LEN=86) ::  vgcomponent         !:
    306 
    307     CHARACTER (LEN=1), DIMENSION(1:3) ::  dir = (/ 'x', 'y', 'z' /)  !:
    308 
    309     INTEGER(iwp) ::  av        !:
    310     INTEGER(iwp) ::  bh        !:
    311     INTEGER(iwp) ::  blx       !:
    312     INTEGER(iwp) ::  bly       !:
    313     INTEGER(iwp) ::  bxl       !:
    314     INTEGER(iwp) ::  bxr       !:
    315     INTEGER(iwp) ::  byn       !:
    316     INTEGER(iwp) ::  bys       !:
    317     INTEGER(iwp) ::  ch        !:
    318     INTEGER(iwp) ::  count     !:
    319     INTEGER(iwp) ::  cwx       !:
    320     INTEGER(iwp) ::  cwy       !:
    321     INTEGER(iwp) ::  cxl       !:
    322     INTEGER(iwp) ::  cxr       !:
    323     INTEGER(iwp) ::  cyn       !:
    324     INTEGER(iwp) ::  cys       !:
    325     INTEGER(iwp) ::  dim       !:
    326     INTEGER(iwp) ::  i         !:
    327     INTEGER(iwp) ::  io        !:
    328     INTEGER(iwp) ::  j         !:
    329     INTEGER(iwp) ::  k         !:
    330     INTEGER(iwp) ::  l         !:
    331     INTEGER(iwp) ::  ll        !:
    332     INTEGER(iwp) ::  mpi_type  !:
     299    CHARACTER (LEN=86) ::  coordinates         !<
     300    CHARACTER (LEN=86) ::  gradients           !<
     301    CHARACTER (LEN=86) ::  leaf_area_density   !<
     302    CHARACTER (LEN=86) ::  roots               !<
     303    CHARACTER (LEN=86) ::  slices              !<
     304    CHARACTER (LEN=86) ::  temperatures        !<
     305    CHARACTER (LEN=86) ::  ugcomponent         !<
     306    CHARACTER (LEN=86) ::  vgcomponent         !<
     307
     308    CHARACTER (LEN=1), DIMENSION(1:3) ::  dir = (/ 'x', 'y', 'z' /)  !<
     309
     310    INTEGER(iwp) ::  av        !<
     311    INTEGER(iwp) ::  bh        !<
     312    INTEGER(iwp) ::  blx       !<
     313    INTEGER(iwp) ::  bly       !<
     314    INTEGER(iwp) ::  bxl       !<
     315    INTEGER(iwp) ::  bxr       !<
     316    INTEGER(iwp) ::  byn       !<
     317    INTEGER(iwp) ::  bys       !<
     318    INTEGER(iwp) ::  ch        !<
     319    INTEGER(iwp) ::  count     !<
     320    INTEGER(iwp) ::  cwx       !<
     321    INTEGER(iwp) ::  cwy       !<
     322    INTEGER(iwp) ::  cxl       !<
     323    INTEGER(iwp) ::  cxr       !<
     324    INTEGER(iwp) ::  cyn       !<
     325    INTEGER(iwp) ::  cys       !<
     326    INTEGER(iwp) ::  dim       !<
     327    INTEGER(iwp) ::  i         !<
     328    INTEGER(iwp) ::  io        !<
     329    INTEGER(iwp) ::  j         !<
     330    INTEGER(iwp) ::  k         !<
     331    INTEGER(iwp) ::  l         !<
     332    INTEGER(iwp) ::  ll        !<
     333    INTEGER(iwp) ::  mpi_type  !<
    333334   
    334     REAL(wp) ::  canopy_height                    !: canopy height (in m)
    335     REAL(wp) ::  cpuseconds_per_simulated_second  !:
     335    REAL(wp) ::  canopy_height                    !< canopy height (in m)
     336    REAL(wp) ::  cpuseconds_per_simulated_second  !<
    336337
    337338!
Note: See TracChangeset for help on using the changeset viewer.