New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
zdfini.F90 in branches/UKMO/r6232_INGV1_WAVE-coupling/NEMOGCM/NEMO/OPA_SRC/ZDF – NEMO

source: branches/UKMO/r6232_INGV1_WAVE-coupling/NEMOGCM/NEMO/OPA_SRC/ZDF/zdfini.F90 @ 7471

Last change on this file since 7471 was 7471, checked in by jcastill, 7 years ago

Version as merged to the trunk during the Nov-2016 merge party, equivalent to branches/UKMO/r5936_INGV1_WAVE-coupling@7360
File size: 9.4 KB
Line 
1MODULE zdfini
2   !!======================================================================
3   !!                      ***  MODULE  zdfini  ***
4   !! Ocean physics :   read vertical mixing namelist and check consistancy
5   !!======================================================================
6   !! History :  8.0  ! 1997-06  (G. Madec)  Original code from inimix
7   !!            1.0  ! 2002-08  (G. Madec)  F90 : free form
8   !!             -   ! 2005-06  (C. Ethe) KPP parameterization
9   !!             -   ! 2009-07  (G. Madec) add avmb, avtb in restart for cen2 advection
10   !!----------------------------------------------------------------------
11
12   !!----------------------------------------------------------------------
13   !!   zdf_init    : initialization, namelist read, and parameters control
14   !!----------------------------------------------------------------------
15   USE par_oce         ! mesh and scale factors
16   USE ldftra_oce      ! ocean active tracers: lateral physics
17   USE ldfdyn_oce      ! ocean dynamics lateral physics
18   USE zdf_oce         ! TKE vertical mixing         
19   USE lib_mpp         ! distribued memory computing
20   USE zdftke          ! TKE vertical mixing
21   USE zdfgls          ! GLS vertical mixing
22   USE zdfkpp          ! KPP vertical mixing         
23   USE zdfddm          ! double diffusion mixing     
24   USE zdfevd          ! enhanced vertical diffusion 
25   USE zdfric          ! Richardson vertical mixing   
26   USE tranpc          ! convection: non penetrative adjustment
27   USE ldfslp          ! iso-neutral slopes
28
29   USE in_out_manager  ! I/O manager
30   USE iom             ! IOM library
31
32   IMPLICIT NONE
33   PRIVATE
34
35   PUBLIC   zdf_init   ! routine called by opa.F90
36   
37   !!----------------------------------------------------------------------
38   !! NEMO/OPA 4.0 , NEMO Consortium (2011)
39   !! $Id$
40   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
41   !!----------------------------------------------------------------------
42CONTAINS
43
44   SUBROUTINE zdf_init
45      !!----------------------------------------------------------------------
46      !!                  ***  ROUTINE zdf_init  ***
47      !!
48      !! ** Purpose :   initializations of the vertical ocean physics
49      !!
50      !! ** Method  :   Read namelist namzdf, control logicals
51      !!----------------------------------------------------------------------
52      INTEGER ::   ioptio       ! temporary scalar
53      INTEGER ::   ios
54      !!
55      NAMELIST/namzdf/ rn_avm0, rn_avt0, nn_avb, nn_havtb, ln_zdfexp, nn_zdfexp,  & 
56         &        ln_zdfevd, nn_evdm, rn_avevd, ln_zdfnpc, nn_npc, nn_npcp,       & 
57         &        ln_zdfqiao 
58      !!----------------------------------------------------------------------
59
60      REWIND( numnam_ref )              ! Namelist namzdf in reference namelist : Vertical mixing parameters
61      READ  ( numnam_ref, namzdf, IOSTAT = ios, ERR = 901)
62901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namzdf in reference namelist', lwp )
63
64      REWIND( numnam_cfg )              ! Namelist namzdf in reference namelist : Vertical mixing parameters
65      READ  ( numnam_cfg, namzdf, IOSTAT = ios, ERR = 902 )
66902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namzdf in configuration namelist', lwp )
67      IF(lwm) WRITE ( numond, namzdf )
68
69      IF(lwp) THEN               !* Parameter print
70         WRITE(numout,*)
71         WRITE(numout,*) 'zdf_init: vertical physics'
72         WRITE(numout,*) '~~~~~~~~'
73         WRITE(numout,*) '   Namelist namzdf : set vertical mixing mixing parameters'
74         WRITE(numout,*) '      vertical eddy viscosity             rn_avm0   = ', rn_avm0
75         WRITE(numout,*) '      vertical eddy diffusivity           rn_avt0   = ', rn_avt0
76         WRITE(numout,*) '      constant background or profile      nn_avb    = ', nn_avb
77         WRITE(numout,*) '      horizontal variation for avtb       nn_havtb  = ', nn_havtb
78         WRITE(numout,*) '      time splitting / backward scheme    ln_zdfexp = ', ln_zdfexp
79         WRITE(numout,*) '      number of time step                 nn_zdfexp = ', nn_zdfexp
80         WRITE(numout,*) '      enhanced vertical diffusion         ln_zdfevd = ', ln_zdfevd
81         WRITE(numout,*) '         applied on momentum (=1/0)       nn_evdm   = ', nn_evdm
82         WRITE(numout,*) '      vertical coefficient for evd        rn_avevd  = ', rn_avevd
83         WRITE(numout,*) '      non-penetrative convection (npc)    ln_zdfnpc = ', ln_zdfnpc
84         WRITE(numout,*) '      npc call  frequency                 nn_npc    = ', nn_npc
85         WRITE(numout,*) '      npc print frequency                 nn_npcp   = ', nn_npcp
86         WRITE(numout,*) '      Qiao formulation flag               ln_zdfqiao=', ln_zdfqiao
87      ENDIF
88
89      !                          !* Parameter & logical controls
90      !                          !  ----------------------------
91      !
92      !                               ! ... check of vertical mixing scheme on tracers
93      !                                              ==> will be done in trazdf module
94      !
95      !                               ! ... check of mixing coefficient
96      IF(lwp) WRITE(numout,*)
97      IF(lwp) WRITE(numout,*) '   vertical mixing option :'
98      ioptio = 0
99      IF( lk_zdfcst ) THEN
100         IF(lwp) WRITE(numout,*) '      constant eddy diffusion coefficients'
101         ioptio = ioptio+1
102      ENDIF
103      IF( lk_zdfric ) THEN
104         IF(lwp) WRITE(numout,*) '      Richardson dependent eddy coefficients'
105         ioptio = ioptio+1
106      ENDIF
107      IF( lk_zdftke ) THEN
108         IF(lwp) WRITE(numout,*) '      TKE dependent eddy coefficients'
109         ioptio = ioptio+1
110      ENDIF
111      IF( lk_zdfgls ) THEN
112         IF(lwp) WRITE(numout,*) '      GLS dependent eddy coefficients'
113         ioptio = ioptio+1
114      ENDIF
115      IF( lk_zdfkpp ) THEN
116         IF(lwp) WRITE(numout,*) '      KPP dependent eddy coefficients'
117         ioptio = ioptio+1
118      ENDIF
119      IF( ioptio == 0 .OR. ioptio > 1 .AND. .NOT. lk_esopa )   &
120         &   CALL ctl_stop( ' one and only one vertical diffusion option has to be defined ' )
121      IF( ( lk_zdfric .OR. lk_zdfgls .OR. lk_zdfkpp ) .AND. ln_isfcav )   &
122         &   CALL ctl_stop( ' only zdfcst and zdftke were tested with ice shelves cavities ' )
123      !
124      !                               ! ... Convection
125      IF(lwp) WRITE(numout,*)
126      IF(lwp) WRITE(numout,*) '   convection :'
127      !
128#if defined key_top
129      IF( ln_zdfnpc )   CALL ctl_stop( ' zdf_init: npc scheme is not working with key_top' )
130#endif
131      !
132      ioptio = 0
133      IF( ln_zdfnpc ) THEN
134         IF(lwp) WRITE(numout,*) '      use non penetrative convective scheme'
135         ioptio = ioptio+1
136      ENDIF
137      IF( ln_zdfevd ) THEN
138         IF(lwp) WRITE(numout,*) '      use enhanced vertical dif. scheme'
139         ioptio = ioptio+1
140      ENDIF
141      IF( lk_zdftke ) THEN
142         IF(lwp) WRITE(numout,*) '      use the 1.5 turbulent closure'
143      ENDIF
144      IF( lk_zdfgls ) THEN
145         IF(lwp) WRITE(numout,*) '      use the GLS closure scheme'
146      ENDIF
147      IF( lk_zdfkpp ) THEN
148         IF(lwp) WRITE(numout,*) '      use the KPP closure scheme'
149         IF(lk_mpp) THEN
150            IF(lwp) WRITE(numout,cform_err)
151            IF(lwp) WRITE(numout,*) 'The KPP scheme is not ready to run in MPI'
152         ENDIF
153      ENDIF
154      IF ( ioptio > 1 .AND. .NOT. lk_esopa )   CALL ctl_stop( ' chose between ln_zdfnpc and ln_zdfevd' )
155      IF( ioptio == 0 .AND. .NOT.( lk_zdftke .OR. lk_zdfgls .OR. lk_zdfkpp ) )           &
156         CALL ctl_stop( ' except for TKE, GLS or KPP physics, a convection scheme is',   &
157         &              ' required: ln_zdfevd or ln_zdfnpc logicals' )
158
159      !                               !* Background eddy viscosity and diffusivity profil
160      IF( nn_avb == 0 ) THEN                ! Define avmb, avtb from namelist parameter
161         avmb(:) = rn_avm0
162         avtb(:) = rn_avt0                     
163      ELSE                                  ! Background profile of avt (fit a theoretical/observational profile (Krauss 1990)
164         avmb(:) = rn_avm0
165         avtb(:) = rn_avt0 + ( 3.e-4_wp - 2._wp * rn_avt0 ) * 1.e-4_wp * gdepw_1d(:)   ! m2/s
166         IF(ln_sco .AND. lwp)   CALL ctl_warn( 'avtb profile not valid in sco' )
167      ENDIF
168      !
169      IF( ln_rstart ) THEN                  !  Read avmb, avtb in restart (if exist)
170         ! if ln_traadv_cen, avmb, avtb have been modified in traadv_cen2 module.
171         ! To ensure the restartability, avmb & avtb are written in the restart
172         ! file in traadv_cen2 end read here.
173         IF( iom_varid( numror, 'avmb', ldstop = .FALSE. ) > 0 ) THEN
174            CALL iom_get( numror, jpdom_unknown, 'avmb', avmb )
175            CALL iom_get( numror, jpdom_unknown, 'avtb', avtb )
176         ENDIF
177      ENDIF
178      !                                     ! 2D shape of the avtb
179      avtb_2d(:,:) = 1.e0                        ! uniform
180      !
181      IF( nn_havtb == 1 ) THEN                   ! decrease avtb in the equatorial band
182           !  -15S -5S : linear decrease from avt0 to avt0/10.
183           !  -5S  +5N : cst value avt0/10.
184           !   5N  15N : linear increase from avt0/10, to avt0
185           WHERE(-15. <= gphit .AND. gphit < -5 )   avtb_2d = (1.  - 0.09 * (gphit + 15.))
186           WHERE( -5. <= gphit .AND. gphit <  5 )   avtb_2d =  0.1
187           WHERE(  5. <= gphit .AND. gphit < 15 )   avtb_2d = (0.1 + 0.09 * (gphit -  5.))
188      ENDIF
189      !
190   END SUBROUTINE zdf_init
191
192   !!======================================================================
193END MODULE zdfini
Note: See TracBrowser for help on using the repository browser.