Changeset 1408 for branches/dev_004_VVL/NEMO/OPA_SRC/DYN/dynspg_flt.F90

Timestamp:

2009-04-17T11:59:49+02:00 (15 years ago)

Author:

rblod

Message:

dev_004_VVL: cosmetic changes and code review

File:

• branches/dev_004_VVL/NEMO/OPA_SRC/DYN/dynspg_flt.F90 (modified) (10 diffs)

branches/dev_004_VVL/NEMO/OPA_SRC/DYN/dynspg_flt.F90

@@ -4 +4 @@
    !! Ocean dynamics:  surface pressure gradient trend
    !!======================================================================
-   !! History    8.0  !  98-05  (G. Roullet)  free surface
-   !!                 !  98-10  (G. Madec, M. Imbard)  release 8.2
-   !!            8.5  !  02-08  (G. Madec)  F90: Free form and module
-   !!            " "  !  02-11  (C. Talandier, A-M Treguier) Open boundaries
-   !!            9.0  !  04-08  (C. Talandier) New trends organization
-   !!            " "  !  05-11  (V. Garnier) Surface pressure gradient organization
-   !!            " "  !  06-07  (S. Masson)  distributed restart using iom
-   !!            " "  !  05-01  (J.Chanut, A.Sellar) Calls to BDY routines. 
+   !! History    OPA  !  1998-05  (G. Roullet)  free surface
+   !!                 !  1998-10  (G. Madec, M. Imbard)  release 8.2
+   !!   NEMO     O.1  !  2002-08  (G. Madec)  F90: Free form and module
+   !!             -   !  2002-11  (C. Talandier, A-M Treguier) Open boundaries
+   !!            1.0  !  2004-08  (C. Talandier) New trends organization
+   !!             -   !  2005-11  (V. Garnier) Surface pressure gradient organization
+   !!            2.0  !  2006-07  (S. Masson)  distributed restart using iom
+   !!             -   !  2006-08  (J.Chanut, A.Sellar) Calls to BDY routines. 
+   !!            3.2  !  2009-03  (G. Madec, M. Leclair, R. Benshila) introduce sshwzv module
    !!----------------------------------------------------------------------
 #if defined key_dynspg_flt   ||   defined key_esopa  
    !!----------------------------------------------------------------------
    !!   'key_dynspg_flt'                              filtered free surface
-   !!----------------------------------------------------------------------
    !!----------------------------------------------------------------------
    !!   dyn_spg_flt  : update the momentum trend with the surface pressure
@@ -53 +53 @@
    PRIVATE
 
-   PUBLIC dyn_spg_flt  ! routine called by step.F90
-   PUBLIC flt_rst      ! routine called by istate.F90
+   PUBLIC   dyn_spg_flt  ! routine called by step.F90
+   PUBLIC   flt_rst      ! routine called by istate.F90
 
    !! * Substitutions
@@ -60 +60 @@
 #  include "vectopt_loop_substitute.h90"
    !!----------------------------------------------------------------------
-   !!   OPA 9.0 , LOCEAN-IPSL (2005) 
+   !! NEMO/OPA 3.2 , LOCEAN-IPSL (2009) 
    !! $Id$
    !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt) 
@@ -80 +80 @@
       !!         spgv = 1/rau0 d/dy(ps) =  1/e2v dj( sshn + rnu btda )
       !!      where sshn is the free surface elevation and btda is the after
-      !!      of the free surface elevation
+      !!      time derivative of the free surface elevation
       !!       -1- evaluate the surface presure trend (including the addi-
       !!      tional force) in three steps:
@@ -104 +104 @@
       !! References : Roullet and Madec 1999, JGR.
       !!---------------------------------------------------------------------
-      !! * Modules used
-      USE oce    , ONLY :   zub   => ta,             &  ! ta used as workspace
-                            zvb   => sa                 ! sa   "          "
-
-      INTEGER, INTENT( in )  ::   kt         ! ocean time-step index
-      INTEGER, INTENT( out ) ::   kindic     ! solver convergence flag (<0 if not converge)
+      USE oce, ONLY :   zub   => ta   ! ta used as workspace
+      USE oce, ONLY :   zvb   => sa   ! ta used as workspace
+      !!
+      INTEGER, INTENT( in )  ::   kt       ! ocean time-step index
+      INTEGER, INTENT( out ) ::   kindic   ! solver convergence flag (<0 if not converge)
       !!                                   
       INTEGER  ::   ji, jj, jk                          ! dummy loop indices
-      REAL(wp) ::   z2dt, z2dtg, zraur, znugdt,      &  ! temporary scalars
-         &          znurau, zgcb, zbtd,              &  !   "          "
-         &          ztdgu, ztdgv                        !   "          "
+      REAL(wp) ::   z2dt, z2dtg, zraur, znugdt          ! temporary scalars
+      REAL(wp) ::   znurau, zgcb, zbtd                  !   "          "
+      REAL(wp) ::   ztdgu, ztdgv                        !   "          "
       !!----------------------------------------------------------------------
       !
@@ -130 +129 @@
          ! when using agrif, sshn, gcx have to be read in istate
          IF (.NOT. lk_agrif) CALL flt_rst( nit000, 'READ' )       ! read or initialize the following fields:
-         !                                                        ! gcx, gcxb, sshb, sshn
+         !                                                        ! gcx, gcxb
       ENDIF
 
@@ -354 +353 @@
          DO jj = 2, jpjm1
             DO ji = fs_2, fs_jpim1   ! vector opt.
-               ua(ji,jj,jk) = (ua(ji,jj,jk) + spgu(ji,jj)) * umask(ji,jj,jk)
-               va(ji,jj,jk) = (va(ji,jj,jk) + spgv(ji,jj)) * vmask(ji,jj,jk)
+               ua(ji,jj,jk) = ( ua(ji,jj,jk) + spgu(ji,jj) ) * umask(ji,jj,jk)
+               va(ji,jj,jk) = ( va(ji,jj,jk) + spgv(ji,jj) ) * vmask(ji,jj,jk)
             END DO
          END DO
@@ -363 +362 @@
       ! --------------------------------------------------
       IF( lrst_oce ) CALL flt_rst( kt, 'WRITE' )
-
-      ! print sum trends (used for debugging)
-      IF(ln_ctl)     CALL prt_ctl( tab2d_1=sshn, clinfo1=' spg  - ssh: ', mask1=tmask )
       !
    END SUBROUTINE dyn_spg_flt
@@ -386 +382 @@
            CALL iom_get( numror, jpdom_autoglo, 'gcx' , gcx (1:jpi,1:jpj) )
            CALL iom_get( numror, jpdom_autoglo, 'gcxb', gcxb(1:jpi,1:jpj) )
-           IF( neuler == 0 ) THEN
-              gcxb(:,:) = gcx (:,:)
-           ENDIF
+           IF( neuler == 0 )   gcxb(:,:) = gcx (:,:)
         ELSE
            gcx (:,:) = 0.e0
@@ -396 +390 @@
 ! Caution : extra-hallow
 ! gcx and gcxb are defined as: DIMENSION(1-jpr2di:jpi+jpr2di,1-jpr2dj:jpj+jpr2dj)
-        CALL iom_rstput( kt, nitrst, numrow, 'gcx' , gcx( 1:jpi,1:jpj) )
+        CALL iom_rstput( kt, nitrst, numrow, 'gcx' , gcx (1:jpi,1:jpj) )
         CALL iom_rstput( kt, nitrst, numrow, 'gcxb', gcxb(1:jpi,1:jpj) )
      ENDIF