1 |
C $Header: /u/gcmpack/MITgcm/model/src/packages_init_variables.F,v 1.60 2007/06/19 03:35:17 gforget Exp $ |
2 |
C $Name: $ |
3 |
|
4 |
#include "PACKAGES_CONFIG.h" |
5 |
#include "AD_CONFIG.h" |
6 |
#include "CPP_OPTIONS.h" |
7 |
|
8 |
CBOP |
9 |
C !ROUTINE: PACKAGES_INIT_VARIABLES |
10 |
C !INTERFACE: |
11 |
SUBROUTINE PACKAGES_INIT_VARIABLES( myThid ) |
12 |
|
13 |
C !DESCRIPTION: \bv |
14 |
C *==========================================================* |
15 |
C | SUBROUTINE PACKAGES_INIT_VARIABLES |
16 |
C | o Does initialisation of package-related variable data |
17 |
C *==========================================================* |
18 |
C \ev |
19 |
|
20 |
C !CALLING SEQUENCE: |
21 |
C PACKAGES_INIT_VARIABLES |
22 |
C | |
23 |
C |-- DIAGNOSTICS_INIT_VARIA |
24 |
C | |
25 |
C |-- GAD_GAD_INIT_VARIA |
26 |
C | |
27 |
C |-- CD_CODE_INI_VARS |
28 |
C | |
29 |
C |-- GMREDI_INIT |
30 |
C | |
31 |
C |-- KPP_INIT |
32 |
C |-- KPP_OPEN_DIAGS |
33 |
C | |
34 |
C |-- PP81_INIT |
35 |
C | |
36 |
C |-- MY82_INIT |
37 |
C | |
38 |
C |-- GGL90_INIT |
39 |
C | |
40 |
C |-- SEAICE_INIT_VARIA |
41 |
C | |
42 |
C |-- PTRACERS_INIT_VARIA |
43 |
C | |
44 |
C |-- GCHEM_INIT_VARI |
45 |
C | |
46 |
C |-- LAND_INI_VARS |
47 |
C | |
48 |
C |-- CTRL_INIT_VARIABLES |
49 |
C |-- CTRL_MAP_INI_ECCO |
50 |
C |-- CTRL_MAP_INI |
51 |
C | |
52 |
C |-- EXF_INIT |
53 |
C | |
54 |
C |-- EBM_INI_VARS |
55 |
C | |
56 |
C |-- COST_INIT_VARIA |
57 |
C | |
58 |
C |-- PROFILES_INIT_VARIA |
59 |
C | |
60 |
C |-- OBCS_INIT_VARIABLES |
61 |
C | |
62 |
C |-- BULKF_INIT_VARIA |
63 |
C | |
64 |
C |-- THSICE_INI_VARS |
65 |
C | |
66 |
C |-- CPL_INI_VARS |
67 |
C | |
68 |
C |-- ATM2D_INIT_VARS |
69 |
C | |
70 |
C |-- FIZHI_INI_VARS |
71 |
C | |
72 |
C |-- MATRIX_INIT |
73 |
C | |
74 |
C |-- RBCS_INIT_VARIA |
75 |
C | |
76 |
C |-- REGRID_INIT_VARIA |
77 |
C | |
78 |
C |-- MYPACKAGE_INIT_VARIA |
79 |
|
80 |
C !USES: |
81 |
IMPLICIT NONE |
82 |
C === Global variables === |
83 |
#include "SIZE.h" |
84 |
#include "EEPARAMS.h" |
85 |
#include "PARAMS.h" |
86 |
#ifdef ALLOW_AUTODIFF_TAMC |
87 |
# include "DYNVARS.h" |
88 |
# include "tamc.h" |
89 |
# include "tamc_keys.h" |
90 |
#endif |
91 |
|
92 |
C !INPUT/OUTPUT PARAMETERS: |
93 |
C === Routine arguments === |
94 |
C myThid - Number of this instances |
95 |
INTEGER myThid |
96 |
CEOP |
97 |
|
98 |
#ifdef ALLOW_DEBUG |
99 |
IF (debugMode) |
100 |
& CALL DEBUG_ENTER('PACKAGES_INIT_VARIABLES',myThid) |
101 |
#endif |
102 |
|
103 |
#ifdef ALLOW_DIAGNOSTICS |
104 |
IF ( useDiagnostics ) THEN |
105 |
CALL DIAGNOSTICS_INIT_VARIA( myThid ) |
106 |
ENDIF |
107 |
#endif |
108 |
|
109 |
#ifdef ALLOW_GENERIC_ADVDIFF |
110 |
#ifdef ALLOW_DEBUG |
111 |
IF (debugMode) CALL DEBUG_CALL('GAD_INIT_VARIA',myThid) |
112 |
#endif |
113 |
IF ( useGAD ) CALL GAD_INIT_VARIA( myThid ) |
114 |
#endif /* ALLOW_GENERIC_ADVDIFF */ |
115 |
|
116 |
#ifdef ALLOW_CD_CODE |
117 |
C-- Initialize CD_CODE variables: |
118 |
C- note(jmc): before packaging CD_CODE, was done within ini_fields (=called before), |
119 |
C therefore call CD-ini-vars before others pkg. |
120 |
#ifdef ALLOW_DEBUG |
121 |
IF (debugMode) CALL DEBUG_CALL('CD_CODE_INI',myThid) |
122 |
#endif |
123 |
IF (useCDscheme) CALL CD_CODE_INI_VARS( myThid ) |
124 |
#endif |
125 |
|
126 |
#ifdef ALLOW_GMREDI |
127 |
C-- Initialize GM/Redi parameterization |
128 |
#ifdef ALLOW_DEBUG |
129 |
IF (debugMode) CALL DEBUG_CALL('GMREDI_INIT',myThid) |
130 |
#endif |
131 |
IF (useGMRedi) CALL GMREDI_INIT( myThid ) |
132 |
#endif |
133 |
|
134 |
#ifdef ALLOW_KPP |
135 |
C-- Initialize KPP vertical mixing scheme. |
136 |
IF (useKPP) THEN |
137 |
#ifdef ALLOW_DEBUG |
138 |
IF (debugMode) |
139 |
& CALL DEBUG_CALL('KPP_INIT + KPP_OPEN_DIAGS',myThid) |
140 |
#endif |
141 |
CALL KPP_INIT( myThid ) |
142 |
CALL KPP_OPEN_DIAGS( myThid ) |
143 |
ENDIF |
144 |
#endif |
145 |
|
146 |
#ifdef ALLOW_PP81 |
147 |
C-- Initialize PP81 vertical mixing scheme. |
148 |
IF (usePP81) THEN |
149 |
#ifdef ALLOW_DEBUG |
150 |
IF (debugMode) CALL DEBUG_CALL('PP81_INIT',myThid) |
151 |
#endif |
152 |
CALL PP81_INIT( myThid ) |
153 |
ENDIF |
154 |
#endif |
155 |
|
156 |
#ifdef ALLOW_MY82 |
157 |
C-- Initialize MY82 vertical mixing scheme. |
158 |
IF (useMY82) THEN |
159 |
CALL MY82_INIT( myThid ) |
160 |
ENDIF |
161 |
#endif |
162 |
|
163 |
#ifdef ALLOW_GGL90 |
164 |
C-- Initialize GGL90 vertical mixing scheme. |
165 |
IF (useGGL90) THEN |
166 |
#ifdef ALLOW_DEBUG |
167 |
IF (debugMode) CALL DEBUG_CALL('GGL90_INIT',myThid) |
168 |
#endif |
169 |
CALL GGL90_INIT( myThid ) |
170 |
ENDIF |
171 |
#endif |
172 |
|
173 |
#ifdef ALLOW_SEAICE |
174 |
C-- Initialize SEAICE model. |
175 |
# ifdef ALLOW_DEBUG |
176 |
IF (debugMode) CALL DEBUG_CALL('SEAICE_INIT_VARIA',myThid) |
177 |
# endif |
178 |
# ifndef ALLOW_AUTODIFF_TAMC |
179 |
IF (useSEAICE) THEN |
180 |
# endif |
181 |
CALL SEAICE_INIT_VARIA( myThid ) |
182 |
# ifndef ALLOW_AUTODIFF_TAMC |
183 |
ENDIF |
184 |
# endif |
185 |
#endif |
186 |
|
187 |
cph-- moved further down |
188 |
cph#ifdef ALLOW_OBCS |
189 |
cphC-- Open boundaries data |
190 |
cph IF (useOBCS) THEN |
191 |
cph CALL OBCS_INIT_VARIABLES( myThid ) |
192 |
cph ENDIF |
193 |
cph#endif |
194 |
|
195 |
#ifdef ALLOW_PTRACERS |
196 |
# ifndef ALLOW_AUTODIFF_TAMC |
197 |
IF ( usePTRACERS ) THEN |
198 |
# endif |
199 |
#ifdef ALLOW_DEBUG |
200 |
IF (debugMode) CALL DEBUG_CALL('PTRACERS_INIT_VARIA',myThid) |
201 |
#endif |
202 |
CALL PTRACERS_INIT_VARIA( myThid ) |
203 |
#ifdef ALLOW_GCHEM |
204 |
# ifndef ALLOW_AUTODIFF_TAMC |
205 |
IF (useGCHEM) THEN |
206 |
# endif |
207 |
CALL GCHEM_INIT_VARI( myThid ) |
208 |
# ifndef ALLOW_AUTODIFF_TAMC |
209 |
ENDIF |
210 |
# endif |
211 |
#endif |
212 |
# ifndef ALLOW_AUTODIFF_TAMC |
213 |
ENDIF |
214 |
# endif |
215 |
#endif |
216 |
|
217 |
#ifdef ALLOW_LAND |
218 |
#ifdef ALLOW_DEBUG |
219 |
IF (debugMode) CALL DEBUG_CALL('LAND_INI_VARS',myThid) |
220 |
#endif |
221 |
IF ( useLAND ) CALL LAND_INI_VARS( myThid ) |
222 |
#endif |
223 |
|
224 |
#ifdef ALLOW_SMOOTH |
225 |
call smooth_init_varia(mythid) |
226 |
#endif |
227 |
|
228 |
#ifdef ALLOW_AUTODIFF |
229 |
CADJ STORE theta = tapelev_init, key = 1 |
230 |
c-- Initialise auxiliary xx_ fields |
231 |
CALL CTRL_INIT_VARIABLES ( myThid ) |
232 |
c-- Map the control variables onto the model state. |
233 |
# ifdef ALLOW_ECCO |
234 |
CALL CTRL_MAP_INI_ECCO( myThid ) |
235 |
# else |
236 |
CALL CTRL_MAP_INI( myThid ) |
237 |
# endif |
238 |
_BARRIER |
239 |
#endif |
240 |
|
241 |
#ifdef ALLOW_EXF |
242 |
IF (useEXF) THEN |
243 |
#ifdef ALLOW_DEBUG |
244 |
IF (debugMode) CALL DEBUG_CALL('EXF_INIT',myThid) |
245 |
#endif |
246 |
CALL EXF_INIT( myThid ) |
247 |
ENDIF |
248 |
#endif |
249 |
|
250 |
#ifdef ALLOW_EBM |
251 |
# ifdef ALLOW_AUTODIFF |
252 |
CADJ STORE theta = tapelev_init, key = 1 |
253 |
# endif |
254 |
IF (useEBM) CALL EBM_INI_VARS( myThid ) |
255 |
#endif |
256 |
|
257 |
#ifdef ALLOW_COST |
258 |
c-- Initialise the cost function. |
259 |
ceh3 needs an IF ( useCOST ) THEN |
260 |
CALL COST_INIT_VARIA( myThid ) |
261 |
_BARRIER |
262 |
#endif |
263 |
|
264 |
#ifdef ALLOW_PROFILES |
265 |
c-- Initialise the cost function. |
266 |
CALL PROFILES_INIT_VARIA( myThid ) |
267 |
_BARRIER |
268 |
#endif |
269 |
|
270 |
#ifdef ALLOW_OBCS |
271 |
C-- Open boundaries data |
272 |
#ifdef ALLOW_DEBUG |
273 |
IF (debugMode) CALL DEBUG_CALL('OBCS_INIT_VARIABLES',myThid) |
274 |
#endif |
275 |
IF (useOBCS) CALL OBCS_INIT_VARIABLES( myThid ) |
276 |
#endif |
277 |
|
278 |
#ifdef ALLOW_BULK_FORCE |
279 |
IF (useBulkForce) CALL BULKF_INIT_VARIA( myThid) |
280 |
#endif |
281 |
|
282 |
#ifdef ALLOW_THSICE |
283 |
#ifdef ALLOW_DEBUG |
284 |
IF (debugMode) CALL DEBUG_CALL('THSICE_INI_VARS',myThid) |
285 |
#endif |
286 |
IF (useThSIce) CALL THSICE_INI_VARS( myThid) |
287 |
#endif |
288 |
|
289 |
#ifdef COMPONENT_MODULE |
290 |
#ifdef ALLOW_DEBUG |
291 |
IF (debugMode) CALL DEBUG_CALL('CPL_INI_VARS',myThid) |
292 |
#endif |
293 |
IF (useCoupler) CALL CPL_INI_VARS( myThid ) |
294 |
#endif |
295 |
|
296 |
#ifdef ALLOW_ATM2D |
297 |
#ifdef ALLOW_DEBUG |
298 |
IF (debugMode) CALL DEBUG_CALL('ATM2D_INIT_VARS',myThid) |
299 |
#endif |
300 |
IF (useAtm2d) CALL ATM2D_INIT_VARS( myThid ) |
301 |
#endif |
302 |
|
303 |
#ifdef ALLOW_FIZHI |
304 |
C Initialize FIZHI state variables |
305 |
#ifdef ALLOW_DEBUG |
306 |
IF (debugMode) CALL DEBUG_CALL('FIZHI_INIT_VARS',myThid) |
307 |
#endif |
308 |
IF (useFIZHI) CALL FIZHI_INIT_VARS( myThid ) |
309 |
#endif |
310 |
|
311 |
#ifdef ALLOW_MATRIX |
312 |
#ifdef ALLOW_DEBUG |
313 |
IF (debugMode) CALL DEBUG_CALL('MATRIX_INIT',myThid) |
314 |
#endif |
315 |
IF ( useMATRIX ) CALL MATRIX_INIT( myThid ) |
316 |
#endif |
317 |
|
318 |
#ifdef ALLOW_RBCS |
319 |
IF ( useRBCS ) CALL RBCS_INIT_VARIA( myThid ) |
320 |
#endif |
321 |
|
322 |
#ifdef ALLOW_REGRID |
323 |
IF ( useREGRID ) CALL REGRID_INIT_VARIA( myThid ) |
324 |
#endif |
325 |
|
326 |
#ifdef ALLOW_MYPACKAGE |
327 |
IF ( useMYPACKAGE ) CALL MYPACKAGE_INIT_VARIA( myThid ) |
328 |
#endif |
329 |
|
330 |
#ifdef ALLOW_DEBUG |
331 |
IF (debugMode) |
332 |
& CALL DEBUG_LEAVE('PACKAGES_INIT_VARIABLES',myThid) |
333 |
#endif |
334 |
|
335 |
RETURN |
336 |
END |