source: branches/2017/dev_r7881_HPC09_ZDF/NEMOGCM/NEMO/OPA_SRC/ZDF/zdf_oce.F90 @ 7953

Last change on this file since 7953 was 7953, checked in by gm, 3 years ago

#1880 (HPC-09): add zdfphy (the ZDF manager) + remove all key_…

  • Property svn:keywords set to Id
File size: 5.2 KB
Line 
1MODULE zdf_oce
2   !!======================================================================
3   !!              ***  MODULE  zdf_oce  ***
4   !! Ocean physics : define vertical mixing variables
5   !!=====================================================================
6   !! history :  1.0  !  2002-06  (G. Madec) Original code
7   !!            3.2  !  2009-07  (G.Madec) addition of avm
8   !!----------------------------------------------------------------------
9   USE par_oce        ! ocean parameters
10   USE in_out_manager ! I/O manager
11   USE lib_mpp        ! MPP library
12
13   IMPLICIT NONE
14   PRIVATE
15
16   PUBLIC  zdf_oce_alloc    ! Called in nemogcm.F90
17
18   !                                 !!* namelist namzdf: vertical diffusion *
19!!gm
20   !                             ! vertical closure scheme flags
21   LOGICAL , PUBLIC ::   ln_zdfcst   !: constant coefficients
22   LOGICAL , PUBLIC ::   ln_zdfric   !: Richardson depend coefficients
23   LOGICAL , PUBLIC ::   ln_zdftke   !: Turbulent Kinetic Energy closure
24   LOGICAL , PUBLIC ::   ln_zdfgls   !: Generic Length Sclare closure
25   !                             ! tidal induced mixing   
26   LOGICAL , PUBLIC ::   ln_zdftmx   !: tidal mixing parameterization flag
27   !                             ! double diffusion
28   LOGICAL , PUBLIC ::   ln_zdfddm   !: double diffusive mixing flag
29   REAL(wp), PUBLIC ::      rn_avts     !: maximum value of avs for salt fingering
30   REAL(wp), PUBLIC ::      rn_hsbfr    !: heat/salt buoyancy flux ratio
31!!gm
32   LOGICAL , PUBLIC ::   ln_zdfexp   !: explicit vertical diffusion scheme flag
33   INTEGER , PUBLIC ::   nn_zdfexp   !: number of sub-time step (explicit time stepping)
34   LOGICAL , PUBLIC ::   ln_zdfevd   !: convection: enhanced vertical diffusion flag
35   INTEGER , PUBLIC ::      nn_evdm     !: =0/1 flag to apply enhanced avm or not
36   REAL(wp), PUBLIC ::      rn_evd      !: vertical eddy coeff. for enhanced vert. diff. (m2/s)
37   LOGICAL , PUBLIC ::   ln_zdfnpc   !: convection: non-penetrative convection flag
38   INTEGER , PUBLIC ::      nn_npc      !: non penetrative convective scheme call  frequency
39   INTEGER , PUBLIC ::      nn_npcp     !: non penetrative convective scheme print frequency
40   !                             ! Surface wave-induced mixing
41   LOGICAL , PUBLIC ::   ln_zdfqiao  !: Enhanced wave vertical mixing Qiao(2010) formulation flag
42   !                             ! coefficients
43   REAL(wp), PUBLIC ::   rn_avm0     !: vertical eddy viscosity (m2/s)
44   REAL(wp), PUBLIC ::   rn_avt0     !: vertical eddy diffusivity (m2/s)
45   INTEGER , PUBLIC ::   nn_avb      !: constant or profile background on avt (=0/1)
46   INTEGER , PUBLIC ::   nn_havtb    !: horizontal shape or not for avtb (=0/1)   !                             ! convection
47
48
49   REAL(wp), PUBLIC, SAVE, ALLOCATABLE, DIMENSION(:,:,:) ::   avt  , avs     !: vertical eddy diffusivity coef at w-pt [m2/s]
50
51   REAL(wp), PUBLIC, SAVE, ALLOCATABLE, DIMENSION(:)     ::   avmb , avtb    !: background profile of avm and avt
52   REAL(wp), PUBLIC, SAVE, ALLOCATABLE, DIMENSION(:,:)   ::   avtb_2d        !: horizontal shape of background Kz profile
53   REAL(wp), PUBLIC, SAVE, ALLOCATABLE, DIMENSION(:,:)   ::   bfrua, bfrva   !: Bottom friction coefficients set in zdfbfr
54   REAL(wp), PUBLIC, SAVE, ALLOCATABLE, DIMENSION(:,:)   ::   tfrua, tfrva   !: top friction coefficients set in zdfbfr
55   REAL(wp), PUBLIC, SAVE, ALLOCATABLE, DIMENSION(:,:,:) ::   avmu , avmv    !: vertical viscosity coef at uw- & vw-pts       [m2/s]
56   REAL(wp), PUBLIC, SAVE, ALLOCATABLE, DIMENSION(:,:,:) ::   avm            !: vertical viscosity & diffusivity coef at w-pt [m2/s]
57   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   avt_k , avm_k  ! not enhanced Kz
58   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   avmu_k, avmv_k ! not enhanced Kz
59   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   en              !: now turbulent kinetic energy   [m2/s2]
60
61   !!----------------------------------------------------------------------
62   !! NEMO/OPA 4.0 , NEMO Consortium (2011)
63   !! $Id$
64   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
65   !!----------------------------------------------------------------------
66CONTAINS
67
68   INTEGER FUNCTION zdf_oce_alloc()
69      !!----------------------------------------------------------------------
70      !!            *** FUNCTION zdf_oce_alloc ***
71      !!----------------------------------------------------------------------
72      !
73      ALLOCATE(avmb(jpk) , bfrua(jpi,jpj) ,                         &
74         &     avtb(jpk) , bfrva(jpi,jpj) , avtb_2d(jpi,jpj) ,      &
75         &     tfrua(jpi, jpj), tfrva(jpi, jpj)              ,      &
76         &     avmu  (jpi,jpj,jpk), avm   (jpi,jpj,jpk)      ,      &
77         &     avmv  (jpi,jpj,jpk), avt   (jpi,jpj,jpk)      , avs   (jpi,jpj,jpk),          &
78         &     avt_k (jpi,jpj,jpk), avm_k (jpi,jpj,jpk)      ,      & 
79         &     avmu_k(jpi,jpj,jpk), avmv_k(jpi,jpj,jpk)      ,      &
80         &     en    (jpi,jpj,jpk), STAT = zdf_oce_alloc )
81         !
82      IF( zdf_oce_alloc /= 0 )   CALL ctl_warn('zdf_oce_alloc: failed to allocate arrays')
83      !
84   END FUNCTION zdf_oce_alloc
85
86   !!======================================================================
87END MODULE zdf_oce
Note: See TracBrowser for help on using the repository browser.