model/src/packages_init_fixed.F

C $Header: /u/gcmpack/MITgcm/model/src/packages_init_fixed.F,v 1.54 2006/09/06 15:30:25 jscott Exp $
C $Name:  $

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

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

C     !DESCRIPTION: \bv
C     *==========================================================*
C     | SUBROUTINE PACKAGES_INIT_FIXED
C     | o Does initialisation of package-related fixed fields
C     *==========================================================*
C     \ev

C     !CALLING SEQUENCE:
C     PACKAGES_INIT_FIXED
C       |
C       |-- RUNCLOCK_INIT
C       |
C       |-- DIAGNOSTICS_INIT_EARLY
C       |-- DIAGNOSTICS_MAIN_INIT
C       |
C       |-- GAD_INIT
C       |
C       |-- MOM_INIT_FIXED
C       |
C       |-- CD_CODE_INIT_FIXED
C       |
C       |-- EXF_INIT_FIXED
C       |
C       |-- GMREDI_INIT_FIXED
C       |
C       |-- KPP_INIT_FIXED
C       |
C       |-- OPPS_INIT
C       |
C       |-- OBCS_INIT_FIXED
C       |
C       |-- FLT_INIT
C       |
C       |-- TIMEAVE_INIT_FIXED
C       |
C       |-- SHAP_FILT_INIT_FIZED
C       |
C       |-- ZONAL_FILT_INIT
C       |
C       |-- AIM_INITIALISE
C       |
C       |-- GRIDALT_INITIALISE
C       |
C       |-- FIZHI_INIT_FIXED
C       |
C       |-- LAND_INITIALISE
C       |
C       |-- SEAICE_COST_INIT_FIXED
C       |
C       |-- ECCO_COST_INIT_FIXED
C       |
C       |-- CTRL_INIT
C       |
C       |-- PTRACERS_INIT_FIXED
C       |
C       |-- GCHEM_INIT_FIXED
C       |
C       |-- DIC_INIT_FIXED
C       |
C       |-- THSICE_INIT_FIXED
C       |
C       |-- SHELFICE_INIT_FIXED
C       |
C       |-- MYPACKAGE_INIT_FIXED
C       |
C       |-- CPL_INIT_FIXED
C       |
C       |-- ATM2D_INIT_FIXED
C       |
C       |-- DIAGNOSTICS_INIT_FIXED
C       |
C       |-- REGRID_INIT_FIXED

C     !USES:
      IMPLICIT NONE
C     === Global variables ===
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"

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

#ifdef ALLOW_RUNCLOCK
      IF ( useRunClock ) THEN
        CALL RUNCLOCK_INIT( myThid )
      ENDIF
#endif

#ifdef ALLOW_DIAGNOSTICS
      IF ( useDiagnostics ) THEN
C-    needs to call DIAGNOSTICS_INIT_EARLY before all package-diag-init calls
        CALL DIAGNOSTICS_INIT_EARLY( myThid )
        CALL DIAGNOSTICS_MAIN_INIT( myThid )
      ENDIF
#endif

#ifdef ALLOW_GENERIC_ADVDIFF
C--   Initialize fixed params for GAD
      CALL GAD_INIT( myThid )
#endif

#ifdef ALLOW_MOM_COMMON
C--   Initialize fixed params for Momentum pkgs (common, fluxform, vecinv)
      IF ( momStepping ) THEN
       CALL MOM_INIT_FIXED( myThid )
      ENDIF
#endif

#ifdef ALLOW_CD_CODE
      IF (useCDscheme) THEN
       CALL CD_CODE_INIT_FIXED(mythid)
      ENDIF
#endif

#ifdef ALLOW_EXF
C--   Initialize fixed arrays for EXF
c     IF ( useEXF ) THEN
       CALL EXF_INIT_FIXED( myThid )
c     ENDIF
#endif

#ifdef ALLOW_GMREDI
C--   Initialize fixed arrays for GM-Redi
      IF ( useGMRedi ) THEN
       CALL GMREDI_INIT_FIXED( myThid )
      ENDIF
#endif

#ifdef ALLOW_KPP
C--   Initialize fixed arrays for KPP
      IF ( useKPP ) THEN
       CALL KPP_INIT_FIXED( myThid )
      ENDIF
#endif

#ifdef ALLOW_OPPS
      IF (useOPPS) CALL OPPS_INIT( myThid )
#endif /* ALLOW_OPPS */

C--   Initialize fixed arrays for OBCS
#ifdef ALLOW_OBCS
      IF (useOBCS) THEN
       CALL OBCS_INIT_FIXED( myThid )
      ENDIF
