Changeset 1682 for palm/trunk/SOURCE/advec_s_bc.f90

Timestamp:

Oct 7, 2015 11:56:08 PM (9 years ago)

Author:

knoop

Message:

Code annotations made doxygen readable

File:

• palm/trunk/SOURCE/advec_s_bc.f90 (modified) (5 diffs)

palm/trunk/SOURCE/advec_s_bc.f90

@@ -1 @@
-MODULE advec_s_bc_mod
-
+!> @file advec_s_bc.f90
 !--------------------------------------------------------------------------------!
 ! This file is part of PALM.
@@ -20 +19 @@
 ! Current revisions:
 ! -----------------
-!
+! Code annotations made doxygen readable
 ! 
 ! Former revisions:
@@ -68 +67 @@
 ! Description:
 ! ------------
-! Advection term for scalar quantities using the Bott-Chlond scheme.
-! Computation in individual steps for each of the three dimensions.
-! Limiting assumptions:
-! So far the scheme has been assuming equidistant grid spacing. As this is not
-! the case in the stretched portion of the z-direction, there dzw(k) is used as
-! a substitute for a constant grid length. This certainly causes incorrect
-! results; however, it is hoped that they are not too apparent for weakly 
-! stretched grids.
-! NOTE: This is a provisional, non-optimised version!
+!> Advection term for scalar quantities using the Bott-Chlond scheme.
+!> Computation in individual steps for each of the three dimensions.
+!> Limiting assumptions:
+!> So far the scheme has been assuming equidistant grid spacing. As this is not
+!> the case in the stretched portion of the z-direction, there dzw(k) is used as
+!> a substitute for a constant grid length. This certainly causes incorrect
+!> results; however, it is hoped that they are not too apparent for weakly 
+!> stretched grids.
+!> NOTE: This is a provisional, non-optimised version!
 !------------------------------------------------------------------------------!
+MODULE advec_s_bc_mod
+ 
 
     PRIVATE
@@ -88 +89 @@
  CONTAINS
 
+!------------------------------------------------------------------------------!
+! Description:
+! ------------
+!> @todo Missing subroutine description.
+!------------------------------------------------------------------------------!
     SUBROUTINE advec_s_bc( sk, sk_char )
 
@@ -120 +126 @@
        IMPLICIT NONE
 
-       CHARACTER (LEN=*) ::  sk_char !:
-
-       INTEGER(iwp) ::  i         !:
-       INTEGER(iwp) ::  ix        !:
-       INTEGER(iwp) ::  j         !:
-       INTEGER(iwp) ::  k         !:
-       INTEGER(iwp) ::  ngp       !:
-       INTEGER(iwp) ::  sr        !:
-       INTEGER(iwp) ::  type_xz_2 !:
-
-       REAL(wp) ::  cim    !:
-       REAL(wp) ::  cimf   !:
-       REAL(wp) ::  cip    !:
-       REAL(wp) ::  cipf   !:
-       REAL(wp) ::  d_new  !:
-       REAL(wp) ::  denomi !: denominator
-       REAL(wp) ::  fminus !:
-       REAL(wp) ::  fplus  !:
-       REAL(wp) ::  f2     !:
-       REAL(wp) ::  f4     !:
-       REAL(wp) ::  f8     !:
-       REAL(wp) ::  f12    !:
-       REAL(wp) ::  f24    !:
-       REAL(wp) ::  f48    !:
-       REAL(wp) ::  f1920  !:
-       REAL(wp) ::  im     !:
-       REAL(wp) ::  ip     !:
-       REAL(wp) ::  m2     !:
-       REAL(wp) ::  m3     !:
-       REAL(wp) ::  numera !: numerator
-       REAL(wp) ::  snenn  !:
-       REAL(wp) ::  sterm  !:
-       REAL(wp) ::  tendcy !:
-       REAL(wp) ::  t1     !:
-       REAL(wp) ::  t2     !:
-
-       REAL(wp) ::  fmax(2)   !:
-       REAL(wp) ::  fmax_l(2) !:
+       CHARACTER (LEN=*) ::  sk_char !<
+
+       INTEGER(iwp) ::  i         !<
+       INTEGER(iwp) ::  ix        !<
+       INTEGER(iwp) ::  j         !<
+       INTEGER(iwp) ::  k         !<
+       INTEGER(iwp) ::  ngp       !<
+       INTEGER(iwp) ::  sr        !<
+       INTEGER(iwp) ::  type_xz_2 !<
+
+       REAL(wp) ::  cim    !<
+       REAL(wp) ::  cimf   !<
+       REAL(wp) ::  cip    !<
+       REAL(wp) ::  cipf   !<
+       REAL(wp) ::  d_new  !<
+       REAL(wp) ::  denomi !< denominator
+       REAL(wp) ::  fminus !<
+       REAL(wp) ::  fplus  !<
+       REAL(wp) ::  f2     !<
+       REAL(wp) ::  f4     !<
+       REAL(wp) ::  f8     !<
+       REAL(wp) ::  f12    !<
+       REAL(wp) ::  f24    !<
+       REAL(wp) ::  f48    !<
+       REAL(wp) ::  f1920  !<
+       REAL(wp) ::  im     !<
+       REAL(wp) ::  ip     !<
+       REAL(wp) ::  m2     !<
+       REAL(wp) ::  m3     !<
+       REAL(wp) ::  numera !< numerator
+       REAL(wp) ::  snenn  !<
+       REAL(wp) ::  sterm  !<
+       REAL(wp) ::  tendcy !<
+       REAL(wp) ::  t1     !<
+       REAL(wp) ::  t2     !<
+
+       REAL(wp) ::  fmax(2)   !<
+       REAL(wp) ::  fmax_l(2) !<
        
 #if defined( __nopointer )
-       REAL(wp), DIMENSION(nzb:nzt+1,nysg:nyng,nxlg:nxrg) ::  sk !:
+       REAL(wp), DIMENSION(nzb:nzt+1,nysg:nyng,nxlg:nxrg) ::  sk !<
 #else
        REAL(wp), DIMENSION(:,:,:), POINTER ::  sk
 #endif
 
-       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  a0   !:
-       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  a1   !:
-       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  a12  !:
-       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  a2   !:
-       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  a22  !:
-       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  immb !:
-       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  imme !:
-       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  impb !:
-       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  impe !:
-       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  ipmb !:
-       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  ipme !:
-       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  ippb !:
-       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  ippe !:
+       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  a0   !<
+       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  a1   !<
+       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  a12  !<
+       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  a2   !<
+       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  a22  !<
+       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  immb !<
+       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  imme !<
+       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  impb !<
+       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  impe !<
+       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  ipmb !<
+       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  ipme !<
+       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  ippb !<
+       REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  ippe !<
        
-       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  sk_p !:
+       REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  sk_p !<
 
 #if defined( __nec )
-       REAL(sp) ::  m1n, m1z  !Wichtig: Division !:
-       REAL(sp), DIMENSION(:,:), ALLOCATABLE :: m1, sw !:
+       REAL(sp) ::  m1n, m1z  !Wichtig: Division !<
+       REAL(sp), DIMENSION(:,:), ALLOCATABLE :: m1, sw !<
 #else
        REAL(wp) ::  m1n, m1z