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

Timestamp:

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

Author:

knoop

Message:

Code annotations made doxygen readable

File:

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

palm/trunk/SOURCE/prognostic_equations.f90

@@ -1 @@
- MODULE prognostic_equations_mod
-
+!> @file prognostic_equations.f90
 !--------------------------------------------------------------------------------!
 ! This file is part of PALM.
@@ -20 +19 @@
 ! Current revisions:
 ! ------------------
-! 
+! Code annotations made doxygen readable 
 ! 
 ! Former revisions:
@@ -161 +160 @@
 ! Description:
 ! ------------
-! Solving the prognostic equations.
+!> Solving the prognostic equations.
 !------------------------------------------------------------------------------!
+ MODULE prognostic_equations_mod
+
+ 
 
     USE arrays_3d,                                                             &
@@ -313 +315 @@
 
 
+!------------------------------------------------------------------------------!
+! Description:
+! ------------
+!> Version with one optimized loop over all equations. It is only allowed to
+!> be called for the Wicker and Skamarock or Piascek-Williams advection scheme.
+!>
+!> Here the calls of most subroutines are embedded in two DO loops over i and j,
+!> so communication between CPUs is not allowed (does not make sense) within
+!> these loops.
+!>
+!> (Optimized to avoid cache missings, i.e. for Power4/5-architectures.)
+!------------------------------------------------------------------------------!
+ 
  SUBROUTINE prognostic_equations_cache
 
-!------------------------------------------------------------------------------!
-! Version with one optimized loop over all equations. It is only allowed to
-! be called for the Wicker and Skamarock or Piascek-Williams advection scheme.
-!
-! Here the calls of most subroutines are embedded in two DO loops over i and j,
-! so communication between CPUs is not allowed (does not make sense) within
-! these loops.
-!
-! (Optimized to avoid cache missings, i.e. for Power4/5-architectures.)
-!------------------------------------------------------------------------------!
 
     IMPLICIT NONE
 
-    INTEGER(iwp) ::  i                   !:
-    INTEGER(iwp) ::  i_omp_start         !:
-    INTEGER(iwp) ::  j                   !:
-    INTEGER(iwp) ::  k                   !:
-    INTEGER(iwp) ::  omp_get_thread_num  !:
-    INTEGER(iwp) ::  tn = 0              !:
+    INTEGER(iwp) ::  i                   !<
+    INTEGER(iwp) ::  i_omp_start         !<
+    INTEGER(iwp) ::  j                   !<
+    INTEGER(iwp) ::  k                   !<
+    INTEGER(iwp) ::  omp_get_thread_num  !<
+    INTEGER(iwp) ::  tn = 0              !<
     
-    LOGICAL      ::  loop_start          !:
+    LOGICAL      ::  loop_start          !<
 
 
@@ -934 +939 @@
 
 
+!------------------------------------------------------------------------------!
+! Description:
+! ------------
+!> Version for vector machines
+!------------------------------------------------------------------------------!
+ 
  SUBROUTINE prognostic_equations_vector
 
-!------------------------------------------------------------------------------!
-! Version for vector machines
-!------------------------------------------------------------------------------!
 
     IMPLICIT NONE
 
-    INTEGER(iwp) ::  i    !:
-    INTEGER(iwp) ::  j    !:
-    INTEGER(iwp) ::  k    !:
-
-    REAL(wp)     ::  sbt  !:
+    INTEGER(iwp) ::  i    !<
+    INTEGER(iwp) ::  j    !<
+    INTEGER(iwp) ::  k    !<
+
+    REAL(wp)     ::  sbt  !<
 
 
@@ -1767 +1775 @@
 
 
+!------------------------------------------------------------------------------!
+! Description:
+! ------------
+!> Version for accelerator boards
+!------------------------------------------------------------------------------!
+ 
  SUBROUTINE prognostic_equations_acc
 
-!------------------------------------------------------------------------------!
-! Version for accelerator boards
-!------------------------------------------------------------------------------!
 
     IMPLICIT NONE
 
-    INTEGER(iwp) ::  i           !:
-    INTEGER(iwp) ::  j           !:
-    INTEGER(iwp) ::  k           !:
-    INTEGER(iwp) ::  runge_step  !:
-
-    REAL(wp)     ::  sbt         !:
+    INTEGER(iwp) ::  i           !<
+    INTEGER(iwp) ::  j           !<
+    INTEGER(iwp) ::  k           !<
+    INTEGER(iwp) ::  runge_step  !<
+
+    REAL(wp)     ::  sbt         !<
 
 !