model/src/packages_init_variables.F

C $Header: /u/gcmpack/MITgcm/model/src/packages_init_variables.F,v 1.52 2006/07/11 23:58:47 heimbach Exp $
C $Name:  $

#include "PACKAGES_CONFIG.h"
#include "AD_CONFIG.h"
#include "CPP_OPTIONS.h"

CBOP
C     !ROUTINE: PACKAGES_INIT_VARIABLES
C     !INTERFACE:
      SUBROUTINE PACKAGES_INIT_VARIABLES( myThid )

C     !DESCRIPTION: \bv
C     *==========================================================*
C     | SUBROUTINE PACKAGES_INIT_VARIABLES
C     | o Does initialisation of package-related variable data
C     *==========================================================*
C     \ev

C     !CALLING SEQUENCE:
C     PACKAGES_INIT_VARIABLES
C       |
C       |-- CD_CODE_INI_VARS
C       |
C       |-- GMREDI_INIT
C       |
C       |-- KPP_INIT
C       |-- KPP_OPEN_DIAGS
C       |
C       |-- PP81_INIT
C       |
C       |-- MY82_INIT
C       |
C       |-- GGL90_INIT
C       |
C       |-- SEAICE_INIT
C       |
C       |-- OBCS_INIT_VARIABLES
C       |
C       |-- PTRACERS_INIT_VARIA
C       |
C       |-- LAND_INI_VARS
C       |
C       |-- CTRL_MAP_INI
C       |
C       |-- EXF_INIT
C       |
C       |-- INI_FORCING
C       |
C       |-- ECCO_INIT
C       |
C       |-- COST_INIT
C       |
C       |-- BULKF_INIT_VARIA
C       |
C       |-- THSICE_INI_VARS
C       |
C       |-- CPL_INI_VARS
C       |
C       |-- REGRID_INIT_FIXED

C     !USES:
      IMPLICIT NONE
C     === Global variables ===
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#ifdef ALLOW_AUTODIFF_TAMC
# include "DYNVARS.h"
# include "tamc.h"
# include "tamc_keys.h"
#endif

C     !INPUT/OUTPUT PARAMETERS:
C     === Routine arguments ===
C     myThid -  Number of this instances
      INTEGER myThid
CEOP

#ifdef ALLOW_DEBUG
      IF (debugMode)
     &     CALL DEBUG_ENTER('PACKAGES_INIT_VARIABLES',myThid)
#endif

#ifdef ALLOW_DIAGNOSTICS
      IF ( useDiagnostics ) THEN
        CALL DIAGNOSTICS_INIT_VARIA( myThid )
      ENDIF
#endif

#ifdef ALLOW_CD_CODE
C--   Initialize CD_CODE variables:
C- note(jmc): before packaging CD_CODE, was done within ini_fields (=called before),
C             therefore call CD-ini-vars before others pkg.
#ifdef ALLOW_DEBUG
      IF (debugMode) CALL DEBUG_CALL('CD_CODE_INI',myThid)
#endif
      IF (useCDscheme) CALL CD_CODE_INI_VARS( myThid )
#endif

#ifdef ALLOW_GMREDI
C--   Initialize GM/Redi parameterization
#ifdef ALLOW_DEBUG
      IF (debugMode) CALL DEBUG_CALL('CD_CODE_INI',myThid)
#endif
      IF (useGMRedi) CALL GMREDI_INIT( myThid )
#endif

#ifdef ALLOW_KPP
C--   Initialize KPP vertical mixing scheme.
      IF (useKPP) THEN
#ifdef ALLOW_DEBUG
       IF (debugMode)
     &       CALL DEBUG_CALL('KPP_INIT + KPP_OPEN_DIAGS',myThid)
#endif
       CALL KPP_INIT( myThid )
       CALL KPP_OPEN_DIAGS( myThid )
      ENDIF
#endif

#ifdef ALLOW_PP81
C--   Initialize PP81 vertical mixing scheme.
      IF (usePP81) THEN
