Changeset 11629 for NEMO/branches/2019/ENHANCE-03_closea/src/OCE/DOM/closea.F90

Timestamp:

2019-10-01T18:17:20+02:00 (5 years ago)

Author:

mathiot

Message:

ENHANCE-03_closea: cosmetic changes (ticket #2143)

File:

• NEMO/branches/2019/ENHANCE-03_closea/src/OCE/DOM/closea.F90 (modified) (14 diffs)

NEMO/branches/2019/ENHANCE-03_closea/src/OCE/DOM/closea.F90

@@ -16 +16 @@
    !!----------------------------------------------------------------------
    !!   dom_clo    : read in masks which define closed seas and runoff areas
-   !!   sbc_clo    : Special handling of freshwater fluxes over closed seas
    !!   clo_rnf    : set close sea outflows as river mouths (see sbcrnf)
-   !!   clo_bat    : set to zero a field over closed sea (see domzgr)
+   !!   clo_msk    : set to zero a field over closed sea (see domzgr)
    !!----------------------------------------------------------------------
    USE oce             ! dynamics and tracers
@@ -38 +37 @@
    PUBLIC dom_clo      ! called by domain module
    PUBLIC clo_rnf      ! called by sbcrnf module
-   PUBLIC clo_bat      ! called in domzgr module
+   PUBLIC clo_msk      ! called in domzgr module
 
    LOGICAL, PUBLIC :: ln_maskcs        !: logical to mask all closed sea
@@ -77 +76 @@
       !! ** Action  :   Read mask_cs* fields (if needed) from domain_cfg file and infer
       !!                number of closed seas for each case (glo, rnf, emp) from mask_cs* field.
-      !!                mask_csglo and mask_csgrpglo  : integer values defining mappings from closed seas and associated groups to the open ocean for net fluxes.
+      !!
+      !! ** Output  :   mask_csglo and mask_csgrpglo  : integer values defining mappings from closed seas and associated groups to the open ocean for net fluxes.
       !!                mask_csrnf and mask_csgrprnf  : integer values defining mappings from closed seas and associated groups to a runoff area for downwards flux only.
       !!                mask_csemp and mask_csgrpemp  : integer values defining mappings from closed seas and associated groups to a runoff area for net fluxes.
@@ -107 +107 @@
       END IF
       !
-      l_sbc_clo = .false. ; l_clo_rnf = .false.
-      IF (.NOT. ln_maskcs)                  l_sbc_clo = .true.
-      IF (.NOT. ln_maskcs .AND. ln_clo_rnf) l_clo_rnf = .true.
-      !
       ! read the closed seas masks (if they exist) from domain_cfg file (if it exists)
       ! ------------------------------------------------------------------------------
@@ -119 +115 @@
       !
       IF ( ln_maskcs ) THEN
-         ! not special treatment of closed sea
+         ! closed sea are masked
+         ! no special treatment of closed sea
+         ! no redistribution of emp unbalance over closed sea into river mouth/open ocean
          l_sbc_clo = .false. ; l_clo_rnf = .false.
       ELSE
-         ! special treatment of closed seas
+         ! redistribution of emp unbalance over closed sea into river mouth/open ocean
          l_sbc_clo = .true.
          !
@@ -128 +126 @@
          IF ( ln_clo_rnf) l_clo_rnf = .true.
          !
+         ! closed sea not defined (ie not in the domcfg namelist used to build the domcfg.nc file) are masked 
          IF ( ln_mask_csundef) THEN
-            ! load undef cs mask (1 in undef closed sea)
             CALL alloc_csmask( mask_csundef )
             CALL read_csmask( cn_domcfg, 'mask_csundef', mask_csundef )
-            ! revert the mask for masking in domzgr
+            ! revert the mask for masking of undefined closed seas in domzgr 
+            ! (0 over the undefined closed sea and 1 elsewhere)
             mask_csundef = 1 - mask_csundef
          END IF
          !
-         ! allocate source mask
+         ! allocate source mask for each cases
          CALL alloc_csmask( mask_csglo )
          CALL alloc_csmask( mask_csrnf )
@@ -151 +150 @@
          ncse = MAXVAL( mask_csemp(:,:) ) ; CALL mpp_max( 'closea', ncse )
          !
-         ! allocate closed sea group masks
+         ! allocate closed sea group masks 
+         !(used to defined the target area in case multiple lakes have the same river mouth (great lakes for example)
          CALL alloc_csmask( mask_csgrpglo )
          CALL alloc_csmask( mask_csgrprnf )
@@ -176 +176 @@
       !! ** Action  :   update (p_)mskrnf (set 1 at closed sea outflow)
       !!----------------------------------------------------------------------
-      !!
       !! subroutine parameter
       REAL(wp), DIMENSION(jpi,jpj), INTENT(inout) ::   p_rnfmsk   ! river runoff mask (rnfmsk array)
@@ -192 +191 @@
    END SUBROUTINE clo_rnf
       
-   SUBROUTINE clo_bat( k_top, k_bot, k_mask, cd_prt )
-      !!---------------------------------------------------------------------
-      !!                  ***  ROUTINE clo_bat  ***
+   SUBROUTINE clo_msk( k_top, k_bot, k_mask, cd_prt )
+      !!---------------------------------------------------------------------
+      !!                  ***  ROUTINE clo_msk  ***
       !!                    
       !! ** Purpose :   Suppress closed sea from the domain
       !!
-      !! ** Method  :   Read in closea_mask field (if it exists) from domain_cfg file.
-      !!                Where closea_mask > 0 set first and last ocean level to 0
+      !! ** Method  :   Where closea_mask > 0 set first and last ocean level to 0
       !!                (As currently coded you can't define a closea_mask field in 
       !!                usr_def_zgr).
@@ -205 +203 @@
       !! ** Action  :   set k_top=0 and k_bot=0 over closed seas
       !!----------------------------------------------------------------------
-      !!
       !! subroutine parameter
       INTEGER, DIMENSION(:,:), INTENT(inout) ::   k_top, k_bot   ! ocean first and last level indices
@@ -216 +213 @@
       IF ( lwp ) THEN
          WRITE(numout,*)
-         WRITE(numout,*) 'clo_bat : Suppression closed seas based on ',TRIM(cd_prt),' field.'
+         WRITE(numout,*) 'clo_msk : Suppression closed seas based on ',TRIM(cd_prt),' field.'
          WRITE(numout,*) '~~~~~~~'
          WRITE(numout,*)
@@ -224 +221 @@
       k_bot(:,:) = k_bot(:,:) * k_mask(:,:)
       !!
-   END SUBROUTINE clo_bat
+   END SUBROUTINE clo_msk
 
    SUBROUTINE read_csmask(cd_file, cd_var, k_mskout)
-      !
+      !!---------------------------------------------------------------------
+      !!                  ***  ROUTINE read_csmask  ***
+      !!                    
+      !! ** Purpose : read mask in cd_filec file
+      !!----------------------------------------------------------------------
       ! subroutine parameter
-      CHARACTER(256), INTENT(in   ) :: cd_file, cd_var     ! netcdf file and variable name
-      INTEGER, DIMENSION(:,:), INTENT(inout) :: k_mskout ! output mask variable
+      CHARACTER(256),          INTENT(in   ) :: cd_file, cd_var     ! netcdf file and variable name
+      INTEGER, DIMENSION(:,:), INTENT(  out) :: k_mskout            ! output mask variable
       !
       ! local variables
       INTEGER :: ics                       ! netcdf id
       REAL(wp), DIMENSION(jpi,jpj) :: zdta ! netcdf data
+      !!----------------------------------------------------------------------
       !
       CALL iom_open ( cd_file, ics )
@@ -244 +246 @@
 
    SUBROUTINE alloc_csmask( kmask )
-      !
+      !!---------------------------------------------------------------------
+      !!                  ***  ROUTINE alloc_csmask  ***
+      !!                    
+      !! ** Purpose : allocated cs mask
+      !!----------------------------------------------------------------------
       ! subroutine parameter
       INTEGER, ALLOCATABLE, DIMENSION(:,:), INTENT(inout) :: kmask
@@ -250 +256 @@
       ! local variables
       INTEGER :: ierr
+      !!----------------------------------------------------------------------
       !
       ALLOCATE( kmask(jpi,jpj) , STAT=ierr )