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 trunk/NEMOGCM/NEMO/OPA_SRC/LDF – NEMO

source: trunk/NEMOGCM/NEMO/OPA_SRC/LDF/ldftra.F90 @ 3389

Last change on this file since 3389 was 3294, checked in by rblod, 12 years ago

Merge of 3.4beta into the trunk
  • Property svn:keywords set to Id
File size: 8.3 KB
RevLine 
[3]1MODULE ldftra
2   !!======================================================================
3   !!                       ***  MODULE  ldftra  ***
4   !! Ocean physics:  lateral diffusivity coefficient
5   !!=====================================================================
[1601]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) 
[3]9   !!----------------------------------------------------------------------
[1601]10
11   !!----------------------------------------------------------------------
[3]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
[1601]23   USE ioipsl
[3]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
[1601]30   PUBLIC   ldf_tra_init   ! called by opa.F90
[3]31
32   !! * Substitutions
[148]33#  include "domzgr_substitute.h90"
[3]34#  include "vectopt_loop_substitute.h90"
[1601]35   !!----------------------------------------------------------------------
[2528]36   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
[1152]37   !! $Id$
[2715]38   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
[1601]39   !!----------------------------------------------------------------------
[3]40CONTAINS
41
42   SUBROUTINE ldf_tra_init
43      !!----------------------------------------------------------------------
44      !!                  ***  ROUTINE ldf_tra_init  ***
45      !!
[461]46      !! ** Purpose :   initializations of the tracer lateral mixing coeff.
[3]47      !!
[461]48      !! ** Method  :   the Eddy diffusivity and eddy induced velocity ceoff.
49      !!      are defined as follows:
[3]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      !!----------------------------------------------------------------------
[1601]63      INTEGER ::   ioptio               ! temporary integer
[3]64      LOGICAL ::   ll_print = .FALSE.   ! =T print eddy coef. in numout
[1601]65      !!
66      NAMELIST/namtra_ldf/ ln_traldf_lap  , ln_traldf_bilap,                  &
67         &                 ln_traldf_level, ln_traldf_hor  , ln_traldf_iso,   &
[2528]68         &                 ln_traldf_grif , ln_traldf_gdia,                   &
[3294]69         &                 ln_triad_iso   , ln_botmix_grif,                   &
[2528]70         &                 rn_aht_0       , rn_ahtb_0      , rn_aeiv_0,       &
71         &                 rn_slpmax
[3]72      !!----------------------------------------------------------------------
73
74      !  Define the lateral tracer physics parameters
75      ! =============================================
76   
[1601]77      REWIND( numnam )                  ! Read Namelist namtra_ldf : Lateral physics on tracers
78      READ  ( numnam, namtra_ldf )
[3]79
[1601]80      IF(lwp) THEN                      ! control print
[3]81         WRITE(numout,*)
[461]82         WRITE(numout,*) 'ldf_tra_init : lateral tracer physics'
83         WRITE(numout,*) '~~~~~~~~~~~~ '
[2528]84         WRITE(numout,*) '   Namelist namtra_ldf : lateral mixing parameters (type, direction, coefficients)'
[1601]85         WRITE(numout,*) '      laplacian operator            ln_traldf_lap   = ', ln_traldf_lap
86         WRITE(numout,*) '      bilaplacian operator          ln_traldf_bilap = ', ln_traldf_bilap
[2528]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
[1601]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
[2528]95         WRITE(numout,*) '      maximum isoppycnal slope      rn_slpmax       = ', rn_slpmax
[3294]96         WRITE(numout,*) '      pure lateral mixing in ML     ln_triad_iso    = ', ln_triad_iso
97         WRITE(numout,*) '      lateral mixing on bottom      ln_botmix_grif  = ', ln_botmix_grif
[3]98         WRITE(numout,*)
99      ENDIF
100
[1601]101      !                                ! convert DOCTOR namelist names into OLD names
102      aht0  = rn_aht_0
103      ahtb0 = rn_ahtb_0
104      aeiv0 = rn_aeiv_0
[3]105
[1601]106      !                                ! Parameter control
107
[461]108      ! ... Check consistency for type and direction :
109      !           ==> will be done in traldf module
[3]110
111      ! ... Space variation of eddy coefficients
112      ioptio = 0
113#if defined key_traldf_c3d
114      IF(lwp) WRITE(numout,*) '          tracer mixing coef. = F( latitude, longitude, depth)'
115      ioptio = ioptio + 1
116#endif
117#if defined key_traldf_c2d
118      IF(lwp) WRITE(numout,*) '          tracer mixing coef. = F( latitude, longitude)'
119      ioptio = ioptio + 1
120#endif
121#if defined key_traldf_c1d
122      IF(lwp) WRITE(numout,*) '          tracer mixing coef. = F( depth )'
123      ioptio = ioptio + 1
[1601]124      IF( .NOT. ln_zco )   CALL ctl_stop( 'key_traldf_c1d can only be used in z-coordinate - full step' )
[3]125#endif
126      IF( ioptio == 0 ) THEN
127          IF(lwp) WRITE(numout,*) '          tracer mixing coef. = constant (default option)'
128        ELSEIF( ioptio > 1 ) THEN
[474]129           CALL ctl_stop('          use only one of the following keys:',   &
130             &           ' key_traldf_c3d, key_traldf_c2d, key_traldf_c1d' )
[3]131      ENDIF
132
[461]133      IF( ln_traldf_bilap ) THEN
[3]134         IF(lwp) WRITE(numout,*) '          biharmonic tracer diffusion'
[1601]135         IF( aht0 > 0 .AND. .NOT. lk_esopa )   CALL ctl_stop( 'The horizontal diffusivity coef. aht0 must be negative' )
[3]136      ELSE
137         IF(lwp) WRITE(numout,*) '          harmonic tracer diffusion (default)'
[1601]138         IF( aht0 < 0 .AND. .NOT. lk_esopa )   CALL ctl_stop('The horizontal diffusivity coef. aht0 must be positive' )
[3]139      ENDIF
140
141
142      !  Lateral eddy diffusivity and eddy induced velocity coefficients
143      ! ================================================================
144#if defined key_traldf_c3d
[461]145      CALL ldf_tra_c3d( ll_print )      ! aht = 3D coef. = F( longitude, latitude, depth )
[3]146#elif defined key_traldf_c2d
[461]147      CALL ldf_tra_c2d( ll_print )      ! aht = 2D coef. = F( longitude, latitude )
[3]148#elif defined key_traldf_c1d
[461]149      CALL ldf_tra_c1d( ll_print )      ! aht = 1D coef. = F( depth )
[3]150#else
[461]151                                        ! Constant coefficients
[3]152      IF(lwp)WRITE(numout,*)
[1601]153      IF(lwp)WRITE(numout,*) '      constant eddy diffusivity coef.   ahtu = ahtv = ahtw = aht0 = ', aht0
[3]154      IF( lk_traldf_eiv ) THEN
155         IF(lwp)WRITE(numout,*)
[1601]156         IF(lwp)WRITE(numout,*) '      constant eddy induced velocity coef.   aeiu = aeiv = aeiw = aeiv0 = ', aeiv0
[3]157      ENDIF
158#endif
[1601]159      !
[3]160   END SUBROUTINE ldf_tra_init
161
162#if defined key_traldf_c3d
163#   include "ldftra_c3d.h90"
164#elif defined key_traldf_c2d
165#   include "ldftra_c2d.h90"
166#elif defined key_traldf_c1d
167#   include "ldftra_c1d.h90"
168#endif
169
170   !!======================================================================
171END MODULE ldftra
Note: See TracBrowser for help on using the repository browser.