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/2017/dev_r8600_xios_read/NEMOGCM/NEMO/OPA_SRC/ZDF – NEMO

source: branches/2017/dev_r8600_xios_read/NEMOGCM/NEMO/OPA_SRC/ZDF/zdfini.F90 @ 8612

Last change on this file since 8612 was 8612, checked in by andmirek, 6 years ago

#1953 read single file restart with XIOS

  • Property svn:keywords set to Id
File size: 9.0 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 scheme
9   !!             -   ! 2009-07  (G. Madec) add avmb, avtb in restart for cen2 advection
10   !!            3.7  ! 2014-12  (G. Madec) remove KPP scheme
11   !!----------------------------------------------------------------------
12
13   !!----------------------------------------------------------------------
14   !!   zdf_init    : initialization, namelist read, and parameters control
15   !!----------------------------------------------------------------------
16   USE par_oce         ! mesh and scale factors
17   USE zdf_oce         ! TKE vertical mixing         
18   USE sbc_oce         ! surface module (only for nn_isf in the option compatibility test)
19   USE zdftke          ! TKE vertical mixing
20   USE zdfgls          ! GLS vertical mixing
21   USE zdfric          ! Richardson vertical mixing   
22   USE zdfddm          ! double diffusion mixing     
23   USE zdfevd          ! enhanced vertical diffusion 
24   USE tranpc          ! convection: non penetrative adjustment
25   USE ldfslp          ! iso-neutral slopes
26   !
27   USE in_out_manager  ! I/O manager
28   USE iom             ! IOM library
29   USE lib_mpp         ! distribued memory computing
30   USE iom_def, ONLY : lxios_read
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, ios       ! local integers
53      !!
54      NAMELIST/namzdf/ rn_avm0, rn_avt0, nn_avb, nn_havtb, ln_zdfexp, nn_zdfexp,  &
55         &        ln_zdfevd, nn_evdm, rn_avevd, ln_zdfnpc, nn_npc, nn_npcp,       &
56         &        ln_zdfqiao
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         WRITE(numout,*) '      Qiao formulation flag               ln_zdfqiao=', ln_zdfqiao
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         CALL ctl_stop( ' except for TKE or GLS physics, a convection scheme is',   &
145         &              ' required: ln_zdfevd or ln_zdfnpc logicals' )
146
147      !                               !* Background eddy viscosity and diffusivity profil
148      IF( nn_avb == 0 ) THEN                ! Define avmb, avtb from namelist parameter
149         avmb(:) = rn_avm0
150         avtb(:) = rn_avt0                     
151      ELSE                                  ! Background profile of avt (fit a theoretical/observational profile (Krauss 1990)
152         avmb(:) = rn_avm0
153         avtb(:) = rn_avt0 + ( 3.e-4_wp - 2._wp * rn_avt0 ) * 1.e-4_wp * gdepw_1d(:)   ! m2/s
154         IF(ln_sco .AND. lwp)   CALL ctl_warn( 'avtb profile not valid in sco' )
155      ENDIF
156      !
157      IF( ln_rstart ) THEN                  !  Read avmb, avtb in restart (if exist)
158         ! if ln_traadv_cen, avmb, avtb have been modified in traadv_cen2 module.
159         ! To ensure the restartability, avmb & avtb are written in the restart
160         ! file in traadv_cen2 end read here.
161         IF( iom_varid( numror, 'avmb', ldstop = .FALSE. ) > 0 ) THEN
162            CALL iom_get( numror, jpdom_unknown, 'avmb', avmb, lrxios = lxios_read )
163            CALL iom_get( numror, jpdom_unknown, 'avtb', avtb, lrxios = lxios_read )
164         ENDIF
165      ENDIF
166      !                                     ! 2D shape of the avtb
167      avtb_2d(:,:) = 1.e0                        ! uniform
168      !
169      IF( nn_havtb == 1 ) THEN                   ! decrease avtb in the equatorial band
170           !  -15S -5S : linear decrease from avt0 to avt0/10.
171           !  -5S  +5N : cst value avt0/10.
172           !   5N  15N : linear increase from avt0/10, to avt0
173           WHERE(-15. <= gphit .AND. gphit < -5 )   avtb_2d = (1.  - 0.09 * (gphit + 15.))
174           WHERE( -5. <= gphit .AND. gphit <  5 )   avtb_2d =  0.1
175           WHERE(  5. <= gphit .AND. gphit < 15 )   avtb_2d = (0.1 + 0.09 * (gphit -  5.))
176      ENDIF
177      !
178   END SUBROUTINE zdf_init
179
180   !!======================================================================
181END MODULE zdfini
Note: See TracBrowser for help on using the repository browser.