#ifdef ALLOW_DEBUG
      IF (debugMode) CALL DEBUG_CALL('PP81_INIT',myThid)
#endif
       CALL PP81_INIT( myThid )
      ENDIF
#endif

#ifdef ALLOW_MY82
C--   Initialize MY82 vertical mixing scheme.
      IF (useMY82) THEN
       CALL MY82_INIT( myThid )
      ENDIF
#endif

#ifdef ALLOW_GGL90
C--   Initialize GGL90 vertical mixing scheme.
      IF (useGGL90) THEN
#ifdef ALLOW_DEBUG
      IF (debugMode) CALL DEBUG_CALL('GGL90_INIT',myThid)
#endif
       CALL GGL90_INIT( myThid )
      ENDIF
#endif

#ifdef ALLOW_SEAICE
C--   Initialize SEAICE model.
#ifdef ALLOW_DEBUG
      IF (debugMode) CALL DEBUG_CALL('SEAICE_INIT',myThid)
#endif
      IF (useSEAICE) CALL SEAICE_INIT( myThid )
#endif

cph-- moved further down
cph#ifdef ALLOW_OBCS
cphC--   Open boundaries data
cph      IF (useOBCS) THEN
cph        CALL OBCS_INIT_VARIABLES( myThid )
cph      ENDIF
cph#endif

#ifdef ALLOW_PTRACERS
# ifndef ALLOW_AUTODIFF_TAMC
      IF ( usePTRACERS ) THEN
# endif
#ifdef ALLOW_DEBUG
      IF (debugMode) CALL DEBUG_CALL('PTRACERS_INIT_VARIA',myThid)
#endif
         CALL PTRACERS_INIT_VARIA( myThid )
#ifdef ALLOW_GCHEM
# ifndef ALLOW_AUTODIFF_TAMC
         IF (useGCHEM) THEN
# endif
          CALL GCHEM_INIT_VARI( mythid )
# ifndef ALLOW_AUTODIFF_TAMC
         ENDIF
# endif
#endif
# ifndef ALLOW_AUTODIFF_TAMC
      ENDIF
# endif
#endif

#ifdef ALLOW_LAND
#ifdef ALLOW_DEBUG
      IF (debugMode) CALL DEBUG_CALL('LAND_INI_VARS',myThid)
#endif
      IF ( useLAND ) CALL LAND_INI_VARS( mythid )
#endif

#ifdef ALLOW_AUTODIFF
CADJ STORE theta = tapelev_init, key = 1
c--   Initialise auxiliary xx_ fields
      CALL CTRL_INIT_VARIABLES ( mythid )
c--   Map the control variables onto the model state.
# ifdef ALLOW_ECCO
      CALL CTRL_MAP_INI_ECCO( mythid )
# else
      CALL CTRL_MAP_INI( mythid )
# endif
      _BARRIER
#endif

#ifdef ALLOW_EXF
#ifdef ALLOW_DEBUG
      IF (debugMode) CALL DEBUG_CALL('EXF_INIT',myThid)
#endif
      CALL EXF_INIT( mythid )
#endif

#ifdef ALLOW_DEBUG
      IF (debugMode) CALL DEBUG_CALL('INI_FORCING',myThid)
#endif
      CALL INI_FORCING( mythid )

#ifdef ALLOW_EBM
# ifdef ALLOW_AUTODIFF
CADJ STORE theta = tapelev_init, key = 1
# endif
      IF (useEBM) CALL EBM_INI_VARS( mythid )
#endif

#ifdef ALLOW_COST
c--   Initialise the cost function.
ceh3 needs an IF ( useCOST ) THEN
      CALL COST_INIT_VARIA( mythid )
      _BARRIER
#endif

#ifdef ALLOW_PROFILES
c--   Initialise the cost function.
      CALL PROFILES_INIT_VARIA( mythid )
      _BARRIER
#endif

