Changeset 1682 for palm/trunk/SOURCE/init_1d_model.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_1d_model.f90 (modified) (12 diffs)

palm/trunk/SOURCE/init_1d_model.f90

@@ -1 @@
- SUBROUTINE init_1d_model
-
+!> @file init_1d_model.f90
 !--------------------------------------------------------------------------------!
 ! This file is part of PALM.
@@ -20 +19 @@
 ! Current revisions:
 ! -----------------
-! 
+! Code annotations made doxygen readable 
 ! 
 ! Former revisions:
@@ -66 +65 @@
 ! Description:
 ! ------------
-! 1D-model to initialize the 3D-arrays.
-! The temperature profile is set as steady and a corresponding steady solution 
-! of the wind profile is being computed.
-! All subroutines required can be found within this file.
+!> 1D-model to initialize the 3D-arrays.
+!> The temperature profile is set as steady and a corresponding steady solution 
+!> of the wind profile is being computed.
+!> All subroutines required can be found within this file.
 !------------------------------------------------------------------------------!
+ SUBROUTINE init_1d_model
+ 
 
     USE arrays_3d,                                                             &
@@ -93 +94 @@
     IMPLICIT NONE
 
-    CHARACTER (LEN=9) ::  time_to_string  !:
-    
-    INTEGER(iwp) ::  k  !: 
-    
-    REAL(wp) ::  lambda !:
+    CHARACTER (LEN=9) ::  time_to_string  !<
+    
+    INTEGER(iwp) ::  k  !< 
+    
+    REAL(wp) ::  lambda !<
 
 !
@@ -196 +197 @@
 
 
- SUBROUTINE time_integration_1d
-
 !------------------------------------------------------------------------------!
 ! Description:
 ! ------------
-! Leap-frog time differencing scheme for the 1D-model.
+!> Leap-frog time differencing scheme for the 1D-model.
 !------------------------------------------------------------------------------!
+ 
+ SUBROUTINE time_integration_1d
+
 
     USE arrays_3d,                                                             &
@@ -231 +233 @@
     IMPLICIT NONE
 
-    CHARACTER (LEN=9) ::  time_to_string  !:
-    
-    INTEGER(iwp) ::  k  !:
-    
-    REAL(wp) ::  a            !:
-    REAL(wp) ::  b            !:
-    REAL(wp) ::  dissipation  !:
-    REAL(wp) ::  dpt_dz       !:
-    REAL(wp) ::  flux         !:
-    REAL(wp) ::  kmzm         !:
-    REAL(wp) ::  kmzp         !:
-    REAL(wp) ::  l_stable     !:
-    REAL(wp) ::  pt_0         !:
-    REAL(wp) ::  uv_total     !:
+    CHARACTER (LEN=9) ::  time_to_string  !<
+    
+    INTEGER(iwp) ::  k  !<
+    
+    REAL(wp) ::  a            !<
+    REAL(wp) ::  b            !<
+    REAL(wp) ::  dissipation  !<
+    REAL(wp) ::  dpt_dz       !<
+    REAL(wp) ::  flux         !<
+    REAL(wp) ::  kmzm         !<
+    REAL(wp) ::  kmzp         !<
+    REAL(wp) ::  l_stable     !<
+    REAL(wp) ::  pt_0         !<
+    REAL(wp) ::  uv_total     !<
 
 !
@@ -741 +743 @@
 
 
- SUBROUTINE run_control_1d
-
 !------------------------------------------------------------------------------!
 ! Description:
 ! ------------
-! Compute and print out quantities for run control of the 1D model.
+!> Compute and print out quantities for run control of the 1D model.
 !------------------------------------------------------------------------------!
+ 
+ SUBROUTINE run_control_1d
+
 
     USE constants,                                                             &
@@ -768 +771 @@
     IMPLICIT NONE
 
-    INTEGER(iwp) ::  k  !:
+    INTEGER(iwp) ::  k  !<
     
     REAL(wp) ::  alpha 
@@ -828 +831 @@
 
 
- SUBROUTINE timestep_1d
-
 !------------------------------------------------------------------------------!
 ! Description:
 ! ------------
-! Compute the time step w.r.t. the diffusion criterion
+!> Compute the time step w.r.t. the diffusion criterion
 !------------------------------------------------------------------------------!
+ 
+ SUBROUTINE timestep_1d
+
 
     USE arrays_3d,                                                             &
@@ -854 +858 @@
     IMPLICIT NONE
 
-    INTEGER(iwp) ::  k !:
-    
-    REAL(wp) ::  div      !:
-    REAL(wp) ::  dt_diff  !:
-    REAL(wp) ::  fac      !:
-    REAL(wp) ::  value    !:
+    INTEGER(iwp) ::  k !<
+    
+    REAL(wp) ::  div      !<
+    REAL(wp) ::  dt_diff  !<
+    REAL(wp) ::  fac      !<
+    REAL(wp) ::  value    !<
 
 
@@ -901 +905 @@
 
 
- SUBROUTINE print_1d_model
-
 !------------------------------------------------------------------------------!
 ! Description:
 ! ------------
-! List output of profiles from the 1D-model
+!> List output of profiles from the 1D-model
 !------------------------------------------------------------------------------!
+ 
+ SUBROUTINE print_1d_model
+
 
     USE arrays_3d,                                                             &
@@ -928 +933 @@
 
 
-    INTEGER(iwp) ::  k  !:
+    INTEGER(iwp) ::  k  !<