/[MITgcm]/MITgcm/model/src/packages_init_variables.F
ViewVC logotype

Annotation of /MITgcm/model/src/packages_init_variables.F

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.78 - (hide annotations) (download)
Tue Apr 6 20:58:44 2010 UTC (14 years, 2 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint62g, checkpoint62f, checkpoint62e, checkpoint62k, checkpoint62j, checkpoint62i, checkpoint62h, checkpoint62o, checkpoint62n, checkpoint62m, checkpoint62l
Changes since 1.77: +2 -2 lines
fix a comment.

1 jmc 1.78 C $Header: /u/gcmpack/MITgcm/model/src/packages_init_variables.F,v 1.77 2010/01/20 23:33:45 dimitri Exp $
2 edhill 1.24 C $Name: $
3 adcroft 1.2
4 edhill 1.24 #include "PACKAGES_CONFIG.h"
5 heimbach 1.34 #include "AD_CONFIG.h"
6 adcroft 1.2 #include "CPP_OPTIONS.h"
7    
8 cnh 1.8 CBOP
9     C !ROUTINE: PACKAGES_INIT_VARIABLES
10     C !INTERFACE:
11 adcroft 1.2 SUBROUTINE PACKAGES_INIT_VARIABLES( myThid )
12 cnh 1.8
13     C !DESCRIPTION: \bv
14     C *==========================================================*
15 jmc 1.49 C | SUBROUTINE PACKAGES_INIT_VARIABLES
16     C | o Does initialisation of package-related variable data
17 cnh 1.8 C *==========================================================*
18     C \ev
19    
20     C !CALLING SEQUENCE:
21     C PACKAGES_INIT_VARIABLES
22     C |
23 jmc 1.54 C |-- DIAGNOSTICS_INIT_VARIA
24     C |
25 jmc 1.58 C |-- GAD_GAD_INIT_VARIA
26     C |
27 jmc 1.29 C |-- CD_CODE_INI_VARS
28     C |
29 cnh 1.8 C |-- GMREDI_INIT
30     C |
31 jmc 1.68 C |-- DWNSLP_INIT_VARIA
32     C |
33 jmc 1.72 C |-- KPP_INIT_VARIA
34 cnh 1.8 C |
35 jmc 1.72 C |-- PP81_INIT_VARIA
36 mlosch 1.35 C |
37 mlosch 1.65 C |-- MY82_INIT_VARIA
38 mlosch 1.35 C |
39 dfer 1.70 C |-- GGL90_INIT_VARIA
40 mlosch 1.36 C |
41 heimbach 1.56 C |-- SEAICE_INIT_VARIA
42 jmc 1.49 C |
43 mlosch 1.69 C |-- SHELFICE_INIT_VARIA
44     C |
45 dimitri 1.77 C |-- ICEFRONT_INIT_VARIA
46     C |
47 jmc 1.54 C |-- PTRACERS_INIT_VARIA
48 heimbach 1.14 C |
49 jmc 1.54 C |-- GCHEM_INIT_VARI
50 cnh 1.8 C |
51 jmc 1.19 C |-- LAND_INI_VARS
52     C |
53 jmc 1.54 C |-- CTRL_INIT_VARIABLES
54     C |-- CTRL_MAP_INI_ECCO
55 cnh 1.8 C |-- CTRL_MAP_INI
56     C |
57 dimitri 1.18 C |-- EXF_INIT
58     C |
59 jmc 1.54 C |-- EBM_INI_VARS
60     C |
61     C |-- COST_INIT_VARIA
62 dimitri 1.18 C |
63 jmc 1.54 C |-- PROFILES_INIT_VARIA
64     C |
65 jmc 1.71 C |-- FLT_INIT_VARIA
66     C |
67 jmc 1.54 C |-- OBCS_INIT_VARIABLES
68 cnh 1.8 C |
69 jmc 1.49 C |-- BULKF_INIT_VARIA
70 cnh 1.8 C |
71 jmc 1.28 C |-- THSICE_INI_VARS
72 jmc 1.30 C |
73 jmc 1.76 C |-- NEST_CHILD_INIT_VARIA
74     C |-- NEST_PARENT_INIT_VARIA
75     C |
76 jmc 1.30 C |-- CPL_INI_VARS
77 edhill 1.53 C |
78 jscott 1.55 C |-- ATM2D_INIT_VARS
79     C |
80 jmc 1.54 C |-- FIZHI_INI_VARS
81     C |
82     C |-- MATRIX_INIT
83     C |
84     C |-- RBCS_INIT_VARIA
85     C |
86     C |-- REGRID_INIT_VARIA
87     C |
88 rpa 1.74 C |-- LAYERS_INIT_VARIA
89     C |
90 dimitri 1.63 C |-- SALT_PLUME_INIT_VARIA
91 jmc 1.67 C |
92     C |-- CHEAPAML_INIT_VARIA
93 jmc 1.68 C |
94     C |-- MYPACKAGE_INIT_VARIA
95 cnh 1.8
96     C !USES:
97 adcroft 1.2 IMPLICIT NONE
98     C === Global variables ===
99     #include "SIZE.h"
100     #include "EEPARAMS.h"
101     #include "PARAMS.h"
102 heimbach 1.34 #ifdef ALLOW_AUTODIFF_TAMC
103     # include "DYNVARS.h"
104     # include "tamc.h"
105     # include "tamc_keys.h"
106     #endif
107 adcroft 1.2
108 cnh 1.8 C !INPUT/OUTPUT PARAMETERS:
109 adcroft 1.2 C === Routine arguments ===
110     C myThid - Number of this instances
111     INTEGER myThid
112 cnh 1.8 CEOP
113 jmc 1.29
114 adcroft 1.39 #ifdef ALLOW_DEBUG
115 jmc 1.49 IF (debugMode)
116 edhill 1.40 & CALL DEBUG_ENTER('PACKAGES_INIT_VARIABLES',myThid)
117 jmc 1.68 #endif /* ALLOW_DEBUG */
118 adcroft 1.39
119 molod 1.45 #ifdef ALLOW_DIAGNOSTICS
120     IF ( useDiagnostics ) THEN
121     CALL DIAGNOSTICS_INIT_VARIA( myThid )
122     ENDIF
123 jmc 1.68 #endif /* ALLOW_DIAGNOSTICS */
124 molod 1.45
125 jmc 1.58 #ifdef ALLOW_GENERIC_ADVDIFF
126 jmc 1.68 IF ( useGAD ) THEN
127     # ifdef ALLOW_DEBUG
128     IF (debugMode) CALL DEBUG_CALL('GAD_INIT_VARIA',myThid)
129     # endif
130     CALL GAD_INIT_VARIA( myThid )
131     ENDIF
132 jmc 1.58 #endif /* ALLOW_GENERIC_ADVDIFF */
133    
134 jmc 1.29 #ifdef ALLOW_CD_CODE
135 jmc 1.49 C-- Initialize CD_CODE variables:
136 jmc 1.29 C- note(jmc): before packaging CD_CODE, was done within ini_fields (=called before),
137     C therefore call CD-ini-vars before others pkg.
138 jmc 1.68 IF (useCDscheme) THEN
139     # ifdef ALLOW_DEBUG
140     IF (debugMode) CALL DEBUG_CALL('CD_CODE_INI_VARS',myThid)
141     # endif
142     CALL CD_CODE_INI_VARS( myThid )
143     ENDIF
144     #endif /* ALLOW_CD_CODE */
145 adcroft 1.2
146     #ifdef ALLOW_GMREDI
147     C-- Initialize GM/Redi parameterization
148 jmc 1.68 IF (useGMRedi) THEN
149     # ifdef ALLOW_DEBUG
150     IF (debugMode) CALL DEBUG_CALL('GMREDI_INIT',myThid)
151     # endif
152     CALL GMREDI_INIT( myThid )
153     ENDIF
154     #endif /* ALLOW_GMREDI */
155    
156     #ifdef ALLOW_DOWN_SLOPE
157     IF ( useDOWN_SLOPE ) THEN
158     CALL DWNSLP_INIT_VARIA( myThid )
159     ENDIF
160     #endif /* ALLOW_DOWN_SLOPE */
161 adcroft 1.2
162     #ifdef ALLOW_KPP
163     C-- Initialize KPP vertical mixing scheme.
164     IF (useKPP) THEN
165 jmc 1.68 # ifdef ALLOW_DEBUG
166 jmc 1.72 IF (debugMode) CALL DEBUG_CALL('KPP_INIT_VARIA',myThid)
167 jmc 1.68 # endif
168 jmc 1.72 CALL KPP_INIT_VARIA( myThid )
169 adcroft 1.2 ENDIF
170 jmc 1.68 #endif /* ALLOW_KPP */
171 heimbach 1.14
172 mlosch 1.35 #ifdef ALLOW_PP81
173     C-- Initialize PP81 vertical mixing scheme.
174     IF (usePP81) THEN
175 jmc 1.68 # ifdef ALLOW_DEBUG
176 jmc 1.72 IF (debugMode) CALL DEBUG_CALL('PP81_INIT_VARIA',myThid)
177 jmc 1.68 # endif
178 jmc 1.72 CALL PP81_INIT_VARIA( myThid )
179 mlosch 1.35 ENDIF
180 jmc 1.68 #endif /* ALLOW_PP81 */
181 mlosch 1.35
182     #ifdef ALLOW_MY82
183 mlosch 1.36 C-- Initialize MY82 vertical mixing scheme.
184 mlosch 1.35 IF (useMY82) THEN
185 mlosch 1.65 CALL MY82_INIT_VARIA( myThid )
186 mlosch 1.35 ENDIF
187 jmc 1.68 #endif /* ALLOW_MY82 */
188 mlosch 1.35
189 mlosch 1.36 #ifdef ALLOW_GGL90
190     C-- Initialize GGL90 vertical mixing scheme.
191     IF (useGGL90) THEN
192 dfer 1.70 #ifdef ALLOW_DEBUG
193     IF (debugMode) CALL DEBUG_CALL('GGL90_INIT_VARIA',myThid)
194     #endif
195     CALL GGL90_INIT_VARIA( myThid )
196 mlosch 1.36 ENDIF
197 jmc 1.68 #endif /* ALLOW_GGL90 */
198 mlosch 1.36
199 heimbach 1.14 #ifdef ALLOW_SEAICE
200     C-- Initialize SEAICE model.
201 heimbach 1.62 cph# ifndef ALLOW_AUTODIFF_TAMC
202 heimbach 1.61 IF (useSEAICE) THEN
203 heimbach 1.62 cph# endif
204 jmc 1.68 # ifdef ALLOW_DEBUG
205     IF (debugMode) CALL DEBUG_CALL('SEAICE_INIT_VARIA',myThid)
206     # endif
207 heimbach 1.61 CALL SEAICE_INIT_VARIA( myThid )
208 heimbach 1.62 cph# ifndef ALLOW_AUTODIFF_TAMC
209 heimbach 1.61 ENDIF
210 heimbach 1.62 cph# endif
211 jmc 1.68 #endif /* ALLOW_SEAICE */
212 adcroft 1.2
213 mlosch 1.69 #ifdef ALLOW_SHELFICE
214     IF (useShelfIce) THEN
215     # ifdef ALLOW_DEBUG
216     IF (debugMode) CALL DEBUG_CALL('SHELFICE_INIT_VARIA',myThid)
217     # endif
218     CALL SHELFICE_INIT_VARIA( myThid )
219     ENDIF
220     #endif /* ALLOW_SHELFICE */
221    
222 dimitri 1.77 #ifdef ALLOW_ICEFRONT
223     IF (useICEFRONT) THEN
224     # ifdef ALLOW_DEBUG
225     IF (debugMode) CALL DEBUG_CALL('ICEFRONT_INIT_VARIA',myThid)
226     # endif
227     CALL ICEFRONT_INIT_VARIA( myThid )
228     ENDIF
229     #endif /* ALLOW_ICEFRONT */
230    
231 heimbach 1.20 cph-- moved further down
232     cph#ifdef ALLOW_OBCS
233     cphC-- Open boundaries data
234     cph IF (useOBCS) THEN
235     cph CALL OBCS_INIT_VARIABLES( myThid )
236     cph ENDIF
237     cph#endif
238 adcroft 1.11
239     #ifdef ALLOW_PTRACERS
240 heimbach 1.22 # ifndef ALLOW_AUTODIFF_TAMC
241     IF ( usePTRACERS ) THEN
242     # endif
243 jmc 1.68 # ifdef ALLOW_DEBUG
244     IF (debugMode) CALL DEBUG_CALL('PTRACERS_INIT_VARIA',myThid)
245     # endif
246     CALL PTRACERS_INIT_VARIA( myThid )
247 jahn 1.73 # ifdef ALLOW_LONGSTEP
248     # ifdef ALLOW_DEBUG
249     IF (debugMode) CALL DEBUG_CALL('LONGSTEP_INIT_VARIA',myThid)
250     # endif
251     CALL LONGSTEP_INIT_VARIA( myThid )
252     # endif /* ALLOW_LONGSTEP */
253 mlosch 1.41 # ifndef ALLOW_AUTODIFF_TAMC
254 jmc 1.68 ENDIF
255 mlosch 1.41 # endif
256 jmc 1.68 #endif /* ALLOW_PTRACERS */
257    
258 heimbach 1.75 #ifdef ALLOW_OFFLINE
259     # ifndef ALLOW_AUTODIFF_TAMC
260     IF ( useOFFLINE ) THEN
261     # endif
262     CALL OFFLINE_INIT_VARIA( myThid )
263     # ifndef ALLOW_AUTODIFF_TAMC
264     ENDIF
265     # endif
266 jmc 1.78 #endif /* ALLOW_OFFLINE */
267 heimbach 1.75
268 jmc 1.68 #ifdef ALLOW_GCHEM
269 mlosch 1.41 # ifndef ALLOW_AUTODIFF_TAMC
270 jmc 1.68 IF (useGCHEM) THEN
271 mlosch 1.41 # endif
272 jmc 1.68 CALL GCHEM_INIT_VARI( myThid )
273 heimbach 1.22 # ifndef ALLOW_AUTODIFF_TAMC
274     ENDIF
275     # endif
276 jmc 1.68 #endif /* ALLOW_GCHEM */
277 jmc 1.19
278     #ifdef ALLOW_LAND
279 jmc 1.68 IF ( useLAND ) THEN
280     # ifdef ALLOW_DEBUG
281     IF (debugMode) CALL DEBUG_CALL('LAND_INI_VARS',myThid)
282     # endif
283     CALL LAND_INI_VARS( myThid )
284     ENDIF
285     #endif /* ALLOW_LAND */
286 adcroft 1.2
287 gforget 1.60 #ifdef ALLOW_SMOOTH
288 jmc 1.68 CALL SMOOTH_INIT_VARIA(myThid)
289     #endif /* ALLOW_SMOOTH */
290 gforget 1.60
291 heimbach 1.26 #ifdef ALLOW_AUTODIFF
292 heimbach 1.38 CADJ STORE theta = tapelev_init, key = 1
293 heimbach 1.20 c-- Initialise auxiliary xx_ fields
294 heimbach 1.66 IF (debugMode) CALL DEBUG_CALL('CTRL_INIT_VARIABLES',myThid)
295 jmc 1.57 CALL CTRL_INIT_VARIABLES ( myThid )
296 heimbach 1.20 c-- Map the control variables onto the model state.
297 heimbach 1.47 # ifdef ALLOW_ECCO
298 heimbach 1.66 IF (debugMode) CALL DEBUG_CALL('CTRL_MAP_INI_ECCO',myThid)
299 jmc 1.57 CALL CTRL_MAP_INI_ECCO( myThid )
300 heimbach 1.47 # else
301 heimbach 1.66 IF (debugMode) CALL DEBUG_CALL('CTRL_MAP_INI',myThid)
302 jmc 1.57 CALL CTRL_MAP_INI( myThid )
303 heimbach 1.47 # endif
304 heimbach 1.5 _BARRIER
305 jmc 1.68 #endif /* ALLOW_AUTODIFF */
306 dimitri 1.18
307 edhill 1.27 #ifdef ALLOW_EXF
308 heimbach 1.59 IF (useEXF) THEN
309 jmc 1.68 # ifdef ALLOW_DEBUG
310     IF (debugMode) CALL DEBUG_CALL('EXF_INIT',myThid)
311     # endif
312 heimbach 1.59 CALL EXF_INIT( myThid )
313     ENDIF
314 jmc 1.68 #endif /* ALLOW_EXF */
315 heimbach 1.33
316     #ifdef ALLOW_EBM
317 heimbach 1.34 # ifdef ALLOW_AUTODIFF
318 heimbach 1.38 CADJ STORE theta = tapelev_init, key = 1
319 heimbach 1.34 # endif
320 jmc 1.68 IF (useEBM) THEN
321     CALL EBM_INI_VARS( myThid )
322     ENDIF
323     #endif /* ALLOW_EBM */
324 heimbach 1.5
325 heimbach 1.20 #ifdef ALLOW_COST
326 heimbach 1.12 c-- Initialise the cost function.
327 edhill 1.24 ceh3 needs an IF ( useCOST ) THEN
328 jmc 1.57 CALL COST_INIT_VARIA( myThid )
329 heimbach 1.12 _BARRIER
330 jmc 1.68 #endif /* ALLOW_COST */
331 heimbach 1.20
332 heimbach 1.48 #ifdef ALLOW_PROFILES
333     c-- Initialise the cost function.
334 jmc 1.57 CALL PROFILES_INIT_VARIA( myThid )
335 heimbach 1.48 _BARRIER
336 jmc 1.68 #endif /* ALLOW_PROFILES */
337 heimbach 1.48
338 jmc 1.71 #ifdef ALLOW_FLT
339     c-- Initialise float position
340     IF ( useFLT ) THEN
341     CALL FLT_INIT_VARIA( myThid )
342     ENDIF
343     #endif /* ALLOW_FLT */
344    
345 heimbach 1.20 #ifdef ALLOW_OBCS
346     C-- Open boundaries data
347 jmc 1.68 IF (useOBCS) THEN
348     # ifdef ALLOW_DEBUG
349     IF (debugMode) CALL DEBUG_CALL('OBCS_INIT_VARIABLES',myThid)
350     # endif
351     CALL OBCS_INIT_VARIABLES( myThid )
352     ENDIF
353     #endif /* ALLOW_OBCS */
354 adcroft 1.2
355 cheisey 1.17 #ifdef ALLOW_BULK_FORCE
356 jmc 1.68 IF (useBulkForce) THEN
357     CALL BULKF_INIT_VARIA( myThid )
358     ENDIF
359     #endif /* ALLOW_BULK_FORCE */
360 cheisey 1.16
361 jmc 1.28 #ifdef ALLOW_THSICE
362 jmc 1.68 IF (useThSIce) THEN
363     # ifdef ALLOW_DEBUG
364     IF (debugMode) CALL DEBUG_CALL('THSICE_INI_VARS',myThid)
365     # endif
366     CALL THSICE_INI_VARS( myThid)
367     ENDIF
368     #endif /* ALLOW_THSICE */
369 cheisey 1.16
370 jmc 1.76 #ifdef ALLOW_NEST_CHILD
371     C-- Initialize NEST in CHILD configuration
372     IF (useNEST_CHILD) THEN
373     #ifdef ALLOW_DEBUG
374     IF (debugMode)
375     & CALL DEBUG_CALL('NEST_CHILD_INIT_VARIA',myThid)
376     #endif
377     CALL NEST_CHILD_INIT_VARIA( myThid )
378     ENDIF
379     #endif /* ALLOW_NEST_CHILD */
380     C
381     #ifdef ALLOW_NEST_PARENT
382     C-- Initialize NEST in PARENT configuration
383     IF (useNEST_PARENT) THEN
384     #ifdef ALLOW_DEBUG
385     IF (debugMode)
386     & CALL DEBUG_CALL('NEST_PARENT_INIT',myThid)
387     #endif
388     CALL NEST_PARENT_INIT_VARIA( myThid )
389     ENDIF
390     #endif /* ALLOW_NEST_PARENT */
391    
392 jmc 1.30 #ifdef COMPONENT_MODULE
393 jmc 1.68 IF (useCoupler) THEN
394     # ifdef ALLOW_DEBUG
395     IF (debugMode) CALL DEBUG_CALL('CPL_INI_VARS',myThid)
396     # endif
397     CALL CPL_INI_VARS( myThid )
398     ENDIF
399     #endif /* COMPONENT_MODULE */
400 molod 1.31
401 jscott 1.55 #ifdef ALLOW_ATM2D
402 jmc 1.68 IF (useAtm2d) THEN
403     # ifdef ALLOW_DEBUG
404     IF (debugMode) CALL DEBUG_CALL('ATM2D_INIT_VARS',myThid)
405     # endif
406     CALL ATM2D_INIT_VARS( myThid )
407     ENDIF
408     #endif /* ALLOW_ATM2D */
409 jscott 1.55
410 molod 1.31 #ifdef ALLOW_FIZHI
411     C Initialize FIZHI state variables
412 jmc 1.68 IF (useFIZHI) THEN
413     # ifdef ALLOW_DEBUG
414     IF (debugMode) CALL DEBUG_CALL('FIZHI_INIT_VARS',myThid)
415     # endif
416     CALL FIZHI_INIT_VARS( myThid )
417     ENDIF
418     #endif /* ALLOW_FIZHI */
419 jmc 1.42
420 spk 1.44 #ifdef ALLOW_MATRIX
421 jmc 1.68 IF ( useMATRIX ) THEN
422     # ifdef ALLOW_DEBUG
423     IF (debugMode) CALL DEBUG_CALL('MATRIX_INIT',myThid)
424     # endif
425     CALL MATRIX_INIT( myThid )
426     ENDIF
427     #endif /* ALLOW_MATRIX */
428 spk 1.44
429 heimbach 1.52 #ifdef ALLOW_RBCS
430 jmc 1.68 IF ( useRBCS ) THEN
431     CALL RBCS_INIT_VARIA( myThid )
432     ENDIF
433     #endif /* ALLOW_RBCS */
434 heimbach 1.52
435 jmc 1.54 #ifdef ALLOW_REGRID
436 jmc 1.68 IF ( useREGRID ) THEN
437     CALL REGRID_INIT_VARIA( myThid )
438     ENDIF
439     #endif /* ALLOW_REGRID */
440 heimbach 1.51
441 rpa 1.74 #ifdef ALLOW_LAYERS
442     IF ( useLayers ) CALL LAYERS_INIT_VARIA( myThid )
443     #endif /* ALLOW_LAYERS */
444    
445 dimitri 1.63 #ifdef ALLOW_SALT_PLUME
446 jmc 1.68 IF ( useSALT_PLUME ) THEN
447     CALL SALT_PLUME_INIT_VARIA( myThid )
448     ENDIF
449     #endif /* ALLOW_SALT_PLUME */
450 dimitri 1.63
451 jmc 1.67 #ifdef ALLOW_CHEAPAML
452 jmc 1.68 IF (useCheapAML) THEN
453     CALL CHEAPAML_INIT_VARIA( myThid )
454     ENDIF
455     #endif /* ALLOW_CHEAPAML */
456    
457     #ifdef ALLOW_MYPACKAGE
458     IF ( useMYPACKAGE ) THEN
459     CALL MYPACKAGE_INIT_VARIA( myThid )
460     ENDIF
461     #endif /* ALLOW_MYPACKAGE */
462 jmc 1.67
463 adcroft 1.39 #ifdef ALLOW_DEBUG
464 jmc 1.49 IF (debugMode)
465 edhill 1.40 & CALL DEBUG_LEAVE('PACKAGES_INIT_VARIABLES',myThid)
466 jmc 1.68 #endif /* ALLOW_DEBUG */
467 edhill 1.53
468 adcroft 1.2 RETURN
469     END

  ViewVC Help
Powered by ViewVC 1.1.22