#ifdef ALLOW_OBCS
C--   Open boundaries data
#ifdef ALLOW_DEBUG
      IF (debugMode) CALL DEBUG_CALL('OBCS_INIT_VARIABLES',myThid)
#endif
      IF (useOBCS) CALL OBCS_INIT_VARIABLES( myThid )
#endif

#ifdef ALLOW_BULK_FORCE
      IF (useBulkForce) CALL BULKF_INIT_VARIA( mythid)
#endif

#ifdef ALLOW_THSICE
#ifdef ALLOW_DEBUG
      IF (debugMode) CALL DEBUG_CALL('THSICE_INI_VARS',myThid)
#endif
      IF (useThSIce) CALL THSICE_INI_VARS( mythid)
#endif

#ifdef COMPONENT_MODULE
#ifdef ALLOW_DEBUG
      IF (debugMode) CALL DEBUG_CALL('CPL_INI_VARS',myThid)
#endif
      IF (useCoupler) CALL CPL_INI_VARS( mythid )
#endif

#ifdef ALLOW_FIZHI
C Initialize FIZHI state variables
#ifdef ALLOW_DEBUG
      IF (debugMode) CALL DEBUG_CALL('FIZHI_INIT_VARS',myThid)
#endif
      IF (useFIZHI) CALL FIZHI_INIT_VARS( mythid )
#endif

#ifdef ALLOW_MATRIX
#ifdef ALLOW_DEBUG
      IF (debugMode) CALL DEBUG_CALL('MATRIX_INIT',myThid)
#endif
      IF ( useMATRIX ) CALL MATRIX_INIT( myThid )
#endif

#ifdef ALLOW_RBCS
      IF ( useRBCS ) CALL RBCS_INIT_VARIA( myThid )
#endif

#ifdef ALLOW_MYPACKAGE
      IF ( useMYPACKAGE ) CALL MYPACKAGE_INIT_VARIA( myThid )
#endif

#ifdef ALLOW_DEBUG
      IF (debugMode)
     &     CALL DEBUG_LEAVE('PACKAGES_INIT_VARIABLES',myThid)
#endif

#ifdef ALLOW_REGRID
      IF ( useREGRID ) CALL REGRID_INIT_VARIA( myThid )
#endif

      RETURN
      END
