model/src/packages_readparms.F

C $Header: /u/gcmpack/MITgcm/model/src/packages_readparms.F,v 1.41 2005/06/22 21:24:18 heimbach Exp $
C $Name:  $

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

CStartOfInterface
CBOP
C     !ROUTINE: PACKAGES_READPARMS
C     !INTERFACE:
      SUBROUTINE PACKAGES_READPARMS(myThid)

C     !DESCRIPTION: \bv
C     *==========================================================*
C     | SUBROUTINE PACKAGES_READPARMS                             
C     | o Read runtime package configuration parameters           
C     *==========================================================*
C     |   Packages can have internal runtime configuration        
C     |   parameters. A package provides a routine                
C     |   ${PKGNAME}_READ_PARMS to read these parameters. In      
C     |   general this routine should read parameters from a file 
C     |   called data.${pkgname}.                                 
C     |   This routine (S/R PACKAGES_READPARMS) calls per-package 
C     |   parameter reading routines.                             
C     *==========================================================*
C     \ev

C     !CALLING SEQUENCE:
C     PACKAGES_READPARMS
C       |
C       |-- MNC_READPARMS + MNC_INIT + MNC_CW_INIT + INI_MNC_VARS
C       |
C       |-- RUNCLOCK_READPARMS
C       |
C       |-- GMREDI_READPARMS
C       |
C       |-- KPP_READPARMS
C       |
C       |-- PP81_READPARMS
C       |
C       |-- MY82_READPARMS
C       |
C       |-- GGL90_READPARMS
C       |
C       |-- OPPS_READPARMS
C       |
C       |-- SBO_READPARMS
C       |
C       |-- SEAICE_READPARMS
C       |
C       |-- SHAP_FILT_READPARMS
C       |
C       |-- ZONAL_FILT_READPARMS
C       |
C       |-- OBCS_READPARMS
C       |
C       |-- OFFLINE_READPARMS
C       |
C       |-- BULKF_READPARMS
C       |
C       |-- THSICE_READPARMS
C       |
C       |-- GCHEM_READPARMS
C       |
C       |-- OPTIM_READPARMS
C       |
C       |-- CTRL_READPARMS
C       |
C       |-- COST_READPARMS
C       |
C       |-- GRDCHK_READPARMS
C       |
C       |-- CAL_READPARMS
C       |
C       |-- EXF_READPARMS
C       |
C       |-- EBM_READPARMS
C       |
C       |-- ECCO_READPARMS
C       |
C       |-- CPL_READPARMS
C       |
C       |-- FIZHI_READPARMS
C       |
C       |-- CPL_READPARMS
C       |
C       |-- DIAGNOSTICS_READPARMS


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

C     == Routine arguments ==
      INTEGER myThid
CEOP

#ifdef ALLOW_MNC
C     Read run-time flags and initialize look-up tables for MNC
      IF (useMNC) THEN
        CALL MNC_READPARMS( myThid )
        CALL MNC_INIT(myThid)
        CALL MNC_CW_INIT(sNx,sNy,OLx,OLy,nSx,nSy,nPx,nPy,
     &       Nr,myThid)
CEH3       IF ( mnc_echo_gvtypes ) THEN
CEH3       CALL MNC_CW_DUMP( myThid )
CEH3       ENDIF
        
C       Write units/set precision/etc for I/O of variables/arrays
C       belonging to the core dynamical model
        CALL INI_MNC_VARS( myThid )

      ENDIF
#endif

#ifdef ALLOW_RUNCLOCK
C--   Initialize RUNCLOCK parameters
      IF (useRunClock) CALL RUNCLOCK_READPARMS( myThid )
#endif

#ifdef ALLOW_GMREDI
C--   Initialize GM/Redi parameters
      IF (useGMRedi) CALL GMREDI_READPARMS( myThid )
#endif

