jscott/code_changed/packages_init_variables.F

C $Header: /u/gcmpack/MITgcm_contrib/jscott/code_changed/packages_init_variables.F,v 1.1 2006/08/11 19:29:22 jscott 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       |-- ATM2D_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_ATM2D
#ifdef ALLOW_DEBUG
      IF (debugMode) CALL DEBUG_CALL('ATM2D_INIT_VARS',myThid)
#endif
      IF (useAtm2d) CALL ATM2D_INIT_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_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	jscott	1.2	C $Header: /u/gcmpack/MITgcm_contrib/jscott/code_changed/packages_init_variables.F,v 1.1 2006/08/11 19:29:22 jscott Exp $
2	jscott	1.1	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 \|-- CD_CODE_INI_VARS
24			C \|
25			C \|-- GMREDI_INIT
26			C \|
27			C \|-- KPP_INIT
28			C \|-- KPP_OPEN_DIAGS
29			C \|
30			C \|-- PP81_INIT
31			C \|
32			C \|-- MY82_INIT
33			C \|
34			C \|-- GGL90_INIT
35			C \|
36			C \|-- SEAICE_INIT
37			C \|
38			C \|-- OBCS_INIT_VARIABLES
39			C \|
40			C \|-- PTRACERS_INIT_VARIA
41			C \|
42			C \|-- LAND_INI_VARS
43			C \|
44			C \|-- CTRL_MAP_INI
45			C \|
46			C \|-- EXF_INIT
47			C \|
48			C \|-- INI_FORCING
49			C \|
50			C \|-- ECCO_INIT
51			C \|
52			C \|-- COST_INIT
53			C \|
54			C \|-- BULKF_INIT_VARIA
55			C \|
56			C \|-- THSICE_INI_VARS
57			C \|
58			C \|-- CPL_INI_VARS
59			C \|
60			C \|-- ATM2D_INI_VARS
61
62			C !USES:
63			IMPLICIT NONE
64			C === Global variables ===
65			#include "SIZE.h"
66			#include "EEPARAMS.h"
67			#include "PARAMS.h"
68			#ifdef ALLOW_AUTODIFF_TAMC
69			# include "DYNVARS.h"
70			# include "tamc.h"
71			# include "tamc_keys.h"
72			#endif
73
74			C !INPUT/OUTPUT PARAMETERS:
75			C === Routine arguments ===
76			C myThid - Number of this instances
77			INTEGER myThid
78			CEOP
79
80			#ifdef ALLOW_DEBUG
81			IF (debugMode)
82			& CALL DEBUG_ENTER('PACKAGES_INIT_VARIABLES',myThid)
83			#endif
84
85			#ifdef ALLOW_DIAGNOSTICS
86			IF ( useDiagnostics ) THEN
87			CALL DIAGNOSTICS_INIT_VARIA( myThid )
88			ENDIF
89			#endif
90
91			#ifdef ALLOW_CD_CODE
92			C-- Initialize CD_CODE variables:
93			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			#ifdef ALLOW_DEBUG
96			IF (debugMode) CALL DEBUG_CALL('CD_CODE_INI',myThid)
97			#endif
98			IF (useCDscheme) CALL CD_CODE_INI_VARS( myThid )
99			#endif
100
101			#ifdef ALLOW_GMREDI
102			C-- Initialize GM/Redi parameterization
103			#ifdef ALLOW_DEBUG
104			IF (debugMode) CALL DEBUG_CALL('CD_CODE_INI',myThid)
105			#endif
106			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			#ifdef ALLOW_DEBUG
113			IF (debugMode)
114			& CALL DEBUG_CALL('KPP_INIT + KPP_OPEN_DIAGS',myThid)
115			#endif
116			CALL KPP_INIT( myThid )
117			CALL KPP_OPEN_DIAGS( myThid )
118			ENDIF
119			#endif
120
121			#ifdef ALLOW_PP81
122			C-- Initialize PP81 vertical mixing scheme.
123			IF (usePP81) THEN
124			#ifdef ALLOW_DEBUG
125			IF (debugMode) CALL DEBUG_CALL('PP81_INIT',myThid)
126			#endif
127			CALL PP81_INIT( myThid )
128			ENDIF
129			#endif
130
131			#ifdef ALLOW_MY82
132			C-- Initialize MY82 vertical mixing scheme.
133			IF (useMY82) THEN
134			CALL MY82_INIT( myThid )
135			ENDIF
136			#endif
137
138			#ifdef ALLOW_GGL90
139			C-- Initialize GGL90 vertical mixing scheme.
140			IF (useGGL90) THEN
141			#ifdef ALLOW_DEBUG
142			IF (debugMode) CALL DEBUG_CALL('GGL90_INIT',myThid)
143			#endif
144			CALL GGL90_INIT( myThid )
145			ENDIF
146			#endif
147
148			#ifdef ALLOW_SEAICE
149			C-- Initialize SEAICE model.
150			#ifdef ALLOW_DEBUG
151			IF (debugMode) CALL DEBUG_CALL('SEAICE_INIT',myThid)
152			#endif
153			IF (useSEAICE) CALL SEAICE_INIT( myThid )
154			#endif
155
156			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
164			#ifdef ALLOW_PTRACERS
165			# ifndef ALLOW_AUTODIFF_TAMC
166			IF ( usePTRACERS ) THEN
167			# endif
168			#ifdef ALLOW_DEBUG
169			IF (debugMode) CALL DEBUG_CALL('PTRACERS_INIT_VARIA',myThid)
170			#endif
171			CALL PTRACERS_INIT_VARIA( myThid )
172			#ifdef ALLOW_GCHEM
173			# 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			#endif
181			# ifndef ALLOW_AUTODIFF_TAMC
182			ENDIF
183			# endif
184			#endif
185
186			#ifdef ALLOW_LAND
187			#ifdef ALLOW_DEBUG
188			IF (debugMode) CALL DEBUG_CALL('LAND_INI_VARS',myThid)
189			#endif
190			IF ( useLAND ) CALL LAND_INI_VARS( mythid )
191			#endif
192
193			#ifdef ALLOW_AUTODIFF
194			CADJ STORE theta = tapelev_init, key = 1
195			c-- Initialise auxiliary xx_ fields
196			CALL CTRL_INIT_VARIABLES ( mythid )
197			c-- Map the control variables onto the model state.
198			# ifdef ALLOW_ECCO
199			CALL CTRL_MAP_INI_ECCO( mythid )
200			# else
201			CALL CTRL_MAP_INI( mythid )
202			# endif
203			_BARRIER
204			#endif
205
206			#ifdef ALLOW_EXF
207			#ifdef ALLOW_DEBUG
208			IF (debugMode) CALL DEBUG_CALL('EXF_INIT',myThid)
209			#endif
210			CALL EXF_INIT( mythid )
211			#endif
212
213			#ifdef ALLOW_DEBUG
214			IF (debugMode) CALL DEBUG_CALL('INI_FORCING',myThid)
215			#endif
216			CALL INI_FORCING( mythid )
217
218			#ifdef ALLOW_EBM
219			# ifdef ALLOW_AUTODIFF
220			CADJ STORE theta = tapelev_init, key = 1
221			# endif
222			IF (useEBM) CALL EBM_INI_VARS( mythid )
223			#endif
224
225			#ifdef ALLOW_COST
226			c-- Initialise the cost function.
227			ceh3 needs an IF ( useCOST ) THEN
228			CALL COST_INIT_VARIA( mythid )
229			_BARRIER
230			#endif
231
232			#ifdef ALLOW_PROFILES
233			c-- Initialise the cost function.
234			CALL PROFILES_INIT_VARIA( mythid )
235			_BARRIER
236			#endif
237
238			#ifdef ALLOW_OBCS
239			C-- Open boundaries data
240			#ifdef ALLOW_DEBUG
241			IF (debugMode) CALL DEBUG_CALL('OBCS_INIT_VARIABLES',myThid)
242			#endif
243			IF (useOBCS) CALL OBCS_INIT_VARIABLES( myThid )
244			#endif
245
246			#ifdef ALLOW_BULK_FORCE
247			IF (useBulkForce) CALL BULKF_INIT_VARIA( mythid)
248			#endif
249
250			#ifdef ALLOW_THSICE
251			#ifdef ALLOW_DEBUG
252			IF (debugMode) CALL DEBUG_CALL('THSICE_INI_VARS',myThid)
253			#endif
254			IF (useThSIce) CALL THSICE_INI_VARS( mythid)
255			#endif
256
257			#ifdef COMPONENT_MODULE
258			#ifdef ALLOW_DEBUG
259			IF (debugMode) CALL DEBUG_CALL('CPL_INI_VARS',myThid)
260			#endif
261			IF (useCoupler) CALL CPL_INI_VARS( mythid )
262			#endif
263
264			#ifdef ALLOW_ATM2D
265			#ifdef ALLOW_DEBUG
266			IF (debugMode) CALL DEBUG_CALL('ATM2D_INIT_VARS',myThid)
267			#endif
268			IF (useAtm2d) CALL ATM2D_INIT_VARS( myThid )
269			#endif
270
271			#ifdef ALLOW_FIZHI
272			C Initialize FIZHI state variables
273			#ifdef ALLOW_DEBUG
274			IF (debugMode) CALL DEBUG_CALL('FIZHI_INIT_VARS',myThid)
275			#endif
276			IF (useFIZHI) CALL FIZHI_INIT_VARS( mythid)
277			#endif
278
279			#ifdef ALLOW_MATRIX
280			#ifdef ALLOW_DEBUG
281			IF (debugMode) CALL DEBUG_CALL('MATRIX_INIT',myThid)
282			#endif
283			IF ( useMATRIX ) CALL MATRIX_INIT( myThid )
284			#endif
285
286			#ifdef ALLOW_MYPACKAGE
287			IF (useMYPACKAGE) CALL MYPACKAGE_INIT_VARIA(mythid)
288			#endif
289
290			#ifdef ALLOW_DEBUG
291			IF (debugMode)
292			& CALL DEBUG_LEAVE('PACKAGES_INIT_VARIABLES',myThid)
293			#endif
294			RETURN
295			END
296