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

Timestamp:

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

Author:

knoop

Message:

Code annotations made doxygen readable

File:

• palm/trunk/SOURCE/init_masks.f90 (modified) (6 diffs)

palm/trunk/SOURCE/init_masks.f90

@@ -1 @@
- SUBROUTINE init_masks
-
+!> @file init_masks.f90
 !--------------------------------------------------------------------------------!
 ! This file is part of PALM.
@@ -20 +19 @@
 ! Current revisions:
 ! -----------------
-! 
+! Code annotations made doxygen readable 
 ! 
 ! Former revisions:
@@ -78 +77 @@
 ! Description:
 ! ------------
-! Initialize masked data output
+!> Initialize masked data output
 !------------------------------------------------------------------------------!
+ SUBROUTINE init_masks
 
     USE arrays_3d,                                                             &
@@ -112 +112 @@
     IMPLICIT NONE
 
-    CHARACTER (LEN=6) ::  var  !:
-    CHARACTER (LEN=7) ::  unit !:
+    CHARACTER (LEN=6) ::  var  !<
+    CHARACTER (LEN=7) ::  unit !<
     
-    CHARACTER (LEN=10), DIMENSION(max_masks,100) ::  do_mask      !:
-    CHARACTER (LEN=10), DIMENSION(max_masks,100) ::  do_mask_user !:
-
-    INTEGER(iwp) ::  i            !: 
-    INTEGER(iwp) ::  ilen         !:
-    INTEGER(iwp) ::  ind(6)       !:
-    INTEGER(iwp) ::  ind_array(1) !:
-    INTEGER(iwp) ::  j            !:
-    INTEGER(iwp) ::  k            !:
-    INTEGER(iwp) ::  n            !:
-    INTEGER(iwp) ::  sender       !:
+    CHARACTER (LEN=10), DIMENSION(max_masks,100) ::  do_mask      !<
+    CHARACTER (LEN=10), DIMENSION(max_masks,100) ::  do_mask_user !<
+
+    INTEGER(iwp) ::  i            !< 
+    INTEGER(iwp) ::  ilen         !<
+    INTEGER(iwp) ::  ind(6)       !<
+    INTEGER(iwp) ::  ind_array(1) !<
+    INTEGER(iwp) ::  j            !<
+    INTEGER(iwp) ::  k            !<
+    INTEGER(iwp) ::  n            !<
+    INTEGER(iwp) ::  sender       !<
     
-    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  tmp_array !:
-
-    LOGICAL ::  found !:
+    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  tmp_array !<
+
+    LOGICAL ::  found !<
 !
 !-- Allocation and initialization
@@ -526 +526 @@
           CALL MPI_BCAST( mask_k_global(mid,:), nz+2, MPI_INTEGER, 0, comm2d, &
                           ierr ) 
-          
+     
        ENDIF
 
@@ -546 +546 @@
  CONTAINS
 
+!------------------------------------------------------------------------------!
+! Description:
+! ------------
+!> Set local mask for each subdomain along 'dim' direction.
+!------------------------------------------------------------------------------!
     SUBROUTINE set_mask_locations( dim, dxyz, dxyz_string, nxyz, nxyz_string, &
                                    lb, ub )
-!------------------------------------------------------------------------------!
-!
-! Description:
-! ------------
-! Set local mask for each subdomain along 'dim' direction.
-!------------------------------------------------------------------------------!
 
        IMPLICIT NONE
 
-       CHARACTER (LEN=2) ::  dxyz_string !:
-       CHARACTER (LEN=2) ::  nxyz_string !:
+       CHARACTER (LEN=2) ::  dxyz_string !<
+       CHARACTER (LEN=2) ::  nxyz_string !<
        
-       INTEGER(iwp)  ::  count       !:
-       INTEGER(iwp)  ::  count_l     !:
-       INTEGER(iwp)  ::  dim         !:
-       INTEGER(iwp)  ::  m           !:
-       INTEGER(iwp)  ::  loop_begin  !:
-       INTEGER(iwp)  ::  loop_end    !:
-       INTEGER(iwp)  ::  loop_stride !:
-       INTEGER(iwp)  ::  lb          !:
-       INTEGER(iwp)  ::  nxyz        !:
-       INTEGER(iwp)  ::  ub          !:
+       INTEGER(iwp)  ::  count       !<
+       INTEGER(iwp)  ::  count_l     !<
+       INTEGER(iwp)  ::  dim         !<
+       INTEGER(iwp)  ::  m           !<
+       INTEGER(iwp)  ::  loop_begin  !<
+       INTEGER(iwp)  ::  loop_end    !<
+       INTEGER(iwp)  ::  loop_stride !<
+       INTEGER(iwp)  ::  lb          !<
+       INTEGER(iwp)  ::  nxyz        !<
+       INTEGER(iwp)  ::  ub          !<
        
-       REAL(wp)      ::  dxyz  !:
-       REAL(wp)      ::  ddxyz !:
-       REAL(wp)      ::  tmp1  !:
-       REAL(wp)      ::  tmp2  !:
+       REAL(wp)      ::  dxyz  !<
+       REAL(wp)      ::  ddxyz !<
+       REAL(wp)      ::  tmp1  !<
+       REAL(wp)      ::  tmp2  !<
 
        count = 0;  count_l = 0