#ifdef ALLOW_KPP
C--   Initialize KPP parameters
      IF (useKPP) CALL KPP_READPARMS( myThid )
#endif

#ifdef ALLOW_PP81
C--   Initialize PP81 parameters
      IF (usePP81) CALL PP81_READPARMS( myThid )
#endif

#ifdef ALLOW_MY82
C--   Initialize MY82 parameters
      IF (useMY82) CALL MY82_READPARMS( myThid )
#endif

#ifdef ALLOW_GGL90
C--   Initialize GGL90 parameters
      IF (useGGL90) CALL GGL90_READPARMS( myThid )
#endif

#ifdef ALLOW_OPPS
C--   Initialize OPPS parameters
      IF (useOPPS) CALL OPPS_READPARMS( myThid )
#endif

#ifdef ALLOW_SBO
C--   Initialize SBO parameters
      IF (useSBO) CALL SBO_READPARMS( myThid )
#endif

#ifdef ALLOW_SEAICE
C--   Initialize SEAICE parameters
      IF (useSEAICE) CALL SEAICE_READPARMS( myThid )
#endif

#ifdef ALLOW_SHAP_FILT 
      IF (useSHAP_FILT) CALL SHAP_FILT_READPARMS( myThid )
#endif

#ifdef ALLOW_ZONAL_FILT 
      IF (useZONAL_FILT) CALL ZONAL_FILT_READPARMS( myThid )
#endif

#ifdef ALLOW_OBCS
      IF (useOBCS) CALL OBCS_READPARMS( myThid )
#endif

#ifdef ALLOW_OFFLINE
      call OFFLINE_READPARMS( myThid )
#endif

#ifdef ALLOW_BULK_FORCE
C -- initialize Bulkf parameters
      IF (useBulkForce) CALL BULKF_READPARMS( myThid )
#endif

#ifdef ALLOW_THSICE
C -- initialize Therm.Sea-Ice parameters
      IF (useThSIce) CALL THSICE_READPARMS( myThid )
#endif

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

cswdptr -- add --
#ifdef ALLOW_GCHEM
      IF (useGCHEM) CALL GCHEM_READPARMS( myThid )
#endif
cswdptr -- end add ---

#ifdef ALLOW_CTRL
C--   Initialise the optim. parameters.
      call optim_readparms( myThid )
C--   Initialise the control parameters
      call ctrl_readparms( myThid )
#endif

#ifdef ALLOW_COST
C--   Initialise the cost parameters
      call cost_readparms( mythid )
#endif

#ifdef ALLOW_GRDCHK
C--   Initialise gradient check parameters
      if (useGrdchk) call grdchk_readparms( myThid )
#endif

#ifdef ALLOW_CAL
C--   Initialise the calendar package.
ceh3 should have an IF ( useCAL ) THEN
      call cal_readparms( myThid )
#endif

C--   Custom routine to set forcing fields.
#ifdef ALLOW_EXF
ceh3 needs an IF ( useEXF ) THEN
      call exf_readparms  ( mythid )
#endif

#ifdef ALLOW_EBM
      IF (useEBM) call ebm_readparms( mythid )
#endif

#ifdef ALLOW_ECCO
c--   Initialize ECCO package parameters
      call ecco_readparms ( myThid )
#endif

#ifdef COMPONENT_MODULE
C--   set Coupling parameters
      IF ( useCoupler ) CALL CPL_READPARMS( myThid )
#endif /* COMPONENT_MODULE */

CAMM
#ifdef ALLOW_FIZHI
C--   set model date and time and other fizhi parameters
      IF ( usefizhi ) call fizhi_readparms(myThid )
#endif /* ALLOW_FIZHI */
CAMM

#ifdef ALLOW_DIAGNOSTICS
C--   set diagnostics choices
      IF ( useDiagnostics ) CALL DIAGNOSTICS_READPARMS( myThid )
#endif /* ALLOW_DIAGNOSTICS */

