model/src/packages_init_fixed.F

C $Header: /u/gcmpack/MITgcm/model/src/packages_init_fixed.F,v 1.50 2006/06/28 21:24:54 heimbach 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     !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

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