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/2016/dev_r6409_SIMPLIF_2_usrdef/NEMOGCM/CONFIG/OVERFLOW/MY_SRC – NEMO

source: branches/2016/dev_r6409_SIMPLIF_2_usrdef/NEMOGCM/CONFIG/OVERFLOW/MY_SRC/zdfini.F90 @ 7002

Last change on this file since 7002 was 6923, checked in by gm, 8 years ago

#1692 - branch SIMPLIF_2_usrdef: update comments in usrdef modules
File size: 8.9 KB
Line 
1MODULE zdfini
2   !!======================================================================
3   !!                     ***  MODULE zdfini  ***
4   !!
5   !!                     ===  OVERFLOW case  ===
6   !!
7   !! Ocean physics :   read vertical mixing namelist and check consistancy
8   !!======================================================================
9   !! History :  8.0  ! 1997-06  (G. Madec)  Original code from inimix
10   !!            1.0  ! 2002-08  (G. Madec)  F90 : free form
11   !!             -   ! 2005-06  (C. Ethe) KPP scheme
12   !!             -   ! 2009-07  (G. Madec) add avmb, avtb in restart for cen2 advection
13   !!            3.7  ! 2014-12  (G. Madec) remove KPP scheme
14   !!----------------------------------------------------------------------
15
16   !!----------------------------------------------------------------------
17   !!   zdf_init    : initialization, namelist read, and parameters control
18   !!----------------------------------------------------------------------
19   USE par_oce         ! mesh and scale factors
20   USE zdf_oce         ! TKE vertical mixing         
21   USE sbc_oce         ! surface module (only for nn_isf in the option compatibility test)
22   USE zdftke          ! TKE vertical mixing
23   USE zdfgls          ! GLS vertical mixing
24   USE zdfric          ! Richardson vertical mixing   
25   USE zdfddm          ! double diffusion mixing     
26   USE zdfevd          ! enhanced vertical diffusion 
27   USE tranpc          ! convection: non penetrative adjustment
28   USE ldfslp          ! iso-neutral slopes
29   !
30   USE in_out_manager  ! I/O manager
31   USE iom             ! IOM library
32   USE lib_mpp         ! distribued memory computing
33
34   IMPLICIT NONE
35   PRIVATE
36
37   PUBLIC   zdf_init   ! routine called by opa.F90
38   
39   !!----------------------------------------------------------------------
40   !! NEMO/OPA 4.0 , NEMO Consortium (2011)
41   !! $Id$
42   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
43   !!----------------------------------------------------------------------
44CONTAINS
45
46   SUBROUTINE zdf_init
47      !!----------------------------------------------------------------------
48      !!                  ***  ROUTINE zdf_init  ***
49      !!
50      !! ** Purpose :   initializations of the vertical ocean physics
51      !!
52      !! ** Method  :   Read namelist namzdf, control logicals
53      !!----------------------------------------------------------------------
54      INTEGER ::   ioptio, ios       ! local integers
55      !!
56      NAMELIST/namzdf/ rn_avm0, rn_avt0, nn_avb, nn_havtb, ln_zdfexp, nn_zdfexp,   &
57         &              ln_zdfevd, nn_evdm, rn_avevd, ln_zdfnpc, nn_npc, nn_npcp
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      ENDIF
87
88      !                          !* Parameter & logical controls
89      !                          !  ----------------------------
90      !
91      !                               ! ... check of vertical mixing scheme on tracers
92      !                                              ==> will be done in trazdf module
93      !
94      !                               ! ... check of mixing coefficient
95      IF(lwp) WRITE(numout,*)
96      IF(lwp) WRITE(numout,*) '   vertical mixing option :'
97      ioptio = 0
98      IF( lk_zdfcst ) THEN
99         IF(lwp) WRITE(numout,*) '      constant eddy diffusion coefficients'
100         ioptio = ioptio+1
101      ENDIF
102      IF( lk_zdfric ) THEN
103         IF(lwp) WRITE(numout,*) '      Richardson dependent eddy coefficients'
104         ioptio = ioptio+1
105      ENDIF
106      IF( lk_zdftke ) THEN
107         IF(lwp) WRITE(numout,*) '      TKE dependent eddy coefficients'
108         ioptio = ioptio+1
109      ENDIF
110      IF( lk_zdfgls ) THEN
111         IF(lwp) WRITE(numout,*) '      GLS dependent eddy coefficients'
112         ioptio = ioptio+1
113      ENDIF
114      IF( ioptio == 0 .OR. ioptio > 1 )   &
115         &   CALL ctl_stop( ' one and only one vertical diffusion option has to be defined ' )
116      IF( ( lk_zdfric .OR. lk_zdfgls ) .AND. ln_isfcav )   &
117         &   CALL ctl_stop( ' only zdfcst and zdftke were tested with ice shelves cavities ' )
118      !
119      !                               ! ... Convection
120      IF(lwp) WRITE(numout,*)
121      IF(lwp) WRITE(numout,*) '   convection :'
122      !
123#if defined key_top
124      IF( ln_zdfnpc )   CALL ctl_stop( ' zdf_init: npc scheme is not working with key_top' )
125#endif
126      !
127      ioptio = 0
128      IF( ln_zdfnpc ) THEN
129         IF(lwp) WRITE(numout,*) '      use non penetrative convective scheme'
130         ioptio = ioptio+1
131      ENDIF
132      IF( ln_zdfevd ) THEN
133         IF(lwp) WRITE(numout,*) '      use enhanced vertical dif. scheme'
134         ioptio = ioptio+1
135      ENDIF
136      IF( lk_zdftke ) THEN
137         IF(lwp) WRITE(numout,*) '      use the 1.5 turbulent closure'
138      ENDIF
139      IF( lk_zdfgls ) THEN
140         IF(lwp) WRITE(numout,*) '      use the GLS closure scheme'
141      ENDIF
142      IF ( ioptio > 1 )   CALL ctl_stop( ' chose between ln_zdfnpc and ln_zdfevd' )
143      IF( ioptio == 0 .AND. .NOT.( lk_zdftke .OR. lk_zdfgls ) )           &
144         !SF CALL ctl_stop( ' except for TKE or GLS physics, a convection scheme is',   &
145         CALL ctl_warn( ' except for TKE or GLS physics, a convection scheme is',   &
146         &              ' required: ln_zdfevd or ln_zdfnpc logicals' )
147
148      !                               !* Background eddy viscosity and diffusivity profil
149      IF( nn_avb == 0 ) THEN                ! Define avmb, avtb from namelist parameter
150         avmb(:) = rn_avm0
151         avtb(:) = rn_avt0                     
152      ELSE                                  ! Background profile of avt (fit a theoretical/observational profile (Krauss 1990)
153         avmb(:) = rn_avm0
154         avtb(:) = rn_avt0 + ( 3.e-4_wp - 2._wp * rn_avt0 ) * 1.e-4_wp * gdepw_1d(:)   ! m2/s
155         IF(ln_sco .AND. lwp)   CALL ctl_warn( 'avtb profile not valid in sco' )
156      ENDIF
157      !
158      IF( ln_rstart ) THEN                  !  Read avmb, avtb in restart (if exist)
159         ! if ln_traadv_cen, avmb, avtb have been modified in traadv_cen2 module.
160         ! To ensure the restartability, avmb & avtb are written in the restart
161         ! file in traadv_cen2 end read here.
162         IF( iom_varid( numror, 'avmb', ldstop = .FALSE. ) > 0 ) THEN
163            CALL iom_get( numror, jpdom_unknown, 'avmb', avmb )
164            CALL iom_get( numror, jpdom_unknown, 'avtb', avtb )
165         ENDIF
166      ENDIF
167      !                                     ! 2D shape of the avtb
168      avtb_2d(:,:) = 1.e0                        ! uniform
169      !
170      IF( nn_havtb == 1 ) THEN                   ! decrease avtb in the equatorial band
171           !  -15S -5S : linear decrease from avt0 to avt0/10.
172           !  -5S  +5N : cst value avt0/10.
173           !   5N  15N : linear increase from avt0/10, to avt0
174           WHERE(-15. <= gphit .AND. gphit < -5 )   avtb_2d = (1.  - 0.09 * (gphit + 15.))
175           WHERE( -5. <= gphit .AND. gphit <  5 )   avtb_2d =  0.1
176           WHERE(  5. <= gphit .AND. gphit < 15 )   avtb_2d = (0.1 + 0.09 * (gphit -  5.))
177      ENDIF
178      !
179   END SUBROUTINE zdf_init
180
181   !!======================================================================
182END MODULE zdfini
Note: See TracBrowser for help on using the repository browser.