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.
ldftra.F90 in branches/2011/dev_r2782_NOCS_Griffies/NEMOGCM/NEMO/OPA_SRC/LDF – NEMO

source: branches/2011/dev_r2782_NOCS_Griffies/NEMOGCM/NEMO/OPA_SRC/LDF/ldftra.F90 @ 2840

Last change on this file since 2840 was 2840, checked in by agn, 13 years ago

branches/2011/dev_r2782_NOCS_Griffies ticket #838 bugfixes + preliminary support for s-coords
  • Property svn:keywords set to Id
File size: 8.5 KB
Line 
1MODULE ldftra
2   !!======================================================================
3   !!                       ***  MODULE  ldftra  ***
4   !! Ocean physics:  lateral diffusivity coefficient
5   !!=====================================================================
6   !! History :        ! 1997-07  (G. Madec)  from inimix.F split in 2 routines
7   !!   NEMO      1.0  ! 2002-09  (G. Madec)  F90: Free form and module
8   !!             2.0  ! 2005-11  (G. Madec) 
9   !!----------------------------------------------------------------------
10
11   !!----------------------------------------------------------------------
12   !!   ldf_tra_init : initialization, namelist read, and parameters control
13   !!   ldf_tra_c3d   : 3D eddy viscosity coefficient initialization
14   !!   ldf_tra_c2d   : 2D eddy viscosity coefficient initialization
15   !!   ldf_tra_c1d   : 1D eddy viscosity coefficient initialization
16   !!----------------------------------------------------------------------
17   USE oce             ! ocean dynamics and tracers
18   USE dom_oce         ! ocean space and time domain
19   USE phycst          ! physical constants
20   USE ldftra_oce      ! ocean tracer   lateral physics
21   USE ldfslp          ! ???
22   USE in_out_manager  ! I/O manager
23   USE ioipsl
24   USE lib_mpp         ! distribued memory computing library
25   USE lbclnk          ! ocean lateral boundary conditions (or mpp link)
26
27   IMPLICIT NONE
28   PRIVATE
29
30   PUBLIC   ldf_tra_init   ! called by opa.F90
31
32   !! * Substitutions
33#  include "domzgr_substitute.h90"
34#  include "vectopt_loop_substitute.h90"
35   !!----------------------------------------------------------------------
36   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
37   !! $Id$
38   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
39   !!----------------------------------------------------------------------
40CONTAINS
41
42   SUBROUTINE ldf_tra_init
43      !!----------------------------------------------------------------------
44      !!                  ***  ROUTINE ldf_tra_init  ***
45      !!
46      !! ** Purpose :   initializations of the tracer lateral mixing coeff.
47      !!
48      !! ** Method  :   the Eddy diffusivity and eddy induced velocity ceoff.
49      !!      are defined as follows:
50      !!         default option   : constant coef. aht0, aeiv0 (namelist)
51      !!        'key_traldf_c1d': depth dependent coef. defined in
52      !!                            in ldf_tra_c1d routine
53      !!        'key_traldf_c2d': latitude and longitude dependent coef.
54      !!                            defined in ldf_tra_c2d routine
55      !!        'key_traldf_c3d': latitude, longitude, depth dependent coef.
56      !!                            defined in ldf_tra_c3d routine
57      !!
58      !!      N.B. User defined include files.  By default, 3d and 2d coef.
59      !!      are set to a constant value given in the namelist and the 1d
60      !!      coefficients are initialized to a hyperbolic tangent vertical
61      !!      profile.
62      !!----------------------------------------------------------------------
63      INTEGER ::   ioptio               ! temporary integer
64      LOGICAL ::   ll_print = .FALSE.   ! =T print eddy coef. in numout
65      !!
66      NAMELIST/namtra_ldf/ ln_traldf_lap  , ln_traldf_bilap,                  &
67         &                 ln_traldf_level, ln_traldf_hor  , ln_traldf_iso,   &
68         &                 ln_traldf_grif , ln_traldf_gdia,                   &
69         &                 ln_triad_iso , ln_botmix, ln_grad_zps,    &
70         &                 rn_aht_0       , rn_ahtb_0      , rn_aeiv_0,       &
71         &                 rn_slpmax
72      !!----------------------------------------------------------------------
73
74      !  Define the lateral tracer physics parameters
75      ! =============================================
76   
77      REWIND( numnam )                  ! Read Namelist namtra_ldf : Lateral physics on tracers
78      READ  ( numnam, namtra_ldf )
79
80      IF(lwp) THEN                      ! control print
81         WRITE(numout,*)
82         WRITE(numout,*) 'ldf_tra_init : lateral tracer physics'
83         WRITE(numout,*) '~~~~~~~~~~~~ '
84         WRITE(numout,*) '   Namelist namtra_ldf : lateral mixing parameters (type, direction, coefficients)'
85         WRITE(numout,*) '      laplacian operator            ln_traldf_lap   = ', ln_traldf_lap
86         WRITE(numout,*) '      bilaplacian operator          ln_traldf_bilap = ', ln_traldf_bilap
87         WRITE(numout,*) '      iso-level                     ln_traldf_level = ', ln_traldf_level
88         WRITE(numout,*) '      horizontal (geopotential)     ln_traldf_hor   = ', ln_traldf_hor
89         WRITE(numout,*) '      iso-neutral                   ln_traldf_iso   = ', ln_traldf_iso
90         WRITE(numout,*) '      iso-neutral (Griffies)        ln_traldf_grif  = ', ln_traldf_grif
91         WRITE(numout,*) '      Griffies strmfn diagnostics   ln_traldf_gdia  = ', ln_traldf_gdia
92         WRITE(numout,*) '      lateral eddy diffusivity      rn_aht_0        = ', rn_aht_0
93         WRITE(numout,*) '      background hor. diffusivity   rn_ahtb_0       = ', rn_ahtb_0
94         WRITE(numout,*) '      eddy induced velocity coef.   rn_aeiv_0       = ', rn_aeiv_0
95         WRITE(numout,*) '      maximum isoppycnal slope      rn_slpmax       = ', rn_slpmax
96         WRITE(numout,*) '   + griffies operator internal controls not set via the namelist (experimental): '
97         WRITE(numout,*) '      calculate triads twice        ln_triad_iso     = ', ln_triad_iso
98         WRITE(numout,*) '      special Tgradts w ptl steps   ln_grad_zps     = ', ln_grad_zps
99         WRITE(numout,*) '      GM -->lat mixing on bottom    ln_botmix       = ', ln_botmix
100         WRITE(numout,*)
101      ENDIF
102
103      !                                ! convert DOCTOR namelist names into OLD names
104      aht0  = rn_aht_0
105      ahtb0 = rn_ahtb_0
106      aeiv0 = rn_aeiv_0
107
108      !                                ! Parameter control
109
110      ! ... Check consistency for type and direction :
111      !           ==> will be done in traldf module
112
113      ! ... Space variation of eddy coefficients
114      ioptio = 0
115#if defined key_traldf_c3d
116      IF(lwp) WRITE(numout,*) '          tracer mixing coef. = F( latitude, longitude, depth)'
117      ioptio = ioptio + 1
118#endif
119#if defined key_traldf_c2d
120      IF(lwp) WRITE(numout,*) '          tracer mixing coef. = F( latitude, longitude)'
121      ioptio = ioptio + 1
122#endif
123#if defined key_traldf_c1d
124      IF(lwp) WRITE(numout,*) '          tracer mixing coef. = F( depth )'
125      ioptio = ioptio + 1
126      IF( .NOT. ln_zco )   CALL ctl_stop( 'key_traldf_c1d can only be used in z-coordinate - full step' )
127#endif
128      IF( ioptio == 0 ) THEN
129          IF(lwp) WRITE(numout,*) '          tracer mixing coef. = constant (default option)'
130        ELSEIF( ioptio > 1 ) THEN
131           CALL ctl_stop('          use only one of the following keys:',   &
132             &           ' key_traldf_c3d, key_traldf_c2d, key_traldf_c1d' )
133      ENDIF
134
135      IF( ln_traldf_bilap ) THEN
136         IF(lwp) WRITE(numout,*) '          biharmonic tracer diffusion'
137         IF( aht0 > 0 .AND. .NOT. lk_esopa )   CALL ctl_stop( 'The horizontal diffusivity coef. aht0 must be negative' )
138      ELSE
139         IF(lwp) WRITE(numout,*) '          harmonic tracer diffusion (default)'
140         IF( aht0 < 0 .AND. .NOT. lk_esopa )   CALL ctl_stop('The horizontal diffusivity coef. aht0 must be positive' )
141      ENDIF
142
143
144      !  Lateral eddy diffusivity and eddy induced velocity coefficients
145      ! ================================================================
146#if defined key_traldf_c3d
147      CALL ldf_tra_c3d( ll_print )      ! aht = 3D coef. = F( longitude, latitude, depth )
148#elif defined key_traldf_c2d
149      CALL ldf_tra_c2d( ll_print )      ! aht = 2D coef. = F( longitude, latitude )
150#elif defined key_traldf_c1d
151      CALL ldf_tra_c1d( ll_print )      ! aht = 1D coef. = F( depth )
152#else
153                                        ! Constant coefficients
154      IF(lwp)WRITE(numout,*)
155      IF(lwp)WRITE(numout,*) '      constant eddy diffusivity coef.   ahtu = ahtv = ahtw = aht0 = ', aht0
156      IF( lk_traldf_eiv ) THEN
157         IF(lwp)WRITE(numout,*)
158         IF(lwp)WRITE(numout,*) '      constant eddy induced velocity coef.   aeiu = aeiv = aeiw = aeiv0 = ', aeiv0
159      ENDIF
160#endif
161      !
162   END SUBROUTINE ldf_tra_init
163
164#if defined key_traldf_c3d
165#   include "ldftra_c3d.h90"
166#elif defined key_traldf_c2d
167#   include "ldftra_c2d.h90"
168#elif defined key_traldf_c1d
169#   include "ldftra_c1d.h90"
170#endif
171
172   !!======================================================================
173END MODULE ldftra
Note: See TracBrowser for help on using the repository browser.