source: branches/2015/dev_r5094_UKMO_ISFCLEAN/NEMOGCM/NEMO/OPA_SRC/ZDF/zdfini.F90 @ 5111

Last change on this file since 5111 was 5111, checked in by mathiot, 6 years ago

add some missing if ln_isfcav, test of option compatibility with ln_isfcav + small documentation

  • Property svn:keywords set to Id
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      !!----------------------------------------------------------------------
58
59      REWIND( numnam_ref )              ! Namelist namzdf in reference namelist : Vertical mixing parameters
60      READ  ( numnam_ref, namzdf, IOSTAT = ios, ERR = 901)
61901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namzdf in reference namelist', lwp )
62
63      REWIND( numnam_cfg )              ! Namelist namzdf in reference namelist : Vertical mixing parameters
64      READ  ( numnam_cfg, namzdf, IOSTAT = ios, ERR = 902 )
65902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namzdf in configuration namelist', lwp )
66      IF(lwm) WRITE ( numond, namzdf )
67
68      IF(lwp) THEN               !* Parameter print
69         WRITE(numout,*)
70         WRITE(numout,*) 'zdf_init: vertical physics'
71         WRITE(numout,*) '~~~~~~~~'
72         WRITE(numout,*) '   Namelist namzdf : set vertical mixing mixing parameters'
73         WRITE(numout,*) '      vertical eddy viscosity             rn_avm0   = ', rn_avm0
74         WRITE(numout,*) '      vertical eddy diffusivity           rn_avt0   = ', rn_avt0
75         WRITE(numout,*) '      constant background or profile      nn_avb    = ', nn_avb
76         WRITE(numout,*) '      horizontal variation for avtb       nn_havtb  = ', nn_havtb
77         WRITE(numout,*) '      time splitting / backward scheme    ln_zdfexp = ', ln_zdfexp
78         WRITE(numout,*) '      number of time step                 nn_zdfexp = ', nn_zdfexp
79         WRITE(numout,*) '      enhanced vertical diffusion         ln_zdfevd = ', ln_zdfevd
80         WRITE(numout,*) '         applied on momentum (=1/0)       nn_evdm   = ', nn_evdm
81         WRITE(numout,*) '      vertical coefficient for evd        rn_avevd  = ', rn_avevd
82         WRITE(numout,*) '      non-penetrative convection (npc)    ln_zdfnpc = ', ln_zdfnpc
83         WRITE(numout,*) '      npc call  frequency                 nn_npc    = ', nn_npc
84         WRITE(numout,*) '      npc print frequency                 nn_npcp   = ', nn_npcp
85      ENDIF
86
87      !                          !* Parameter & logical controls
88      !                          !  ----------------------------
89      !
90      !                               ! ... check of vertical mixing scheme on tracers
91      !                                              ==> will be done in trazdf module
92      !
93      !                               ! ... check of mixing coefficient
94      IF(lwp) WRITE(numout,*)
95      IF(lwp) WRITE(numout,*) '   vertical mixing option :'
96      ioptio = 0
97      IF( lk_zdfcst ) THEN
98         IF(lwp) WRITE(numout,*) '      constant eddy diffusion coefficients'
99         ioptio = ioptio+1
100      ENDIF
101      IF( lk_zdfric ) THEN
102         IF(lwp) WRITE(numout,*) '      Richardson dependent eddy coefficients'
103         ioptio = ioptio+1
104      ENDIF
105      IF( lk_zdftke ) THEN
106         IF(lwp) WRITE(numout,*) '      TKE dependent eddy coefficients'
107         ioptio = ioptio+1
108      ENDIF
109      IF( lk_zdfgls ) THEN
110         IF(lwp) WRITE(numout,*) '      GLS dependent eddy coefficients'
111         ioptio = ioptio+1
112      ENDIF
113      IF( lk_zdfkpp ) THEN
114         IF(lwp) WRITE(numout,*) '      KPP dependent eddy coefficients'
115         ioptio = ioptio+1
116      ENDIF
117      IF( ioptio == 0 .OR. ioptio > 1 .AND. .NOT. lk_esopa )   &
118         &   CALL ctl_stop( ' one and only one vertical diffusion option has to be defined ' )
119      IF( ( lk_zdfric .OR. lk_zdfgls .OR. lk_zdfkpp ) .AND. ln_isfcav )   &
120         &   CALL ctl_stop( ' only zdfcst and zdftke were tested with ice shelves cavities ' )
121      !
122      !                               ! ... Convection
123      IF(lwp) WRITE(numout,*)
124      IF(lwp) WRITE(numout,*) '   convection :'
125      !
126      IF( ln_zdfnpc )   CALL ctl_stop( ' zdf_init: non penetrative convective scheme is not working',   &
127         &                                       ' set ln_zdfnpc to FALSE' )
128      !
129      ioptio = 0
130      IF( ln_zdfnpc ) THEN
131         IF(lwp) WRITE(numout,*) '      use non penetrative convective scheme'
132         ioptio = ioptio+1
133      ENDIF
134      IF( ln_zdfevd ) THEN
135         IF(lwp) WRITE(numout,*) '      use enhanced vertical dif. scheme'
136         ioptio = ioptio+1
137      ENDIF
138      IF( lk_zdftke ) THEN
139         IF(lwp) WRITE(numout,*) '      use the 1.5 turbulent closure'
140      ENDIF
141      IF( lk_zdfgls ) THEN
142         IF(lwp) WRITE(numout,*) '      use the GLS closure scheme'
143      ENDIF
144      IF( lk_zdfkpp ) THEN
145         IF(lwp) WRITE(numout,*) '      use the KPP closure scheme'
146         IF(lk_mpp) THEN
147            IF(lwp) WRITE(numout,cform_err)
148            IF(lwp) WRITE(numout,*) 'The KPP scheme is not ready to run in MPI'
149         ENDIF
150      ENDIF
151      IF ( ioptio > 1 .AND. .NOT. lk_esopa )   CALL ctl_stop( ' chose between ln_zdfnpc and ln_zdfevd' )
152      IF( ioptio == 0 .AND. .NOT.( lk_zdftke .OR. lk_zdfgls .OR. lk_zdfkpp ) )           &
153         CALL ctl_stop( ' except for TKE, GLS or KPP physics, a convection scheme is',   &
154         &              ' required: ln_zdfevd or ln_zdfnpc logicals' )
155
156      !                               !* Background eddy viscosity and diffusivity profil
157      IF( nn_avb == 0 ) THEN                ! Define avmb, avtb from namelist parameter
158         avmb(:) = rn_avm0
159         avtb(:) = rn_avt0                     
160      ELSE                                  ! Background profile of avt (fit a theoretical/observational profile (Krauss 1990)
161         avmb(:) = rn_avm0
162         avtb(:) = rn_avt0 + ( 3.e-4_wp - 2._wp * rn_avt0 ) * 1.e-4_wp * gdepw_1d(:)   ! m2/s
163         IF(ln_sco .AND. lwp)   CALL ctl_warn( 'avtb profile not valid in sco' )
164      ENDIF
165      !
166      IF( ln_rstart ) THEN                  !  Read avmb, avtb in restart (if exist)
167         ! if ln_traadv_cen, avmb, avtb have been modified in traadv_cen2 module.
168         ! To ensure the restartability, avmb & avtb are written in the restart
169         ! file in traadv_cen2 end read here.
170         IF( iom_varid( numror, 'avmb', ldstop = .FALSE. ) > 0 ) THEN
171            CALL iom_get( numror, jpdom_unknown, 'avmb', avmb )
172            CALL iom_get( numror, jpdom_unknown, 'avtb', avtb )
173         ENDIF
174      ENDIF
175      !                                     ! 2D shape of the avtb
176      avtb_2d(:,:) = 1.e0                        ! uniform
177      !
178      IF( nn_havtb == 1 ) THEN                   ! decrease avtb in the equatorial band
179           !  -15S -5S : linear decrease from avt0 to avt0/10.
180           !  -5S  +5N : cst value avt0/10.
181           !   5N  15N : linear increase from avt0/10, to avt0
182           WHERE(-15. <= gphit .AND. gphit < -5 )   avtb_2d = (1.  - 0.09 * (gphit + 15.))
183           WHERE( -5. <= gphit .AND. gphit <  5 )   avtb_2d =  0.1
184           WHERE(  5. <= gphit .AND. gphit < 15 )   avtb_2d = (0.1 + 0.09 * (gphit -  5.))
185      ENDIF
186      !
187   END SUBROUTINE zdf_init
188
189   !!======================================================================
190END MODULE zdfini
Note: See TracBrowser for help on using the repository browser.