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 tags/nemo_v3_2/nemo_v3_2/NEMO/OPA_SRC/ZDF – NEMO

source: tags/nemo_v3_2/nemo_v3_2/NEMO/OPA_SRC/ZDF/zdfini.F90 @ 1878

Last change on this file since 1878 was 1878, checked in by flavoni, 14 years ago

initial test for nemogcm
File size: 8.6 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_old      ! TKE vertical mixing  (old scheme)
21   USE zdftke          ! TKE 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   USE restart         ! ocean restart
29
30   USE in_out_manager  ! I/O manager
31   USE iom             ! IOM library
32
33   IMPLICIT NONE
34   PRIVATE
35
36   PUBLIC   zdf_init   ! routine called by opa.F90
37   
38   !!----------------------------------------------------------------------
39   !! NEMO/OPA 3.2 , LOCEAN-IPSL (2009)
40   !! $Id: zdfini.F90 1601 2009-08-11 10:09:19Z ctlod $
41   !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt)
42   !!----------------------------------------------------------------------
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       ! temporary scalar
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 )           !* Read namzdf namelist : vertical mixing parameters
61      READ  ( numnam, namzdf )
62
63      IF(lwp) THEN               !* Parameter print
64         WRITE(numout,*)
65         WRITE(numout,*) 'zdf_init: vertical physics'
66         WRITE(numout,*) '~~~~~~~~'
67         WRITE(numout,*) '   Namelist namzdf : set vertical mixing mixing parameters'
68         WRITE(numout,*) '      vertical eddy viscosity             rn_avm0   = ', rn_avm0
69         WRITE(numout,*) '      vertical eddy diffusivity           rn_avt0   = ', rn_avt0
70         WRITE(numout,*) '      constant background or profile      nn_avb    = ', nn_avb
71         WRITE(numout,*) '      horizontal variation for avtb       nn_havtb  = ', nn_havtb
72         WRITE(numout,*) '      time splitting / backward scheme    ln_zdfexp = ', ln_zdfexp
73         WRITE(numout,*) '      number of time step                 nn_zdfexp = ', nn_zdfexp
74         WRITE(numout,*) '      enhanced vertical diffusion         ln_zdfevd = ', ln_zdfevd
75         WRITE(numout,*) '         applied on momentum (=1/0)       nn_evdm   = ', nn_evdm
76         WRITE(numout,*) '      vertical coefficient for evd        rn_avevd  = ', rn_avevd
77         WRITE(numout,*) '      non-penetrative convection (npc)    ln_zdfnpc = ', ln_zdfnpc
78         WRITE(numout,*) '      npc call  frequency                 nn_npc    = ', nn_npc
79         WRITE(numout,*) '      npc print frequency                 nn_npcp   = ', nn_npcp
80      ENDIF
81
82      !                          !* Parameter & logical controls
83      !                          !  ----------------------------
84      !
85      !                               ! ... check of vertical mixing scheme on tracers
86      !                                              ==> will be done in trazdf module
87      !
88      !                               ! ... check of mixing coefficient
89      IF(lwp) WRITE(numout,*)
90      IF(lwp) WRITE(numout,*) '   vertical mixing option :'
91      ioptio = 0
92      IF( lk_zdfcst ) THEN
93         IF(lwp) WRITE(numout,*) '      constant eddy diffusion coefficients'
94         ioptio = ioptio+1
95      ENDIF
96      IF( lk_zdfric ) THEN
97         IF(lwp) WRITE(numout,*) '      Richardson dependent eddy coefficients'
98         ioptio = ioptio+1
99      ENDIF
100      IF( lk_zdftke_old ) THEN
101         IF(lwp) WRITE(numout,*) '      TKE dependent eddy coefficients'
102         ioptio = ioptio+1
103      ENDIF
104      IF( lk_zdftke ) THEN
105         IF(lwp) WRITE(numout,*) '      TKE dependent eddy coefficients'
106         ioptio = ioptio+1
107      ENDIF
108      IF( lk_zdfkpp ) THEN
109         IF(lwp) WRITE(numout,*) '      KPP dependent eddy coefficients'
110         ioptio = ioptio+1
111      ENDIF
112      IF( ioptio == 0 .OR. ioptio > 1 .AND. .NOT. lk_esopa ) &
113         &   CALL ctl_stop( ' one and only one vertical diffusion option has to be defined ' )
114      !
115      !                               ! ... Convection
116      IF(lwp) WRITE(numout,*)
117      IF(lwp) WRITE(numout,*) '   convection :'
118      ioptio = 0
119      IF( ln_zdfnpc ) THEN
120         IF(lwp) WRITE(numout,*) '      use non penetrative convective scheme'
121         ioptio = ioptio+1
122      ENDIF
123      IF( ln_zdfevd ) THEN
124         IF(lwp) WRITE(numout,*) '      use enhanced vertical dif. scheme'
125         ioptio = ioptio+1
126      ENDIF
127      IF( lk_zdftke_old .OR. lk_zdftke ) THEN
128         IF(lwp) WRITE(numout,*) '      use the 1.5 turbulent closure'
129      ENDIF
130      IF( lk_zdfkpp ) THEN
131         IF(lwp) WRITE(numout,*) '      use the KPP closure scheme'
132         IF(lk_mpp) THEN
133            IF(lwp) WRITE(numout,cform_err)
134            IF(lwp) WRITE(numout,*) 'The KPP scheme is not ready to run in MPI'
135         ENDIF
136      ENDIF
137      IF ( ioptio > 1 .AND. .NOT. lk_esopa )   CALL ctl_stop( ' chose between ln_zdfnpc and ln_zdfevd' )
138      IF( ioptio == 0 .AND. .NOT.( lk_zdftke_old .OR. lk_zdftke .OR. lk_zdfkpp ) ) &
139         CALL ctl_stop( ' except for TKE sor KPP physics, a convection scheme is', &
140         &              ' required: ln_zdfevd or ln_zdfnpc logicals' )
141
142
143      !                               !* Background eddy viscosity and diffusivity profil
144      IF( nn_avb == 0 ) THEN                ! Define avmb, avtb from namelist parameter
145         avmb(:) = rn_avm0
146         avtb(:) = rn_avt0                     
147      ELSE                                  ! Background profile of avt (fit a theoretical/observational profile (Krauss 1990)
148         avmb(:) = rn_avm0
149         avtb(:) = rn_avt0 + ( 3.0e-4 - 2 * rn_avt0 ) * 1.0e-4 * gdepw_0(:)   ! m2/s
150         IF(ln_sco .AND. lwp)   CALL ctl_warn( '          avtb profile not valid in sco' )
151      ENDIF
152      !
153      IF( ln_rstart ) THEN                  !  Read avmb, avtb in restart (if exist)
154         ! if ln_traadv_cen, avmb, avtb have been modified in traadv_cen2 module.
155         ! To ensure the restartability, avmb & avtb are written in the restart
156         ! file in traadv_cen2 end read here.
157         IF( iom_varid( numror, 'avmb', ldstop = .FALSE. ) > 0 ) THEN
158            CALL iom_get( numror, jpdom_unknown, 'avmb', avmb )
159            CALL iom_get( numror, jpdom_unknown, 'avtb', avtb )
160         ENDIF
161      ENDIF
162      !                                     ! 2D shape of the avtb
163      avtb_2d(:,:) = 1.e0                        ! uniform
164      !
165      IF( nn_havtb == 1 ) THEN                   ! decrease avtb in the equatorial band
166           !  -15S -5S : linear decrease from avt0 to avt0/10.
167           !  -5S  +5N : cst value avt0/10.
168           !   5N  15N : linear increase from avt0/10, to avt0
169           WHERE(-15. <= gphit .AND. gphit < -5 )   avtb_2d = (1.  - 0.09 * (gphit + 15.))
170           WHERE( -5. <= gphit .AND. gphit <  5 )   avtb_2d =  0.1
171           WHERE(  5. <= gphit .AND. gphit < 15 )   avtb_2d = (0.1 + 0.09 * (gphit -  5.))
172      ENDIF
173      !
174   END SUBROUTINE zdf_init
175
176   !!======================================================================
177END MODULE zdfini
Note: See TracBrowser for help on using the repository browser.