matrix_example/code/packages_init_variables.F

C $Header: /u/gcmpack/MITgcm/verification/matrix_example/code/packages_init_variables.F,v 1.1 2005/04/18 20:16:12 spk 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
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
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_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',myThid)
#endif
         CALL PTRACERS_INIT( 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_INITVARIA( 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( 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_DIAGNOSTICS
      IF ( useDiagnostics ) THEN
        CALL DIAGNOSTICS_INIT_VARIA( myThid )
      ENDIF
#endif

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

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