#endif

#ifdef ALLOW_FLT
C--   Initialise Float positions
      IF (useFLT) THEN
       CALL FLT_INIT(nIter0,startTime,myThid )
      _BARRIER
      ENDIF
#endif

#ifdef ALLOW_TIMEAVE
C     IF (useTIMEAVE) THEN
      IF ( taveFreq.GT.0. ) THEN
       CALL TIMEAVE_INIT_FIXED( myThid )
      ENDIF
#endif

#ifdef ALLOW_SHAP_FILT
C--   Shapiro filter initialisation
      IF (useSHAP_FILT) THEN
       CALL SHAP_FILT_INIT_FIXED( myThid )
      ENDIF
#endif

#ifdef ALLOW_ZONAL_FILT
C--   Latitude circle filter initialisation
      IF (useZONAL_FILT) THEN
       CALL ZONAL_FILT_INIT(myThid)
      _BARRIER
      ENDIF
#endif

#ifdef ALLOW_AIM
C--   Initialise & Read AIM physical parameters
      IF (useAIM) CALL AIM_INITIALISE( myThid )
#endif

C AMM
#ifdef ALLOW_GRIDALT
C--   Initialise GRIDALT parameters - the alternative grid
      IF (useGRIDALT) then
       CALL TIMER_START('GRIDALT_INITIALISE  [PACKAGES_INIT_F]',mythid)
       CALL GRIDALT_INITIALISE( myThid )
       CALL TIMER_STOP ('GRIDALT_INITIALISE  [PACKAGES_INIT_F]',mythid)
      ENDIF

#endif

#ifdef ALLOW_FIZHI
C--   Initialise & Read FIZHI physical parameters
      IF (useFIZHI) CALL FIZHI_INIT_FIXED( myThid )
#endif
C AMM

#ifdef ALLOW_LAND
C--   Initialise & Read Land package parameters
      IF (useLand) CALL LAND_INITIALISE( myThid )
#endif

#if (defined (ALLOW_SEAICE) && defined (ALLOW_COST))
C--   Initialise ecco-specific cost function.
C--   This needs to preceed the call ctrl_init
C--   in order to provide the weight files
      CALL SEAICE_COST_INIT_FIXED( myThid )
#endif

#if (defined (ALLOW_ECCO) && defined (ALLOW_COST))
C--   Initialise ecco-specific cost function.
C--   This needs to preceed the call ctrl_init
C--   in order to provide the weight files
      CALL ECCO_COST_INIT_FIXED( myThid )
#endif

#ifdef ALLOW_PROFILES
      CALL PROFILES_INIT_FIXED( myThid )
#endif

#ifdef ALLOW_AUTODIFF
C--   Initialise the control variables
      CALL CTRL_INIT( myThid )
      _BARRIER
#endif

#ifdef ALLOW_PTRACERS
      IF (usePTRACERS) CALL PTRACERS_INIT_FIXED(myThid)
#endif

#ifdef ALLOW_GCHEM
      IF (useGCHEM) CALL GCHEM_INIT_FIXED(mythid)
#endif

#ifdef ALLOW_DIC
C     IF (useDIC)
      CALL DIC_INIT_FIXED(mythid)
#endif

#ifdef ALLOW_RBCS
      IF (useRBCS) CALL RBCS_INIT_FIXED(mythid)
#endif

#ifdef ALLOW_THSICE
      IF (useThSIce) CALL THSICE_INIT_FIXED(mythid)
#endif

#ifdef ALLOW_SEAICE
      IF (useSEAICE) CALL SEAICE_INIT_FIXED(mythid)
#endif

#ifdef ALLOW_SHELFICE
      IF (useShelfIce) CALL SHELFICE_INIT_FIXED( myThid )
#endif /* ALLOW_SHELFICE */

#ifdef ALLOW_EMBED_FILES
      IF ( useEMBED_FILES ) CALL EMBED_FILES_INIT( mythid )
#endif

#ifdef ALLOW_REGRID
      IF ( useREGRID ) CALL REGRID_INIT_FIXED( mythid )
#endif

#ifdef ALLOW_MYPACKAGE
      IF (useMYPACKAGE) CALL MYPACKAGE_INIT_FIXED(mythid)
#endif

#ifdef COMPONENT_MODULE
      IF ( useCoupler ) CALL CPL_INIT_FIXED( mythid )
#endif

#ifdef ALLOW_ATM2D
      IF ( useAtm2d ) CALL ATM2D_INIT_FIXED( myThid )
#endif

