model/src/packages_init_variables.F

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