#ifdef ALLOW_MATRIX
C--    Initialize matrix package parameters
       IF (useMATRIX) CALL MATRIX_READPARMS ( myThid )
#endif

      RETURN
      END
1	edhill	1.42	C $Header: /u/gcmpack/MITgcm/model/src/packages_readparms.F,v 1.41 2005/06/22 21:24:18 heimbach Exp $
2	edhill	1.22	C $Name: $
3	adcroft	1.2
4	edhill	1.22	#include "PACKAGES_CONFIG.h"
5	heimbach	1.1	#include "CPP_OPTIONS.h"
6
7			CStartOfInterface
8	cnh	1.7	CBOP
9			C !ROUTINE: PACKAGES_READPARMS
10			C !INTERFACE:
11	heimbach	1.1	SUBROUTINE PACKAGES_READPARMS(myThid)
12	cnh	1.7
13			C !DESCRIPTION: \bv
14			C ==========================================================
15			C \| SUBROUTINE PACKAGES_READPARMS
16			C \| o Read runtime package configuration parameters
17			C ==========================================================
18			C \| Packages can have internal runtime configuration
19			C \| parameters. A package provides a routine
20			C \| ${PKGNAME}_READ_PARMS to read these parameters. In
21			C \| general this routine should read parameters from a file
22			C \| called data.${pkgname}.
23			C \| This routine (S/R PACKAGES_READPARMS) calls per-package
24			C \| parameter reading routines.
25			C ==========================================================
26			C \ev
27
28			C !CALLING SEQUENCE:
29			C PACKAGES_READPARMS
30			C \|
31	edhill	1.42	C \|-- MNC_READPARMS + MNC_INIT + MNC_CW_INIT + INI_MNC_VARS
32	jmc	1.38	C \|
33	adcroft	1.40	C \|-- RUNCLOCK_READPARMS
34			C \|
35	cnh	1.7	C \|-- GMREDI_READPARMS
36			C \|
37			C \|-- KPP_READPARMS
38			C \|
39	mlosch	1.33	C \|-- PP81_READPARMS
40			C \|
41			C \|-- MY82_READPARMS
42			C \|
43	mlosch	1.34	C \|-- GGL90_READPARMS
44			C \|
45			C \|-- OPPS_READPARMS
46			C \|
47	dimitri	1.17	C \|-- SBO_READPARMS
48			C \|
49	heimbach	1.14	C \|-- SEAICE_READPARMS
50			C \|
51	cnh	1.7	C \|-- SHAP_FILT_READPARMS
52			C \|
53	jmc	1.8	C \|-- ZONAL_FILT_READPARMS
54			C \|
55	cnh	1.7	C \|-- OBCS_READPARMS
56			C \|
57	stephd	1.32	C \|-- OFFLINE_READPARMS
58			C \|
59	jmc	1.38	C \|-- BULKF_READPARMS
60			C \|
61			C \|-- THSICE_READPARMS
62	cnh	1.7	C \|
63	jmc	1.38	C \|-- GCHEM_READPARMS
64	cnh	1.7	C \|
65			C \|-- OPTIM_READPARMS
66			C \|
67	jmc	1.38	C \|-- CTRL_READPARMS
68			C \|
69			C \|-- COST_READPARMS
70			C \|
71	cnh	1.7	C \|-- GRDCHK_READPARMS
72			C \|
73	jmc	1.38	C \|-- CAL_READPARMS
74			C \|
75			C \|-- EXF_READPARMS
76			C \|
77			C \|-- EBM_READPARMS
78			C \|
79	cnh	1.7	C \|-- ECCO_READPARMS
80	jmc	1.28	C \|
81			C \|-- CPL_READPARMS
82	jmc	1.38	C \|
83			C \|-- FIZHI_READPARMS
84			C \|
85			C \|-- CPL_READPARMS
86			C \|
87			C \|-- DIAGNOSTICS_READPARMS
88	cnh	1.7
89
90			C !USES:
91	heimbach	1.1	IMPLICIT NONE
92			C == Global variables ==
93			#include "SIZE.h"
94			#include "EEPARAMS.h"
95			#include "PARAMS.h"
96
97			C == Routine arguments ==
98			INTEGER myThid
99	cnh	1.7	CEOP
100	heimbach	1.1
101	edhill	1.35	#ifdef ALLOW_MNC
102			C Read run-time flags and initialize look-up tables for MNC
103			IF (useMNC) THEN
104			CALL MNC_READPARMS( myThid )
105			CALL MNC_INIT(myThid)
106			CALL MNC_CW_INIT(sNx,sNy,OLx,OLy,nSx,nSy,nPx,nPy,
107			& Nr,myThid)
108			CEH3 IF ( mnc_echo_gvtypes ) THEN
109			CEH3 CALL MNC_CW_DUMP( myThid )
110			CEH3 ENDIF
111	edhill	1.42
112			C Write units/set precision/etc for I/O of variables/arrays
113			C belonging to the core dynamical model
114			CALL INI_MNC_VARS( myThid )
115
116	edhill	1.35	ENDIF
117			#endif
118
119	adcroft	1.40	#ifdef ALLOW_RUNCLOCK
120			C-- Initialize RUNCLOCK parameters
121			IF (useRunClock) CALL RUNCLOCK_READPARMS( myThid )
122			#endif
123
124	heimbach	1.1	#ifdef ALLOW_GMREDI
125			C-- Initialize GM/Redi parameters
126			IF (useGMRedi) CALL GMREDI_READPARMS( myThid )
127			#endif
128
129			#ifdef ALLOW_KPP
130			C-- Initialize KPP parameters
131			IF (useKPP) CALL KPP_READPARMS( myThid )
132	dimitri	1.17	#endif
133
134	mlosch	1.33	#ifdef ALLOW_PP81
135			C-- Initialize PP81 parameters
136			IF (usePP81) CALL PP81_READPARMS( myThid )
137			#endif
138
139			#ifdef ALLOW_MY82
140			C-- Initialize MY82 parameters
141			IF (useMY82) CALL MY82_READPARMS( myThid )
142			#endif
143
144	mlosch	1.34	#ifdef ALLOW_GGL90
145			C-- Initialize GGL90 parameters
146			IF (useGGL90) CALL GGL90_READPARMS( myThid )
147			#endif
148
149			#ifdef ALLOW_OPPS
150			C-- Initialize OPPS parameters
151			IF (useOPPS) CALL OPPS_READPARMS( myThid )
152			#endif
153
154	dimitri	1.17	#ifdef ALLOW_SBO
155			C-- Initialize SBO parameters
156			IF (useSBO) CALL SBO_READPARMS( myThid )
157	heimbach	1.14	#endif
158
159			#ifdef ALLOW_SEAICE
160			C-- Initialize SEAICE parameters
161			IF (useSEAICE) CALL SEAICE_READPARMS( myThid )
162	adcroft	1.5	#endif
163
164			#ifdef ALLOW_SHAP_FILT
165			IF (useSHAP_FILT) CALL SHAP_FILT_READPARMS( myThid )
166	jmc	1.8	#endif
167
168			#ifdef ALLOW_ZONAL_FILT
169			IF (useZONAL_FILT) CALL ZONAL_FILT_READPARMS( myThid )
170	adcroft	1.2	#endif
171
172			#ifdef ALLOW_OBCS
173			IF (useOBCS) CALL OBCS_READPARMS( myThid )
174	adcroft	1.10	#endif
175
176	stephd	1.32	#ifdef ALLOW_OFFLINE
177			call OFFLINE_READPARMS( myThid )
178			#endif
179
180	cheisey	1.16	#ifdef ALLOW_BULK_FORCE
181	cheisey	1.15	C -- initialize Bulkf parameters
182	jmc	1.27	IF (useBulkForce) CALL BULKF_READPARMS( myThid )
183	cheisey	1.15	#endif
184
185	jmc	1.27	#ifdef ALLOW_THSICE
186			C -- initialize Therm.Sea-Ice parameters
187			IF (useThSIce) CALL THSICE_READPARMS( myThid )
188	cheisey	1.15	#endif
189
190	adcroft	1.10	#ifdef ALLOW_PTRACERS
191			IF (usePTRACERS) CALL PTRACERS_READPARMS( myThid )
192	heimbach	1.21	#endif
193
194	stephd	1.20	cswdptr -- add --
195	heimbach	1.21	#ifdef ALLOW_GCHEM
196	mlosch	1.36	IF (useGCHEM) CALL GCHEM_READPARMS( myThid )
197	heimbach	1.21	#endif
198	stephd	1.20	cswdptr -- end add ---
199	heimbach	1.4
200	heimbach	1.37	#ifdef ALLOW_CTRL
201	heimbach	1.11	C-- Initialise the optim. parameters.
202			call optim_readparms( myThid )
203	heimbach	1.19	C-- Initialise the control parameters
204			call ctrl_readparms( myThid )
205	heimbach	1.37	#endif
206
207			#ifdef ALLOW_COST
208	heimbach	1.19	C-- Initialise the cost parameters
209			call cost_readparms( mythid )
210	heimbach	1.11	#endif
211	heimbach	1.6
212	heimbach	1.24	#ifdef ALLOW_GRDCHK
213	heimbach	1.6	C-- Initialise gradient check parameters
214			if (useGrdchk) call grdchk_readparms( myThid )
215	heimbach	1.1	#endif
216	heimbach	1.6
217	edhill	1.22	#ifdef ALLOW_CAL
218	heimbach	1.11	C-- Initialise the calendar package.
219	edhill	1.22	ceh3 should have an IF ( useCAL ) THEN
220	heimbach	1.11	call cal_readparms( myThid )
221			#endif
222
223			C-- Custom routine to set forcing fields.
224	edhill	1.25	#ifdef ALLOW_EXF
225	edhill	1.22	ceh3 needs an IF ( useEXF ) THEN
226	heimbach	1.11	call exf_readparms ( mythid )
227	heimbach	1.30	#endif
228
229			#ifdef ALLOW_EBM
230			IF (useEBM) call ebm_readparms( mythid )
231	heimbach	1.11	#endif
232	heimbach	1.1
233	heimbach	1.26	#ifdef ALLOW_ECCO
234	heimbach	1.1	c-- Initialize ECCO package parameters
235	heimbach	1.41	call ecco_readparms ( myThid )
236	heimbach	1.1	#endif
237	jmc	1.28
238			#ifdef COMPONENT_MODULE
239			C-- set Coupling parameters
240			IF ( useCoupler ) CALL CPL_READPARMS( myThid )
241			#endif /* COMPONENT_MODULE */
242	molod	1.29
243			CAMM
244	molod	1.31	#ifdef ALLOW_FIZHI
245			C-- set model date and time and other fizhi parameters
246			IF ( usefizhi ) call fizhi_readparms(myThid )
247			#endif /* ALLOW_FIZHI */
248	molod	1.29	CAMM
249	heimbach	1.1
250	jmc	1.38	#ifdef ALLOW_DIAGNOSTICS
251			C-- set diagnostics choices
252			IF ( useDiagnostics ) CALL DIAGNOSTICS_READPARMS( myThid )
253			#endif /* ALLOW_DIAGNOSTICS */
254
255	spk	1.39	#ifdef ALLOW_MATRIX
256			C-- Initialize matrix package parameters
257			IF (useMATRIX) CALL MATRIX_READPARMS ( myThid )
258			#endif
259
260	jmc	1.27	RETURN
261	heimbach	1.1	END