Changeset 1601 for trunk/NEMO/OPA_SRC/LDF/ldftra_oce.F90

Timestamp:

2009-08-11T12:09:19+02:00 (15 years ago)

Author:

ctlod

Message:

Doctor naming of OPA namelist variables , see ticket: #526

File:

• trunk/NEMO/OPA_SRC/LDF/ldftra_oce.F90 (modified) (4 diffs)

trunk/NEMO/OPA_SRC/LDF/ldftra_oce.F90

@@ -4 +4 @@
    !! Ocean physics :  lateral tracer mixing coefficient defined in memory 
    !!=====================================================================
-   !!
-   !! ** Purpose : - Define in memory lateral tracer mixing coefficients
-   !!
-   !! History :
-   !!   9.0  !  02-11  (G. Madec)  Original code (from common.h)
+   !! History :  9.0  !  02-11  (G. Madec)  Original code
    !!----------------------------------------------------------------------
-   !!  OPA 9.0 , LOCEAN-IPSL (2005) 
-   !! $Id$ 
-   !! This software is governed by the CeCILL licence see modipsl/doc/NEMO_CeCILL.txt 
-   !!----------------------------------------------------------------------
-   !! * Modules used
    USE par_oce         ! ocean parameters
 
@@ -23 +14 @@
    !! Lateral eddy diffusivity coefficients (tracers)
    !!----------------------------------------------------------------------
+   !                                                !!* Namelist namtra_ldf : lateral mixing *
+   LOGICAL , PUBLIC ::   ln_traldf_lap   = .TRUE.    !: laplacian operator
+   LOGICAL , PUBLIC ::   ln_traldf_bilap = .FALSE.   !: bilaplacian operator
+   LOGICAL , PUBLIC ::   ln_traldf_level = .FALSE.   !: iso-level direction
+   LOGICAL , PUBLIC ::   ln_traldf_hor   = .FALSE.   !: horizontal (geopotential) direction
+   LOGICAL , PUBLIC ::   ln_traldf_iso   = .TRUE.    !: iso-neutral direction
+   REAL(wp), PUBLIC ::   rn_aht_0        = 2000._wp  !: lateral eddy diffusivity (m2/s)
+   REAL(wp), PUBLIC ::   rn_ahtb_0       =    0._wp  !: lateral background eddy diffusivity (m2/s)
+   REAL(wp), PUBLIC ::   rn_aeiv_0       = 2000._wp  !: eddy induced velocity coefficient (m2/s)
 
-   LOGICAL , PUBLIC ::              & !!: ** lateral mixing namelist (nam_traldf) **
-      ln_traldf_lap   = .TRUE.  ,   &  !: laplacian operator
-      ln_traldf_bilap = .FALSE. ,   &  !: bilaplacian operator
-      ln_traldf_level = .FALSE. ,   &  !: iso-level direction
-      ln_traldf_hor   = .FALSE. ,   &  !: horizontal (geopotential) direction
-      ln_traldf_iso   = .TRUE.         !: iso-neutral direction
-
-   REAL(wp), PUBLIC ::              & !!: ** lateral mixing namelist (namldf) **
-      aht0  = 2000._wp     ,        &  !: lateral eddy diffusivity (m2/s)
-      ahtb0 =    0._wp     ,        &  !: lateral background eddy diffusivity (m2/s)
-      aeiv0 = 2000._wp                 !: eddy induced velocity coefficient (m2/s)
+   REAL(wp), PUBLIC ::   aht0, ahtb0, aeiv0         !!: OLD namelist names
 
 #if defined key_traldf_c3d
-   REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) ::   &  !: ** 3D coefficients **
+   REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) ::   ahtt, ahtu, ahtv, ahtw   !: ** 3D coefficients ** at T-, U-, V-, W-points
 #elif defined key_traldf_c2d
-   REAL(wp), PUBLIC, DIMENSION(jpi,jpj)     ::   &  !: ** 2D coefficients **
+   REAL(wp), PUBLIC, DIMENSION(jpi,jpj)     ::   ahtt, ahtu, ahtv, ahtw   !: ** 2D coefficients ** at T-, U-, V-, W-points
 #elif defined key_traldf_c1d
-   REAL(wp), PUBLIC, DIMENSION(jpk)         ::   &  !: ** 1D coefficients **
+   REAL(wp), PUBLIC, DIMENSION(jpk)         ::   ahtt, ahtu, ahtv, ahtw   !: ** 1D coefficients ** at T-, U-, V-, W-points
 #else
-   REAL(wp), PUBLIC                         ::   &  !: ** 0D coefficients **
+   REAL(wp), PUBLIC                         ::   ahtt, ahtu, ahtv, ahtw   !: ** 0D coefficients ** at T-, U-, V-, W-points
 #endif
-      ahtt, ahtu, ahtv, ahtw                !: T-, U-, V-, W-points coefficients
 
 
@@ -55 +44 @@
       
 # if defined key_traldf_c3d
-   REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) ::   &  !: ** 3D coefficients **
+   REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) ::   aeiu, aeiv, aeiw  !: ** 3D coefficients ** at U-, V-, W-points  [m2/s]
 # elif defined key_traldf_c2d
-   REAL(wp), PUBLIC, DIMENSION(jpi,jpj)     ::   &  !: ** 2D coefficients **
+   REAL(wp), PUBLIC, DIMENSION(jpi,jpj)     ::   aeiu, aeiv, aeiw  !: ** 2D coefficients ** at U-, V-, W-points  [m2/s]
 # elif defined key_traldf_c1d
-   REAL(wp), PUBLIC, DIMENSION(jpk)         ::   &  !: ** 1D coefficients **
+   REAL(wp), PUBLIC, DIMENSION(jpk)         ::   aeiu, aeiv, aeiw  !: ** 1D coefficients ** at U-, V-, W-points  [m2/s]
 # else
-   REAL(wp), PUBLIC                         ::   &  !: ** 0D coefficients **
+   REAL(wp), PUBLIC                         ::   aeiu, aeiv, aeiw  !: ** 0D coefficients ** at U-, V-, W-points  [m2/s]
 # endif
-      aeiu, aeiv, aeiw                              !: U-, V-, W-points  induced velocity coef. (m2/s)
-
 # if defined key_diaeiv
-   REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) ::    &  !:
-      u_eiv, v_eiv, w_eiv     !: The three component of the eddy induced velocity (m/s)
+   REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk) ::   u_eiv, v_eiv, w_eiv   !: eddy induced velocity [m/s]
 # endif
 
@@ -75 +61 @@
    !!----------------------------------------------------------------------
    LOGICAL , PUBLIC, PARAMETER ::   lk_traldf_eiv   = .FALSE.   !: eddy induced velocity flag
-   REAL(wp), PUBLIC ::   aeiu, aeiv, aeiw
+   REAL(wp), PUBLIC            ::   aeiu, aeiv, aeiw            !: eddy induced coef. (not used)
 #endif
 
    !!----------------------------------------------------------------------
+   !! NEMO/OPA 3.2 , LOCEAN-IPSL (2009) 
+   !! $Id$ 
+   !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt)
+   !!=====================================================================
 END MODULE ldftra_oce