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

source: trunk/NEMO/OPA_SRC/LDF/ldftra.F90 @ 1601

Last change on this file since 1601 was 1601, checked in by ctlod, 15 years ago

Doctor naming of OPA namelist variables , see ticket: #526

  • Property svn:eol-style set to native
  • Property svn:executable set to *
  • Property svn:keywords set to Id
File size: 7.3 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.2 , LOCEAN-IPSL (2009)
37   !! $Id$
38   !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt)
39   !!----------------------------------------------------------------------
40
41CONTAINS
42
43   SUBROUTINE ldf_tra_init
44      !!----------------------------------------------------------------------
45      !!                  ***  ROUTINE ldf_tra_init  ***
46      !!
47      !! ** Purpose :   initializations of the tracer lateral mixing coeff.
48      !!
49      !! ** Method  :   the Eddy diffusivity and eddy induced velocity ceoff.
50      !!      are defined as follows:
51      !!         default option   : constant coef. aht0, aeiv0 (namelist)
52      !!        'key_traldf_c1d': depth dependent coef. defined in
53      !!                            in ldf_tra_c1d routine
54      !!        'key_traldf_c2d': latitude and longitude dependent coef.
55      !!                            defined in ldf_tra_c2d routine
56      !!        'key_traldf_c3d': latitude, longitude, depth dependent coef.
57      !!                            defined in ldf_tra_c3d routine
58      !!
59      !!      N.B. User defined include files.  By default, 3d and 2d coef.
60      !!      are set to a constant value given in the namelist and the 1d
61      !!      coefficients are initialized to a hyperbolic tangent vertical
62      !!      profile.
63      !!----------------------------------------------------------------------
64      INTEGER ::   ioptio               ! temporary integer
65      LOGICAL ::   ll_print = .FALSE.   ! =T print eddy coef. in numout
66      !!
67      NAMELIST/namtra_ldf/ ln_traldf_lap  , ln_traldf_bilap,                  &
68         &                 ln_traldf_level, ln_traldf_hor  , ln_traldf_iso,   &
69         &                 rn_aht_0       , rn_ahtb_0      , rn_aeiv_0
70      !!----------------------------------------------------------------------
71
72      !  Define the lateral tracer physics parameters
73      ! =============================================
74   
75      REWIND( numnam )                  ! Read Namelist namtra_ldf : Lateral physics on tracers
76      READ  ( numnam, namtra_ldf )
77
78      IF(lwp) THEN                      ! control print
79         WRITE(numout,*)
80         WRITE(numout,*) 'ldf_tra_init : lateral tracer physics'
81         WRITE(numout,*) '~~~~~~~~~~~~ '
82         WRITE(numout,*) '   Namelist namtra_ldf : lateral mixing coefficients'
83         WRITE(numout,*) '      laplacian operator            ln_traldf_lap   = ', ln_traldf_lap
84         WRITE(numout,*) '      bilaplacian operator          ln_traldf_bilap = ', ln_traldf_bilap
85         WRITE(numout,*) '      lateral eddy diffusivity      rn_aht_0        = ', rn_aht_0
86         WRITE(numout,*) '      background hor. diffusivity   rn_ahtb_0       = ', rn_ahtb_0
87         WRITE(numout,*) '      eddy induced velocity coef.   rn_aeiv_0       = ', rn_aeiv_0
88         WRITE(numout,*)
89      ENDIF
90
91      !                                ! convert DOCTOR namelist names into OLD names
92      aht0  = rn_aht_0
93      ahtb0 = rn_ahtb_0
94      aeiv0 = rn_aeiv_0
95
96      !                                ! Parameter control
97
98      ! ... Check consistency for type and direction :
99      !           ==> will be done in traldf module
100
101      ! ... Space variation of eddy coefficients
102      ioptio = 0
103#if defined key_traldf_c3d
104      IF(lwp) WRITE(numout,*) '          tracer mixing coef. = F( latitude, longitude, depth)'
105      ioptio = ioptio + 1
106#endif
107#if defined key_traldf_c2d
108      IF(lwp) WRITE(numout,*) '          tracer mixing coef. = F( latitude, longitude)'
109      ioptio = ioptio + 1
110#endif
111#if defined key_traldf_c1d
112      IF(lwp) WRITE(numout,*) '          tracer mixing coef. = F( depth )'
113      ioptio = ioptio + 1
114      IF( .NOT. ln_zco )   CALL ctl_stop( 'key_traldf_c1d can only be used in z-coordinate - full step' )
115#endif
116      IF( ioptio == 0 ) THEN
117          IF(lwp) WRITE(numout,*) '          tracer mixing coef. = constant (default option)'
118        ELSEIF( ioptio > 1 ) THEN
119           CALL ctl_stop('          use only one of the following keys:',   &
120             &           ' key_traldf_c3d, key_traldf_c2d, key_traldf_c1d' )
121      ENDIF
122
123      IF( ln_traldf_bilap ) THEN
124         IF(lwp) WRITE(numout,*) '          biharmonic tracer diffusion'
125         IF( aht0 > 0 .AND. .NOT. lk_esopa )   CALL ctl_stop( 'The horizontal diffusivity coef. aht0 must be negative' )
126      ELSE
127         IF(lwp) WRITE(numout,*) '          harmonic tracer diffusion (default)'
128         IF( aht0 < 0 .AND. .NOT. lk_esopa )   CALL ctl_stop('The horizontal diffusivity coef. aht0 must be positive' )
129      ENDIF
130
131
132      !  Lateral eddy diffusivity and eddy induced velocity coefficients
133      ! ================================================================
134#if defined key_traldf_c3d
135      CALL ldf_tra_c3d( ll_print )      ! aht = 3D coef. = F( longitude, latitude, depth )
136#elif defined key_traldf_c2d
137      CALL ldf_tra_c2d( ll_print )      ! aht = 2D coef. = F( longitude, latitude )
138#elif defined key_traldf_c1d
139      CALL ldf_tra_c1d( ll_print )      ! aht = 1D coef. = F( depth )
140#else
141                                        ! Constant coefficients
142      IF(lwp)WRITE(numout,*)
143      IF(lwp)WRITE(numout,*) '      constant eddy diffusivity coef.   ahtu = ahtv = ahtw = aht0 = ', aht0
144      IF( lk_traldf_eiv ) THEN
145         IF(lwp)WRITE(numout,*)
146         IF(lwp)WRITE(numout,*) '      constant eddy induced velocity coef.   aeiu = aeiv = aeiw = aeiv0 = ', aeiv0
147      ENDIF
148#endif
149      !
150   END SUBROUTINE ldf_tra_init
151
152#if defined key_traldf_c3d
153#   include "ldftra_c3d.h90"
154#elif defined key_traldf_c2d
155#   include "ldftra_c2d.h90"
156#elif defined key_traldf_c1d
157#   include "ldftra_c1d.h90"
158#endif
159
160   !!======================================================================
161END MODULE ldftra
Note: See TracBrowser for help on using the repository browser.