source: NEMO/trunk/tests/ICE_AGRIF/MY_SRC/usrdef_zgr.F90 @ 10516

Last change on this file since 10516 was 10516, checked in by clem, 19 months ago

change demo config name from ICEDYN to ICE_AGRIF

  • Property svn:keywords set to Id
File size: 5.2 KB
Line 
1MODULE usrdef_zgr
2   !!======================================================================
3   !!                   ***  MODULE  usrdef_zgr  ***
4   !!
5   !!                   ===      ICE_AGRIF case     ===
6   !!
7   !! Ocean domain : user defined vertical coordinate system
8   !!======================================================================
9   !! History :  4.0  ! 2016-08  (G. Madec, S. Flavoni)  Original code
10   !!----------------------------------------------------------------------
11
12   !!----------------------------------------------------------------------
13   !!   usr_def_zgr   : user defined vertical coordinate system (required)
14   !!---------------------------------------------------------------------
15   USE oce            ! ocean variables
16   USE usrdef_nam     ! User defined : namelist variables
17   !
18   USE in_out_manager ! I/O manager
19   USE lbclnk         ! ocean lateral boundary conditions (or mpp link)
20   USE lib_mpp        ! distributed memory computing library
21
22   IMPLICIT NONE
23   PRIVATE
24
25   PUBLIC   usr_def_zgr   ! called by domzgr.F90
26
27  !! * Substitutions
28#  include "vectopt_loop_substitute.h90"
29   !!----------------------------------------------------------------------
30   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
31   !! $Id$
32   !! Software governed by the CeCILL license (see ./LICENSE)
33   !!----------------------------------------------------------------------
34CONTAINS             
35
36   SUBROUTINE usr_def_zgr( ld_zco  , ld_zps  , ld_sco  , ld_isfcav,    &   ! type of vertical coordinate
37      &                    pdept_1d, pdepw_1d, pe3t_1d , pe3w_1d  ,    &   ! 1D reference vertical coordinate
38      &                    pdept , pdepw ,                             &   ! 3D t & w-points depth
39      &                    pe3t  , pe3u  , pe3v , pe3f ,               &   ! vertical scale factors
40      &                    pe3w  , pe3uw , pe3vw,                      &   !     -      -      -
41      &                    k_top  , k_bot    )                             ! top & bottom ocean level
42      !!---------------------------------------------------------------------
43      !!              ***  ROUTINE usr_def_zgr  ***
44      !!
45      !! ** Purpose :   User defined the vertical coordinates
46      !!
47      !!----------------------------------------------------------------------
48      LOGICAL                   , INTENT(out) ::   ld_zco, ld_zps, ld_sco      ! vertical coordinate flags
49      LOGICAL                   , INTENT(out) ::   ld_isfcav                   ! under iceshelf cavity flag
50      REAL(wp), DIMENSION(:)    , INTENT(out) ::   pdept_1d, pdepw_1d          ! 1D grid-point depth     [m]
51      REAL(wp), DIMENSION(:)    , INTENT(out) ::   pe3t_1d , pe3w_1d           ! 1D grid-point depth     [m]
52      REAL(wp), DIMENSION(:,:,:), INTENT(out) ::   pdept, pdepw                ! grid-point depth        [m]
53      REAL(wp), DIMENSION(:,:,:), INTENT(out) ::   pe3t , pe3u , pe3v , pe3f   ! vertical scale factors  [m]
54      REAL(wp), DIMENSION(:,:,:), INTENT(out) ::   pe3w , pe3uw, pe3vw         ! i-scale factors
55      INTEGER , DIMENSION(:,:)  , INTENT(out) ::   k_top, k_bot                ! first & last ocean level
56      !
57      INTEGER  ::   jk, k_dz  ! dummy indices
58      !!----------------------------------------------------------------------
59      !
60      IF(lwp) WRITE(numout,*)
61      IF(lwp) WRITE(numout,*) 'usr_def_zgr : ICE_AGRIF configuration '
62      IF(lwp) WRITE(numout,*) '~~~~~~~~~~~   (slab ocean - advection of an ice patch in a biperiodic square box domain)'
63      !
64      !
65      ! type of vertical coordinate  ==>>>   here ICE_AGRIF : slab ocean always
66      ! ---------------------------
67      ld_zco    = .TRUE.       ! z-full-step coordinate
68      ld_zps    = .FALSE.      ! z-partial-step coordinate
69      ld_sco    = .FALSE.      ! s-coordinate
70      ld_isfcav = .FALSE.      ! ISF Ice Shelves Flag
71      !
72      !
73      ! Build the vertical coordinate system
74      ! ------------------------------------
75      !
76      !                       !==  UNmasked meter bathymetry  ==!
77      !
78      !
79      k_dz = 1
80      DO jk = 1, jpk
81         pdepw_1d(jk) =    k_dz
82         pdept_1d(jk) =    k_dz
83         pe3w_1d (jk) =    k_dz
84         pe3t_1d (jk) =    k_dz
85      END DO
86      !                       !==  top masked level bathymetry  ==!  (all coordinates)
87      !
88      ! no ocean cavities : top ocean level is ONE, except over land
89      k_top(:,:) = 1
90      !
91      !                       !==  z-coordinate  ==!   (step-like topography)
92      !                                !* bottom ocean compute from the depth of grid-points
93      jpkm1 = jpk
94      k_bot(:,:) = 1    ! here use k_top as a land mask
95      !                                !* horizontally uniform coordinate (reference z-co everywhere)
96      DO jk = 1, jpk
97         pdept(:,:,jk) = pdept_1d(jk)
98         pdepw(:,:,jk) = pdepw_1d(jk)
99         pe3t (:,:,jk) = pe3t_1d (jk)
100         pe3u (:,:,jk) = pe3t_1d (jk)
101         pe3v (:,:,jk) = pe3t_1d (jk)
102         pe3f (:,:,jk) = pe3t_1d (jk)
103         pe3w (:,:,jk) = pe3w_1d (jk)
104         pe3uw(:,:,jk) = pe3w_1d (jk)
105         pe3vw(:,:,jk) = pe3w_1d (jk)
106      END DO
107      !
108   END SUBROUTINE usr_def_zgr
109
110   !!======================================================================
111END MODULE usrdef_zgr
Note: See TracBrowser for help on using the repository browser.