Changeset 1566 for trunk/NEMO/OPA_SRC/DYN/dynspg_oce.F90

Timestamp:

2009-07-31T16:34:08+02:00 (15 years ago)

Author:

rblod

Message:

Cosmetic changes: suppress useless variables and code review of the code changed when suppressing rigid-lid, see ticket #508

File:

• trunk/NEMO/OPA_SRC/DYN/dynspg_oce.F90 (modified) (1 diff)

trunk/NEMO/OPA_SRC/DYN/dynspg_oce.F90

@@ -1 +1 @@
 MODULE dynspg_oce
-   !!----------------------------------------------------------------------
+   !!======================================================================
    !!                       ***  MODULE dynspg_oce  ***
    !!       
-   !! ** Purpose :   Define in memory all the ocean space domain variables
+   !! Ocean dynamics: Define in memory surface pressure gradient variables
+   !!======================================================================
+   !! History :  1.0  !  05-12  (C. Talandier, G. Madec)  Original code
+   !!            3.2  ! 2009-07  (R. Benshila) Suppression of rigid-lid option
    !!----------------------------------------------------------------------
-   !! Modules used
-   USE par_oce          ! ocean parameters
+   USE par_oce        ! ocean parameters
 
    IMPLICIT NONE
    PUBLIC           
-   !!----------------------------------------------------------------------
-   !!  OPA 9.0 , LOCEAN-IPSL (2005) 
-   !! $Id$ 
-   !! This software is governed by the CeCILL licence see modipsl/doc/NEMO_CeCILL.txt 
-   !!----------------------------------------------------------------------
 
-   !! Surface pressure gradient logicals
-   !! ----------------------------------
-#if   defined key_dynspg_exp   ||  defined key_esopa
-   LOGICAL, PUBLIC, PARAMETER ::   lk_dynspg_exp = .TRUE.  !: Explicit free surface flag
+   !                                                       !!! Surface pressure gradient logicals
+#if   defined key_dynspg_exp  ||  defined key_esopa
+   LOGICAL, PUBLIC, PARAMETER ::   lk_dynspg_exp = .TRUE.   !: Explicit free surface flag
 #else
-   LOGICAL, PUBLIC, PARAMETER ::   lk_dynspg_exp = .FALSE. !: Explicit free surface flag
+   LOGICAL, PUBLIC, PARAMETER ::   lk_dynspg_exp = .FALSE.  !: Explicit free surface flag
 #endif
 #if   defined key_dynspg_ts   ||  defined key_esopa
-   LOGICAL, PUBLIC, PARAMETER ::   lk_dynspg_ts  = .TRUE.  !: Free surface with time splitting flag
+   LOGICAL, PUBLIC, PARAMETER ::   lk_dynspg_ts  = .TRUE.   !: Free surface with time splitting flag
 #else
-   LOGICAL, PUBLIC, PARAMETER ::   lk_dynspg_ts  = .FALSE. !: Free surface with time splitting flag
+   LOGICAL, PUBLIC, PARAMETER ::   lk_dynspg_ts  = .FALSE.  !: Free surface with time splitting flag
 #endif
 #if   defined key_dynspg_flt  ||  defined key_esopa
-   LOGICAL, PUBLIC, PARAMETER ::   lk_dynspg_flt = .TRUE.  !: Filtered free surface cst volume flag
+   LOGICAL, PUBLIC, PARAMETER ::   lk_dynspg_flt = .TRUE.   !: Filtered free surface cst volume flag
 #else
-   LOGICAL, PUBLIC, PARAMETER ::   lk_dynspg_flt = .FALSE. !: Filtered free surface cst volume flag
+   LOGICAL, PUBLIC, PARAMETER ::   lk_dynspg_flt = .FALSE.  !: Filtered free surface cst volume flag
 #endif
 
-#if   defined key_dynspg_ts   ||  defined key_vvl   ||  defined key_esopa
-  !! Time splitting variables   ! variables of the explicit barotropic loop
-  !! ------------------------
-     REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: ua_e  , va_e             ! barotropic velocities (after)
-     REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: sshn_e, ssha_e, sshn_b   ! sea surface heigth (now, after, average)
-     REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: hu_e  , hv_e             ! depth arrays for the barotropic solution
-     REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: hur_e , hvr_e            ! inverse of depth arrays 
+!!gm BUG : always required in _ts, only  some of them in vvl
+!    #if   defined key_dynspg_ts   ||   defined key_esopa
+!!gm end
+#if   defined key_dynspg_ts   ||   defined key_vvl   ||   defined key_esopa
+  !                                                                !!! Time splitting scheme (sub-time step variables)
+   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: ua_e  , va_e             ! barotropic velocities (after)
+   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: sshn_e, ssha_e, sshn_b   ! sea surface heigth (now, after, average)
+   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: hu_e  , hv_e             ! now ocean depth ( = Ho+sshn_e )
+   REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: hur_e , hvr_e            ! inverse of the now depth ( = 1/(Ho+sshn_e) )
 #endif
 
    !!----------------------------------------------------------------------
-
+   !! NEMO/OPA 3.2 , LODYC-IPSL  (2009)
+   !! $Id$ 
+   !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt) 
+   !!======================================================================
 END MODULE dynspg_oce