1 | MODULE 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 | PRIVATE tra_namelist |
---|
32 | |
---|
33 | !! * Substitutions |
---|
34 | # include "domzgr_substitute.h90" |
---|
35 | # include "vectopt_loop_substitute.h90" |
---|
36 | !!---------------------------------------------------------------------- |
---|
37 | !! NEMO/OPA 3.3 , NEMO Consortium (2010) |
---|
38 | !! $Id$ |
---|
39 | !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
---|
40 | !!---------------------------------------------------------------------- |
---|
41 | CONTAINS |
---|
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 | INTEGER :: ios ! temporary integer |
---|
66 | LOGICAL :: ll_print = .FALSE. ! =T print eddy coef. in numout |
---|
67 | !! |
---|
68 | NAMELIST/namtra_ldf/ ln_traldf_lap , ln_traldf_bilap, & |
---|
69 | & ln_traldf_level, ln_traldf_hor , ln_traldf_iso, & |
---|
70 | & ln_traldf_grif , ln_traldf_gdia , & |
---|
71 | & ln_triad_iso , ln_botmix_grif , & |
---|
72 | & rn_aht_0 , rn_ahtb_0 , rn_aeiv_0, & |
---|
73 | & rn_slpmax , rn_chsmag , rn_smsh, & |
---|
74 | & rn_aht_m |
---|
75 | !!---------------------------------------------------------------------- |
---|
76 | |
---|
77 | ! Define the lateral tracer physics parameters |
---|
78 | ! ============================================= |
---|
79 | |
---|
80 | IF(lwm) THEN |
---|
81 | REWIND( numnam_ref ) ! Namelist namtra_ldf in reference namelist : Lateral physics on tracers |
---|
82 | READ ( numnam_ref, namtra_ldf, IOSTAT = ios, ERR = 901) |
---|
83 | 901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtra_ldf in reference namelist', lwm ) |
---|
84 | REWIND( numnam_cfg ) ! Namelist namtra_ldf in configuration namelist : Lateral physics on tracers |
---|
85 | READ ( numnam_cfg, namtra_ldf, IOSTAT = ios, ERR = 902 ) |
---|
86 | 902 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtra_ldf in configuration namelist', lwm ) |
---|
87 | ENDIF |
---|
88 | IF(lwm) WRITE ( numond, namtra_ldf ) |
---|
89 | |
---|
90 | CALL tra_namelist() |
---|
91 | |
---|
92 | IF(lwp) THEN ! control print |
---|
93 | WRITE(numout,*) |
---|
94 | WRITE(numout,*) 'ldf_tra_init : lateral tracer physics' |
---|
95 | WRITE(numout,*) '~~~~~~~~~~~~ ' |
---|
96 | WRITE(numout,*) ' Namelist namtra_ldf : lateral mixing parameters (type, direction, coefficients)' |
---|
97 | WRITE(numout,*) ' laplacian operator ln_traldf_lap = ', ln_traldf_lap |
---|
98 | WRITE(numout,*) ' bilaplacian operator ln_traldf_bilap = ', ln_traldf_bilap |
---|
99 | WRITE(numout,*) ' iso-level ln_traldf_level = ', ln_traldf_level |
---|
100 | WRITE(numout,*) ' horizontal (geopotential) ln_traldf_hor = ', ln_traldf_hor |
---|
101 | WRITE(numout,*) ' iso-neutral ln_traldf_iso = ', ln_traldf_iso |
---|
102 | WRITE(numout,*) ' iso-neutral (Griffies) ln_traldf_grif = ', ln_traldf_grif |
---|
103 | WRITE(numout,*) ' Griffies strmfn diagnostics ln_traldf_gdia = ', ln_traldf_gdia |
---|
104 | WRITE(numout,*) ' lateral eddy diffusivity rn_aht_0 = ', rn_aht_0 |
---|
105 | WRITE(numout,*) ' background hor. diffusivity rn_ahtb_0 = ', rn_ahtb_0 |
---|
106 | WRITE(numout,*) ' eddy induced velocity coef. rn_aeiv_0 = ', rn_aeiv_0 |
---|
107 | WRITE(numout,*) ' maximum isoppycnal slope rn_slpmax = ', rn_slpmax |
---|
108 | WRITE(numout,*) ' pure lateral mixing in ML ln_triad_iso = ', ln_triad_iso |
---|
109 | WRITE(numout,*) ' lateral mixing on bottom ln_botmix_grif = ', ln_botmix_grif |
---|
110 | WRITE(numout,*) |
---|
111 | ENDIF |
---|
112 | |
---|
113 | ! ! convert DOCTOR namelist names into OLD names |
---|
114 | aht0 = rn_aht_0 |
---|
115 | ahtb0 = rn_ahtb_0 |
---|
116 | aeiv0 = rn_aeiv_0 |
---|
117 | |
---|
118 | ! ! Parameter control |
---|
119 | |
---|
120 | ! ... Check consistency for type and direction : |
---|
121 | ! ==> will be done in traldf module |
---|
122 | |
---|
123 | ! ... Space variation of eddy coefficients |
---|
124 | ioptio = 0 |
---|
125 | #if defined key_traldf_c3d |
---|
126 | IF(lwp) WRITE(numout,*) ' tracer mixing coef. = F( latitude, longitude, depth)' |
---|
127 | ioptio = ioptio + 1 |
---|
128 | #endif |
---|
129 | #if defined key_traldf_c2d |
---|
130 | IF(lwp) WRITE(numout,*) ' tracer mixing coef. = F( latitude, longitude)' |
---|
131 | ioptio = ioptio + 1 |
---|
132 | #endif |
---|
133 | #if defined key_traldf_c1d |
---|
134 | IF(lwp) WRITE(numout,*) ' tracer mixing coef. = F( depth )' |
---|
135 | ioptio = ioptio + 1 |
---|
136 | IF( .NOT. ln_zco ) CALL ctl_stop( 'key_traldf_c1d can only be used in z-coordinate - full step' ) |
---|
137 | #endif |
---|
138 | IF( ioptio == 0 ) THEN |
---|
139 | IF(lwp) WRITE(numout,*) ' tracer mixing coef. = constant (default option)' |
---|
140 | ELSEIF( ioptio > 1 ) THEN |
---|
141 | CALL ctl_stop(' use only one of the following keys:', & |
---|
142 | & ' key_traldf_c3d, key_traldf_c2d, key_traldf_c1d' ) |
---|
143 | ENDIF |
---|
144 | |
---|
145 | IF( ln_traldf_bilap ) THEN |
---|
146 | IF(lwp) WRITE(numout,*) ' biharmonic tracer diffusion' |
---|
147 | IF( aht0 > 0 .AND. .NOT. lk_esopa ) CALL ctl_stop( 'The horizontal diffusivity coef. aht0 must be negative' ) |
---|
148 | ELSE |
---|
149 | IF(lwp) WRITE(numout,*) ' harmonic tracer diffusion (default)' |
---|
150 | IF( aht0 < 0 .AND. .NOT. lk_esopa ) CALL ctl_stop('The horizontal diffusivity coef. aht0 must be positive' ) |
---|
151 | ENDIF |
---|
152 | |
---|
153 | |
---|
154 | ! Lateral eddy diffusivity and eddy induced velocity coefficients |
---|
155 | ! ================================================================ |
---|
156 | #if defined key_traldf_c3d |
---|
157 | CALL ldf_tra_c3d( ll_print ) ! aht = 3D coef. = F( longitude, latitude, depth ) |
---|
158 | #elif defined key_traldf_c2d |
---|
159 | CALL ldf_tra_c2d( ll_print ) ! aht = 2D coef. = F( longitude, latitude ) |
---|
160 | #elif defined key_traldf_c1d |
---|
161 | CALL ldf_tra_c1d( ll_print ) ! aht = 1D coef. = F( depth ) |
---|
162 | #else |
---|
163 | ! Constant coefficients |
---|
164 | IF(lwp)WRITE(numout,*) |
---|
165 | IF(lwp)WRITE(numout,*) ' constant eddy diffusivity coef. ahtu = ahtv = ahtw = aht0 = ', aht0 |
---|
166 | IF( lk_traldf_eiv ) THEN |
---|
167 | IF(lwp)WRITE(numout,*) ' constant eddy induced velocity coef. aeiu = aeiv = aeiw = aeiv0 = ', aeiv0 |
---|
168 | |
---|
169 | ENDIF |
---|
170 | #endif |
---|
171 | |
---|
172 | #if defined key_traldf_smag && ! defined key_traldf_c3d |
---|
173 | CALL ctl_stop( 'key_traldf_smag can only be used with key_traldf_c3d' ) |
---|
174 | #endif |
---|
175 | #if defined key_traldf_smag |
---|
176 | IF(lwp) WRITE(numout,*)' SMAGORINSKY DIFFUSION' |
---|
177 | IF(lwp .AND. rn_smsh < 1) WRITE(numout,*)' only shear is used ' |
---|
178 | IF(lwp.and.ln_traldf_bilap) CALL ctl_stop(' SMAGORINSKY + BILAPLACIAN - UNSTABLE OR NON_CONSERVATIVE' ) |
---|
179 | #endif |
---|
180 | |
---|
181 | ! |
---|
182 | END SUBROUTINE ldf_tra_init |
---|
183 | |
---|
184 | SUBROUTINE tra_namelist() |
---|
185 | !!--------------------------------------------------------------------- |
---|
186 | !! *** ROUTINE tra_namelist *** |
---|
187 | !! |
---|
188 | !! ** Purpose : Broadcast namelist variables read by procesor lwm |
---|
189 | !! |
---|
190 | !! ** Method : use lib_mpp |
---|
191 | !!---------------------------------------------------------------------- |
---|
192 | #if defined key_mpp_mpi |
---|
193 | CALL mpp_bcast(ln_traldf_lap) |
---|
194 | CALL mpp_bcast(ln_traldf_bilap) |
---|
195 | CALL mpp_bcast(ln_traldf_level) |
---|
196 | CALL mpp_bcast(ln_traldf_hor) |
---|
197 | CALL mpp_bcast(ln_traldf_iso) |
---|
198 | CALL mpp_bcast(ln_traldf_grif) |
---|
199 | CALL mpp_bcast(ln_traldf_gdia) |
---|
200 | CALL mpp_bcast(ln_triad_iso) |
---|
201 | CALL mpp_bcast(ln_botmix_grif) |
---|
202 | CALL mpp_bcast(rn_aht_0) |
---|
203 | CALL mpp_bcast(rn_ahtb_0) |
---|
204 | CALL mpp_bcast(rn_aeiv_0) |
---|
205 | CALL mpp_bcast(rn_slpmax) |
---|
206 | CALL mpp_bcast(rn_chsmag) |
---|
207 | CALL mpp_bcast(rn_smsh) |
---|
208 | CALL mpp_bcast(rn_aht_m) |
---|
209 | #endif |
---|
210 | END SUBROUTINE tra_namelist |
---|
211 | |
---|
212 | #if defined key_traldf_c3d |
---|
213 | # include "ldftra_c3d.h90" |
---|
214 | #elif defined key_traldf_c2d |
---|
215 | # include "ldftra_c2d.h90" |
---|
216 | #elif defined key_traldf_c1d |
---|
217 | # include "ldftra_c1d.h90" |
---|
218 | #endif |
---|
219 | |
---|
220 | !!====================================================================== |
---|
221 | END MODULE ldftra |
---|