model/src/packages_init_fixed.F

C $Header: /u/gcmpack/MITgcm/model/src/packages_init_fixed.F,v 1.44 2005/09/04 19:24:27 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       |-- ATM_DIAGNOSTICS_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_INITIALISE
C       |
C       |-- GCHEM_INIT_FIXED
C       |
C       |-- DIC_INIT_FIXED
C       |
C       |-- THSICE_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
        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_AUTODIFF
C--   Initialise the control variables
      CALL CTRL_INIT( myThid )
      _BARRIER
#endif

#ifdef ALLOW_PTRACERS
      IF (usePTRACERS) CALL PTRACERS_INITIALISE(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 COMPONENT_MODULE
      IF ( useCoupler ) CALL CPL_INIT_FIXED( mythid )
#endif

#ifdef ALLOW_DIAGNOSTICS
      IF ( useDiagnostics ) THEN
        CALL DIAGNOSTICS_INIT_FIXED( myThid )
      ENDIF
#endif

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