#ifdef ALLOW_DIAGNOSTICS
C-    needs to call DIAGNOSTICS_INIT_FIXED after all package-diag-init calls
      IF ( useDiagnostics ) CALL DIAGNOSTICS_INIT_FIXED( myThid )
#endif

      RETURN
      END
1	heimbach	1.55	C $Header: /u/gcmpack/MITgcm/model/src/packages_init_fixed.F,v 1.54 2006/09/06 15:30:25 jscott Exp $
2	adcroft	1.3	C $Name: $
3	adcroft	1.2
4	edhill	1.11	#include "PACKAGES_CONFIG.h"
5	adcroft	1.2	#include "CPP_OPTIONS.h"
6
7	cnh	1.4	CBOP
8			C !ROUTINE: PACKAGES_INIT_FIXED
9			C !INTERFACE:
10	adcroft	1.2	SUBROUTINE PACKAGES_INIT_FIXED( myThid )
11	cnh	1.4
12			C !DESCRIPTION: \bv
13			C ==========================================================
14	jmc	1.51	C \| SUBROUTINE PACKAGES_INIT_FIXED
15			C \| o Does initialisation of package-related fixed fields
16	cnh	1.4	C ==========================================================
17			C \ev
18
19			C !CALLING SEQUENCE:
20			C PACKAGES_INIT_FIXED
21			C \|
22	adcroft	1.39	C \|-- RUNCLOCK_INIT
23			C \|
24	jmc	1.34	C \|-- DIAGNOSTICS_INIT_EARLY
25			C \|-- DIAGNOSTICS_MAIN_INIT
26			C \|
27	jmc	1.5	C \|-- GAD_INIT
28			C \|
29	jmc	1.44	C \|-- MOM_INIT_FIXED
30			C \|
31	jmc	1.35	C \|-- CD_CODE_INIT_FIXED
32			C \|
33	dimitri	1.38	C \|-- EXF_INIT_FIXED
34			C \|
35	jmc	1.35	C \|-- GMREDI_INIT_FIXED
36			C \|
37	dimitri	1.37	C \|-- KPP_INIT_FIXED
38			C \|
39	jmc	1.35	C \|-- OPPS_INIT
40			C \|
41	cnh	1.4	C \|-- OBCS_INIT_FIXED
42			C \|
43			C \|-- FLT_INIT
44	jmc	1.6	C \|
45	jmc	1.34	C \|-- TIMEAVE_INIT_FIXED
46			C \|
47	jmc	1.36	C \|-- SHAP_FILT_INIT_FIZED
48			C \|
49	jmc	1.6	C \|-- ZONAL_FILT_INIT
50	jmc	1.7	C \|
51			C \|-- AIM_INITIALISE
52			C \|
53	jmc	1.25	C \|-- GRIDALT_INITIALISE
54			C \|
55			C \|-- FIZHI_INIT_FIXED
56			C \|
57	jmc	1.7	C \|-- LAND_INITIALISE
58	jmc	1.25	C \|
59	jmc	1.44	C \|-- SEAICE_COST_INIT_FIXED
60			C \|
61	jmc	1.25	C \|-- ECCO_COST_INIT_FIXED
62			C \|
63			C \|-- CTRL_INIT
64			C \|
65	jmc	1.49	C \|-- PTRACERS_INIT_FIXED
66	jmc	1.34	C \|
67	jmc	1.25	C \|-- GCHEM_INIT_FIXED
68			C \|
69	edhill	1.42	C \|-- DIC_INIT_FIXED
70			C \|
71	jmc	1.35	C \|-- THSICE_INIT_FIXED
72	mlosch	1.27	C \|
73	mlosch	1.47	C \|-- SHELFICE_INIT_FIXED
74			C \|
75	jmc	1.51	C \|-- MYPACKAGE_INIT_FIXED
76			C \|
77	jmc	1.34	C \|-- CPL_INIT_FIXED
78			C \|
79	jscott	1.54	C \|-- ATM2D_INIT_FIXED
80			C \|
81	jmc	1.34	C \|-- DIAGNOSTICS_INIT_FIXED
82	edhill	1.52	C \|
83			C \|-- REGRID_INIT_FIXED
84	cnh	1.4
85			C !USES:
86	adcroft	1.2	IMPLICIT NONE
87			C === Global variables ===
88			#include "SIZE.h"
89			#include "EEPARAMS.h"
90			#include "PARAMS.h"
91
92	cnh	1.4	C !INPUT/OUTPUT PARAMETERS:
93	adcroft	1.2	C === Routine arguments ===
94			C myThid - Number of this instances
95			INTEGER myThid
96	cnh	1.4	CEOP
97	edhill	1.21
98	adcroft	1.39	#ifdef ALLOW_RUNCLOCK
99			IF ( useRunClock ) THEN
100			CALL RUNCLOCK_INIT( myThid )
101			ENDIF
102			#endif
103
104	jmc	1.33	#ifdef ALLOW_DIAGNOSTICS
105			IF ( useDiagnostics ) THEN
106	jmc	1.51	C- needs to call DIAGNOSTICS_INIT_EARLY before all package-diag-init calls
107	jmc	1.33	CALL DIAGNOSTICS_INIT_EARLY( myThid )
108			CALL DIAGNOSTICS_MAIN_INIT( myThid )
109			ENDIF
110			#endif
111
112	jmc	1.32	#ifdef ALLOW_GENERIC_ADVDIFF
113	edhill	1.21	C-- Initialize fixed params for GAD
114			CALL GAD_INIT( myThid )
115	jmc	1.32	#endif
116	adcroft	1.2
117	jmc	1.44	#ifdef ALLOW_MOM_COMMON
118			C-- Initialize fixed params for Momentum pkgs (common, fluxform, vecinv)
119			IF ( momStepping ) THEN
120			CALL MOM_INIT_FIXED( myThid )
121			ENDIF
122			#endif
123
124	jmc	1.35	#ifdef ALLOW_CD_CODE
125			IF (useCDscheme) THEN
126			CALL CD_CODE_INIT_FIXED(mythid)
127			ENDIF
128			#endif
129
130	dimitri	1.38	#ifdef ALLOW_EXF
131			C-- Initialize fixed arrays for EXF
132			c IF ( useEXF ) THEN
133			CALL EXF_INIT_FIXED( myThid )
134			c ENDIF
135			#endif
136
137	jmc	1.35	#ifdef ALLOW_GMREDI
138			C-- Initialize fixed arrays for GM-Redi
139			IF ( useGMRedi ) THEN
140			CALL GMREDI_INIT_FIXED( myThid )
141			ENDIF
142			#endif
143
144	dimitri	1.37	#ifdef ALLOW_KPP
145			C-- Initialize fixed arrays for KPP
146			IF ( useKPP ) THEN
147			CALL KPP_INIT_FIXED( myThid )
148			ENDIF
149			#endif
150
151	jmc	1.35	#ifdef ALLOW_OPPS
152			IF (useOPPS) CALL OPPS_INIT( myThid )
153			#endif /* ALLOW_OPPS */
154
155	adcroft	1.2	C-- Initialize fixed arrays for OBCS
156			#ifdef ALLOW_OBCS
157			IF (useOBCS) THEN
158			CALL OBCS_INIT_FIXED( myThid )
159	adcroft	1.3	ENDIF
160			#endif
161	edhill	1.26
162	adcroft	1.3	#ifdef ALLOW_FLT
163			C-- Initialise Float positions
164	jmc	1.6	IF (useFLT) THEN
165	adcroft	1.3	CALL FLT_INIT(nIter0,startTime,myThid )
166	jmc	1.6	_BARRIER
167			ENDIF
168			#endif
169	edhill	1.26
170			#ifdef ALLOW_TIMEAVE
171			C IF (useTIMEAVE) THEN
172	jmc	1.36	IF ( taveFreq.GT.0. ) THEN
173			CALL TIMEAVE_INIT_FIXED( myThid )
174			ENDIF
175			#endif
176
177			#ifdef ALLOW_SHAP_FILT
178			C-- Shapiro filter initialisation
179			IF (useSHAP_FILT) THEN
180			CALL SHAP_FILT_INIT_FIXED( myThid )
181			ENDIF
182	edhill	1.26	#endif
183
184	jmc	1.6	#ifdef ALLOW_ZONAL_FILT
185			C-- Latitude circle filter initialisation
186			IF (useZONAL_FILT) THEN
187			CALL ZONAL_FILT_INIT(myThid)
188	adcroft	1.3	_BARRIER
189	adcroft	1.2	ENDIF
190	jmc	1.7	#endif
191
192			#ifdef ALLOW_AIM
193			C-- Initialise & Read AIM physical parameters
194			IF (useAIM) CALL AIM_INITIALISE( myThid )
195			#endif
196	molod	1.15
197			C AMM
198			#ifdef ALLOW_GRIDALT
199			C-- Initialise GRIDALT parameters - the alternative grid
200	molod	1.24	IF (useGRIDALT) then
201			CALL TIMER_START('GRIDALT_INITIALISE [PACKAGES_INIT_F]',mythid)
202			CALL GRIDALT_INITIALISE( myThid )
203			CALL TIMER_STOP ('GRIDALT_INITIALISE [PACKAGES_INIT_F]',mythid)
204			ENDIF
205
206	molod	1.15	#endif
207
208			#ifdef ALLOW_FIZHI
209			C-- Initialise & Read FIZHI physical parameters
210			IF (useFIZHI) CALL FIZHI_INIT_FIXED( myThid )
211	molod	1.16	#endif
212			C AMM
213
214	jmc	1.7	#ifdef ALLOW_LAND
215			C-- Initialise & Read Land package parameters
216			IF (useLand) CALL LAND_INITIALISE( myThid )
217	heimbach	1.8	#endif
218
219	heimbach	1.43	#if (defined (ALLOW_SEAICE) && defined (ALLOW_COST))
220			C-- Initialise ecco-specific cost function.
221			C-- This needs to preceed the call ctrl_init
222			C-- in order to provide the weight files
223			CALL SEAICE_COST_INIT_FIXED( myThid )
224			#endif
225
226	heimbach	1.14	#if (defined (ALLOW_ECCO) && defined (ALLOW_COST))
227			C-- Initialise ecco-specific cost function.
228			C-- This needs to preceed the call ctrl_init
229			C-- in order to provide the weight files
230	heimbach	1.40	CALL ECCO_COST_INIT_FIXED( myThid )
231	heimbach	1.14	#endif
232
233	heimbach	1.48	#ifdef ALLOW_PROFILES
234			CALL PROFILES_INIT_FIXED( myThid )
235			#endif
236
237	heimbach	1.13	#ifdef ALLOW_AUTODIFF
238	heimbach	1.8	C-- Initialise the control variables
239			CALL CTRL_INIT( myThid )
240			_BARRIER
241	adcroft	1.2	#endif
242	stephd	1.10
243			#ifdef ALLOW_PTRACERS
244	jmc	1.49	IF (usePTRACERS) CALL PTRACERS_INIT_FIXED(myThid)
245	jmc	1.25	#endif
246
247	stephd	1.10	#ifdef ALLOW_GCHEM
248	mlosch	1.31	IF (useGCHEM) CALL GCHEM_INIT_FIXED(mythid)
249	stephd	1.10	#endif
250
251	edhill	1.42	#ifdef ALLOW_DIC
252			C IF (useDIC)
253			CALL DIC_INIT_FIXED(mythid)
254			#endif
255
256	stephd	1.45	#ifdef ALLOW_RBCS
257			IF (useRBCS) CALL RBCS_INIT_FIXED(mythid)
258			#endif
259
260	jmc	1.35	#ifdef ALLOW_THSICE
261			IF (useThSIce) CALL THSICE_INIT_FIXED(mythid)
262	heimbach	1.28	#endif
263
264	heimbach	1.55	#ifdef ALLOW_SEAICE
265			IF (useSEAICE) CALL SEAICE_INIT_FIXED(mythid)
266			#endif
267
268	mlosch	1.47	#ifdef ALLOW_SHELFICE
269			IF (useShelfIce) CALL SHELFICE_INIT_FIXED( myThid )
270			#endif /* ALLOW_SHELFICE */
271
272	jmc	1.53	#ifdef ALLOW_EMBED_FILES
273			IF ( useEMBED_FILES ) CALL EMBED_FILES_INIT( mythid )
274			#endif
275
276			#ifdef ALLOW_REGRID
277			IF ( useREGRID ) CALL REGRID_INIT_FIXED( mythid )
278			#endif
279
280	jmc	1.51	#ifdef ALLOW_MYPACKAGE
281			IF (useMYPACKAGE) CALL MYPACKAGE_INIT_FIXED(mythid)
282			#endif
283
284	jmc	1.33	#ifdef COMPONENT_MODULE
285			IF ( useCoupler ) CALL CPL_INIT_FIXED( mythid )
286			#endif
287
288	jscott	1.54	#ifdef ALLOW_ATM2D
289			IF ( useAtm2d ) CALL ATM2D_INIT_FIXED( myThid )
290			#endif
291
292	molod	1.18	#ifdef ALLOW_DIAGNOSTICS
293	jmc	1.51	C- needs to call DIAGNOSTICS_INIT_FIXED after all package-diag-init calls
294	heimbach	1.50	IF ( useDiagnostics ) CALL DIAGNOSTICS_INIT_FIXED( myThid )
295	molod	1.18	#endif
296	edhill	1.30
297	adcroft	1.2	RETURN
298			END