1	edhill	1.53	C $Header: /u/gcmpack/MITgcm/model/src/packages_init_variables.F,v 1.52 2006/07/11 23:58:47 heimbach 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.29	C \|-- CD_CODE_INI_VARS
24			C \|
25	cnh	1.8	C \|-- GMREDI_INIT
26			C \|
27			C \|-- KPP_INIT
28			C \|-- KPP_OPEN_DIAGS
29			C \|
30	mlosch	1.35	C \|-- PP81_INIT
31			C \|
32			C \|-- MY82_INIT
33			C \|
34	mlosch	1.36	C \|-- GGL90_INIT
35			C \|
36	heimbach	1.14	C \|-- SEAICE_INIT
37	jmc	1.49	C \|
38	dimitri	1.18	C \|-- OBCS_INIT_VARIABLES
39	heimbach	1.14	C \|
40	jmc	1.50	C \|-- PTRACERS_INIT_VARIA
41	cnh	1.8	C \|
42	jmc	1.19	C \|-- LAND_INI_VARS
43			C \|
44	cnh	1.8	C \|-- CTRL_MAP_INI
45			C \|
46	dimitri	1.18	C \|-- EXF_INIT
47			C \|
48			C \|-- INI_FORCING
49			C \|
50			C \|-- ECCO_INIT
51			C \|
52	cnh	1.8	C \|-- COST_INIT
53			C \|
54	jmc	1.49	C \|-- BULKF_INIT_VARIA
55	cnh	1.8	C \|
56	jmc	1.28	C \|-- THSICE_INI_VARS
57	jmc	1.30	C \|
58			C \|-- CPL_INI_VARS
59	edhill	1.53	C \|
60			C \|-- REGRID_INIT_FIXED
61	cnh	1.8
62			C !USES:
63	adcroft	1.2	IMPLICIT NONE
64			C === Global variables ===
65			#include "SIZE.h"
66			#include "EEPARAMS.h"
67			#include "PARAMS.h"
68	heimbach	1.34	#ifdef ALLOW_AUTODIFF_TAMC
69			# include "DYNVARS.h"
70			# include "tamc.h"
71			# include "tamc_keys.h"
72			#endif
73	adcroft	1.2
74	cnh	1.8	C !INPUT/OUTPUT PARAMETERS:
75	adcroft	1.2	C === Routine arguments ===
76			C myThid - Number of this instances
77			INTEGER myThid
78	cnh	1.8	CEOP
79	jmc	1.29
80	adcroft	1.39	#ifdef ALLOW_DEBUG
81	jmc	1.49	IF (debugMode)
82	edhill	1.40	& CALL DEBUG_ENTER('PACKAGES_INIT_VARIABLES',myThid)
83	adcroft	1.39	#endif
84
85	molod	1.45	#ifdef ALLOW_DIAGNOSTICS
86			IF ( useDiagnostics ) THEN
87			CALL DIAGNOSTICS_INIT_VARIA( myThid )
88			ENDIF
89			#endif
90
91	jmc	1.29	#ifdef ALLOW_CD_CODE
92	jmc	1.49	C-- Initialize CD_CODE variables:
93	jmc	1.29	C- note(jmc): before packaging CD_CODE, was done within ini_fields (=called before),
94			C therefore call CD-ini-vars before others pkg.
95	adcroft	1.39	#ifdef ALLOW_DEBUG
96			IF (debugMode) CALL DEBUG_CALL('CD_CODE_INI',myThid)
97			#endif
98	jmc	1.29	IF (useCDscheme) CALL CD_CODE_INI_VARS( myThid )
99			#endif
100	adcroft	1.2
101			#ifdef ALLOW_GMREDI
102			C-- Initialize GM/Redi parameterization
103	adcroft	1.39	#ifdef ALLOW_DEBUG
104			IF (debugMode) CALL DEBUG_CALL('CD_CODE_INI',myThid)
105			#endif
106	adcroft	1.2	IF (useGMRedi) CALL GMREDI_INIT( myThid )
107			#endif
108
109			#ifdef ALLOW_KPP
110			C-- Initialize KPP vertical mixing scheme.
111			IF (useKPP) THEN
112	adcroft	1.39	#ifdef ALLOW_DEBUG
113	jmc	1.49	IF (debugMode)
114	edhill	1.40	& CALL DEBUG_CALL('KPP_INIT + KPP_OPEN_DIAGS',myThid)
115	adcroft	1.39	#endif
116	adcroft	1.2	CALL KPP_INIT( myThid )
117			CALL KPP_OPEN_DIAGS( myThid )
118			ENDIF
119	heimbach	1.14	#endif
120
121	mlosch	1.35	#ifdef ALLOW_PP81
122			C-- Initialize PP81 vertical mixing scheme.
123			IF (usePP81) THEN
124	adcroft	1.39	#ifdef ALLOW_DEBUG
125			IF (debugMode) CALL DEBUG_CALL('PP81_INIT',myThid)
126			#endif
127	mlosch	1.35	CALL PP81_INIT( myThid )
128			ENDIF
129			#endif
130
131			#ifdef ALLOW_MY82
132	mlosch	1.36	C-- Initialize MY82 vertical mixing scheme.
133	mlosch	1.35	IF (useMY82) THEN
134			CALL MY82_INIT( myThid )
135			ENDIF
136			#endif
137
138	mlosch	1.36	#ifdef ALLOW_GGL90
139			C-- Initialize GGL90 vertical mixing scheme.
140			IF (useGGL90) THEN
141	adcroft	1.39	#ifdef ALLOW_DEBUG
142			IF (debugMode) CALL DEBUG_CALL('GGL90_INIT',myThid)
143			#endif
144	mlosch	1.36	CALL GGL90_INIT( myThid )
145			ENDIF
146			#endif
147
148	heimbach	1.14	#ifdef ALLOW_SEAICE
149			C-- Initialize SEAICE model.
150	adcroft	1.39	#ifdef ALLOW_DEBUG
151			IF (debugMode) CALL DEBUG_CALL('SEAICE_INIT',myThid)
152			#endif
153	heimbach	1.14	IF (useSEAICE) CALL SEAICE_INIT( myThid )
154	adcroft	1.2	#endif
155
156	heimbach	1.20	cph-- moved further down
157			cph#ifdef ALLOW_OBCS
158			cphC-- Open boundaries data
159			cph IF (useOBCS) THEN
160			cph CALL OBCS_INIT_VARIABLES( myThid )
161			cph ENDIF
162			cph#endif
163	adcroft	1.11
164			#ifdef ALLOW_PTRACERS
165	heimbach	1.22	# ifndef ALLOW_AUTODIFF_TAMC
166			IF ( usePTRACERS ) THEN
167			# endif
168	adcroft	1.39	#ifdef ALLOW_DEBUG
169	jmc	1.50	IF (debugMode) CALL DEBUG_CALL('PTRACERS_INIT_VARIA',myThid)
170	adcroft	1.39	#endif
171	jmc	1.50	CALL PTRACERS_INIT_VARIA( myThid )
172	stephd	1.23	#ifdef ALLOW_GCHEM
173	mlosch	1.41	# ifndef ALLOW_AUTODIFF_TAMC
174			IF (useGCHEM) THEN
175			# endif
176			CALL GCHEM_INIT_VARI( mythid )
177			# ifndef ALLOW_AUTODIFF_TAMC
178			ENDIF
179			# endif
180	stephd	1.23	#endif
181	heimbach	1.22	# ifndef ALLOW_AUTODIFF_TAMC
182			ENDIF
183			# endif
184	jmc	1.19	#endif
185
186			#ifdef ALLOW_LAND
187	adcroft	1.39	#ifdef ALLOW_DEBUG
188			IF (debugMode) CALL DEBUG_CALL('LAND_INI_VARS',myThid)
189			#endif
190	jmc	1.19	IF ( useLAND ) CALL LAND_INI_VARS( mythid )
191	adcroft	1.2	#endif
192
193	heimbach	1.26	#ifdef ALLOW_AUTODIFF
194	heimbach	1.38	CADJ STORE theta = tapelev_init, key = 1
195	heimbach	1.20	c-- Initialise auxiliary xx_ fields
196			CALL CTRL_INIT_VARIABLES ( mythid )
197			c-- Map the control variables onto the model state.
198	heimbach	1.47	# ifdef ALLOW_ECCO
199	heimbach	1.38	CALL CTRL_MAP_INI_ECCO( mythid )
200	heimbach	1.47	# else
201	heimbach	1.20	CALL CTRL_MAP_INI( mythid )
202	heimbach	1.47	# endif
203	heimbach	1.5	_BARRIER
204	dimitri	1.18	#endif
205
206	edhill	1.27	#ifdef ALLOW_EXF
207	adcroft	1.39	#ifdef ALLOW_DEBUG
208			IF (debugMode) CALL DEBUG_CALL('EXF_INIT',myThid)
209			#endif
210	dimitri	1.18	CALL EXF_INIT( mythid )
211	heimbach	1.32	#endif
212	heimbach	1.43
213	adcroft	1.39	#ifdef ALLOW_DEBUG
214			IF (debugMode) CALL DEBUG_CALL('INI_FORCING',myThid)
215			#endif
216	dimitri	1.18	CALL INI_FORCING( mythid )
217	heimbach	1.33
218			#ifdef ALLOW_EBM
219	heimbach	1.34	# ifdef ALLOW_AUTODIFF
220	heimbach	1.38	CADJ STORE theta = tapelev_init, key = 1
221	heimbach	1.34	# endif
222	heimbach	1.33	IF (useEBM) CALL EBM_INI_VARS( mythid )
223			#endif
224	heimbach	1.5
225	heimbach	1.20	#ifdef ALLOW_COST
226	heimbach	1.12	c-- Initialise the cost function.
227	edhill	1.24	ceh3 needs an IF ( useCOST ) THEN
228	heimbach	1.46	CALL COST_INIT_VARIA( mythid )
229	heimbach	1.12	_BARRIER
230	heimbach	1.20	#endif
231
232	heimbach	1.48	#ifdef ALLOW_PROFILES
233			c-- Initialise the cost function.
234			CALL PROFILES_INIT_VARIA( mythid )
235			_BARRIER
236			#endif
237
238	heimbach	1.20	#ifdef ALLOW_OBCS
239			C-- Open boundaries data
240	adcroft	1.39	#ifdef ALLOW_DEBUG
241			IF (debugMode) CALL DEBUG_CALL('OBCS_INIT_VARIABLES',myThid)
242			#endif
243	heimbach	1.20	IF (useOBCS) CALL OBCS_INIT_VARIABLES( myThid )
244	adcroft	1.2	#endif
245
246	cheisey	1.17	#ifdef ALLOW_BULK_FORCE
247	jmc	1.49	IF (useBulkForce) CALL BULKF_INIT_VARIA( mythid)
248	cheisey	1.16	#endif
249
250	jmc	1.28	#ifdef ALLOW_THSICE
251	adcroft	1.39	#ifdef ALLOW_DEBUG
252			IF (debugMode) CALL DEBUG_CALL('THSICE_INI_VARS',myThid)
253			#endif
254	jmc	1.28	IF (useThSIce) CALL THSICE_INI_VARS( mythid)
255	cheisey	1.16	#endif
256
257	jmc	1.30	#ifdef COMPONENT_MODULE
258	adcroft	1.39	#ifdef ALLOW_DEBUG
259			IF (debugMode) CALL DEBUG_CALL('CPL_INI_VARS',myThid)
260			#endif
261			IF (useCoupler) CALL CPL_INI_VARS( mythid )
262	jmc	1.30	#endif
263	molod	1.31
264			#ifdef ALLOW_FIZHI
265			C Initialize FIZHI state variables
266	adcroft	1.39	#ifdef ALLOW_DEBUG
267			IF (debugMode) CALL DEBUG_CALL('FIZHI_INIT_VARS',myThid)
268			#endif
269	heimbach	1.52	IF (useFIZHI) CALL FIZHI_INIT_VARS( mythid )
270	molod	1.31	#endif
271	jmc	1.42
272	spk	1.44	#ifdef ALLOW_MATRIX
273			#ifdef ALLOW_DEBUG
274			IF (debugMode) CALL DEBUG_CALL('MATRIX_INIT',myThid)
275			#endif
276			IF ( useMATRIX ) CALL MATRIX_INIT( myThid )
277			#endif
278
279	heimbach	1.52	#ifdef ALLOW_RBCS
280			IF ( useRBCS ) CALL RBCS_INIT_VARIA( myThid )
281			#endif
282
283	heimbach	1.51	#ifdef ALLOW_MYPACKAGE
284	heimbach	1.52	IF ( useMYPACKAGE ) CALL MYPACKAGE_INIT_VARIA( myThid )
285	heimbach	1.51	#endif
286
287	adcroft	1.39	#ifdef ALLOW_DEBUG
288	jmc	1.49	IF (debugMode)
289	edhill	1.40	& CALL DEBUG_LEAVE('PACKAGES_INIT_VARIABLES',myThid)
290	adcroft	1.39	#endif
291	edhill	1.53
292			#ifdef ALLOW_REGRID
293			IF ( useREGRID ) CALL REGRID_INIT_VARIA( myThid )
294			#endif
295
296	adcroft	1.2	RETURN
297			END