model/src/packages_init_fixed.F

C $Header: /u/gcmpack/MITgcm/model/src/packages_init_fixed.F,v 1.51 2006/07/29 21:00:09 jmc 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       |-- 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_SHELFICE
      IF (useShelfIce) CALL SHELFICE_INIT_FIXED( myThid )
#endif /* ALLOW_SHELFICE */

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

#ifdef COMPONENT_MODULE
      IF ( useCoupler ) CALL CPL_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

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

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

      RETURN
      END
1	edhill	1.52	C $Header: /u/gcmpack/MITgcm/model/src/packages_init_fixed.F,v 1.51 2006/07/29 21:00:09 jmc 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			C \|-- DIAGNOSTICS_INIT_FIXED
80	edhill	1.52	C \|
81			C \|-- REGRID_INIT_FIXED
82	cnh	1.4
83			C !USES:
84	adcroft	1.2	IMPLICIT NONE
85			C === Global variables ===
86			#include "SIZE.h"
87			#include "EEPARAMS.h"
88			#include "PARAMS.h"
89
90	cnh	1.4	C !INPUT/OUTPUT PARAMETERS:
91	adcroft	1.2	C === Routine arguments ===
92			C myThid - Number of this instances
93			INTEGER myThid
94	cnh	1.4	CEOP
95	edhill	1.21
96	adcroft	1.39	#ifdef ALLOW_RUNCLOCK
97			IF ( useRunClock ) THEN
98			CALL RUNCLOCK_INIT( myThid )
99			ENDIF
100			#endif
101
102	jmc	1.33	#ifdef ALLOW_DIAGNOSTICS
103			IF ( useDiagnostics ) THEN
104	jmc	1.51	C- needs to call DIAGNOSTICS_INIT_EARLY before all package-diag-init calls
105	jmc	1.33	CALL DIAGNOSTICS_INIT_EARLY( myThid )
106			CALL DIAGNOSTICS_MAIN_INIT( myThid )
107			ENDIF
108			#endif
109
110	jmc	1.32	#ifdef ALLOW_GENERIC_ADVDIFF
111	edhill	1.21	C-- Initialize fixed params for GAD
112			CALL GAD_INIT( myThid )
113	jmc	1.32	#endif
114	adcroft	1.2
115	jmc	1.44	#ifdef ALLOW_MOM_COMMON
116			C-- Initialize fixed params for Momentum pkgs (common, fluxform, vecinv)
117			IF ( momStepping ) THEN
118			CALL MOM_INIT_FIXED( myThid )
119			ENDIF
120			#endif
121
122	jmc	1.35	#ifdef ALLOW_CD_CODE
123			IF (useCDscheme) THEN
124			CALL CD_CODE_INIT_FIXED(mythid)
125			ENDIF
126			#endif
127
128	dimitri	1.38	#ifdef ALLOW_EXF
129			C-- Initialize fixed arrays for EXF
130			c IF ( useEXF ) THEN
131			CALL EXF_INIT_FIXED( myThid )
132			c ENDIF
133			#endif
134
135	jmc	1.35	#ifdef ALLOW_GMREDI
136			C-- Initialize fixed arrays for GM-Redi
137			IF ( useGMRedi ) THEN
138			CALL GMREDI_INIT_FIXED( myThid )
139			ENDIF
140			#endif
141
142	dimitri	1.37	#ifdef ALLOW_KPP
143			C-- Initialize fixed arrays for KPP
144			IF ( useKPP ) THEN
145			CALL KPP_INIT_FIXED( myThid )
146			ENDIF
147			#endif
148
149	jmc	1.35	#ifdef ALLOW_OPPS
150			IF (useOPPS) CALL OPPS_INIT( myThid )
151			#endif /* ALLOW_OPPS */
152
153	adcroft	1.2	C-- Initialize fixed arrays for OBCS
154			#ifdef ALLOW_OBCS
155			IF (useOBCS) THEN
156			CALL OBCS_INIT_FIXED( myThid )
157	adcroft	1.3	ENDIF
158			#endif
159	edhill	1.26
160	adcroft	1.3	#ifdef ALLOW_FLT
161			C-- Initialise Float positions
162	jmc	1.6	IF (useFLT) THEN
163	adcroft	1.3	CALL FLT_INIT(nIter0,startTime,myThid )
164	jmc	1.6	_BARRIER
165			ENDIF
166			#endif
167	edhill	1.26
168			#ifdef ALLOW_TIMEAVE
169			C IF (useTIMEAVE) THEN
170	jmc	1.36	IF ( taveFreq.GT.0. ) THEN
171			CALL TIMEAVE_INIT_FIXED( myThid )
172			ENDIF
173			#endif
174
175			#ifdef ALLOW_SHAP_FILT
176			C-- Shapiro filter initialisation
177			IF (useSHAP_FILT) THEN
178			CALL SHAP_FILT_INIT_FIXED( myThid )
179			ENDIF
180	edhill	1.26	#endif
181
182	jmc	1.6	#ifdef ALLOW_ZONAL_FILT
183			C-- Latitude circle filter initialisation
184			IF (useZONAL_FILT) THEN
185			CALL ZONAL_FILT_INIT(myThid)
186	adcroft	1.3	_BARRIER
187	adcroft	1.2	ENDIF
188	jmc	1.7	#endif
189
190			#ifdef ALLOW_AIM
191			C-- Initialise & Read AIM physical parameters
192			IF (useAIM) CALL AIM_INITIALISE( myThid )
193			#endif
194	molod	1.15
195			C AMM
196			#ifdef ALLOW_GRIDALT
197			C-- Initialise GRIDALT parameters - the alternative grid
198	molod	1.24	IF (useGRIDALT) then
199			CALL TIMER_START('GRIDALT_INITIALISE [PACKAGES_INIT_F]',mythid)
200			CALL GRIDALT_INITIALISE( myThid )
201			CALL TIMER_STOP ('GRIDALT_INITIALISE [PACKAGES_INIT_F]',mythid)
202			ENDIF
203
204	molod	1.15	#endif
205
206			#ifdef ALLOW_FIZHI
207			C-- Initialise & Read FIZHI physical parameters
208			IF (useFIZHI) CALL FIZHI_INIT_FIXED( myThid )
209	molod	1.16	#endif
210			C AMM
211
212	jmc	1.7	#ifdef ALLOW_LAND
213			C-- Initialise & Read Land package parameters
214			IF (useLand) CALL LAND_INITIALISE( myThid )
215	heimbach	1.8	#endif
216
217	heimbach	1.43	#if (defined (ALLOW_SEAICE) && defined (ALLOW_COST))
218			C-- Initialise ecco-specific cost function.
219			C-- This needs to preceed the call ctrl_init
220			C-- in order to provide the weight files
221			CALL SEAICE_COST_INIT_FIXED( myThid )
222			#endif
223
224	heimbach	1.14	#if (defined (ALLOW_ECCO) && defined (ALLOW_COST))
225			C-- Initialise ecco-specific cost function.
226			C-- This needs to preceed the call ctrl_init
227			C-- in order to provide the weight files
228	heimbach	1.40	CALL ECCO_COST_INIT_FIXED( myThid )
229	heimbach	1.14	#endif
230
231	heimbach	1.48	#ifdef ALLOW_PROFILES
232			CALL PROFILES_INIT_FIXED( myThid )
233			#endif
234
235	heimbach	1.13	#ifdef ALLOW_AUTODIFF
236	heimbach	1.8	C-- Initialise the control variables
237			CALL CTRL_INIT( myThid )
238			_BARRIER
239	adcroft	1.2	#endif
240	stephd	1.10
241			#ifdef ALLOW_PTRACERS
242	jmc	1.49	IF (usePTRACERS) CALL PTRACERS_INIT_FIXED(myThid)
243	jmc	1.25	#endif
244
245	stephd	1.10	#ifdef ALLOW_GCHEM
246	mlosch	1.31	IF (useGCHEM) CALL GCHEM_INIT_FIXED(mythid)
247	stephd	1.10	#endif
248
249	edhill	1.42	#ifdef ALLOW_DIC
250			C IF (useDIC)
251			CALL DIC_INIT_FIXED(mythid)
252			#endif
253
254	stephd	1.45	#ifdef ALLOW_RBCS
255			IF (useRBCS) CALL RBCS_INIT_FIXED(mythid)
256			#endif
257
258	jmc	1.35	#ifdef ALLOW_THSICE
259			IF (useThSIce) CALL THSICE_INIT_FIXED(mythid)
260	heimbach	1.28	#endif
261
262	mlosch	1.47	#ifdef ALLOW_SHELFICE
263			IF (useShelfIce) CALL SHELFICE_INIT_FIXED( myThid )
264			#endif /* ALLOW_SHELFICE */
265
266	jmc	1.51	#ifdef ALLOW_MYPACKAGE
267			IF (useMYPACKAGE) CALL MYPACKAGE_INIT_FIXED(mythid)
268			#endif
269
270	jmc	1.33	#ifdef COMPONENT_MODULE
271			IF ( useCoupler ) CALL CPL_INIT_FIXED( mythid )
272			#endif
273
274	molod	1.18	#ifdef ALLOW_DIAGNOSTICS
275	jmc	1.51	C- needs to call DIAGNOSTICS_INIT_FIXED after all package-diag-init calls
276	heimbach	1.50	IF ( useDiagnostics ) CALL DIAGNOSTICS_INIT_FIXED( myThid )
277	molod	1.18	#endif
278	edhill	1.30
279	edhill	1.46	#ifdef ALLOW_EMBED_FILES
280	heimbach	1.50	IF ( useEMBED_FILES ) CALL EMBED_FILES_INIT( mythid )
281			#endif
282
283	edhill	1.52	#ifdef ALLOW_REGRID
284			IF ( useREGRID ) CALL REGRID_INIT_FIXED( mythid )
285			#endif
286
287	adcroft	1.2	RETURN
288			END