model/src/packages_readparms.F

C $Header: /u/gcmpack/MITgcm/model/src/packages_readparms.F,v 1.30 2004/05/14 21:08:28 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       |-- GMREDI_READPARMS
C       |
C       |-- KPP_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       |-- COST_READPARMS
C       |
C       |-- CTRL_INIT
C       |
C       |-- OPTIM_READPARMS
C       |
C       |-- GRDCHK_READPARMS
C       |
C       |-- ECCO_READPARMS
C       |
C       |-- CPL_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_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_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_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 (usePTRACERS) CALL GCHEM_READPARMS( myThid )
#endif
cswdptr -- end add ---

#ifdef ALLOW_AUTODIFF
C--   Initialise the optim. parameters.
      call optim_readparms( myThid )
C--   Initialise the control parameters
      call ctrl_readparms( myThid )
C--   Initialise the cost parameters
      call cost_readparms( mythid )
      _BARRIER
#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
      IF (useECCO) call ecco_readparms ( myThid )
#endif

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

CAMM
#ifdef ALLOW_DIAGNOSTICS
C--   set diagnostics choices
      IF ( usediagnostics ) call diag_readparms(myThid )
#endif /* ALLOW_DIAGNOSTICS */
CAMM

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

      RETURN
      END
1	molod	1.31	C $Header: /u/gcmpack/MITgcm/model/src/packages_readparms.F,v 1.30 2004/05/14 21:08:28 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			C \|-- GMREDI_READPARMS
32			C \|
33			C \|-- KPP_READPARMS
34			C \|
35	dimitri	1.17	C \|-- SBO_READPARMS
36			C \|
37	heimbach	1.14	C \|-- SEAICE_READPARMS
38			C \|
39	cnh	1.7	C \|-- SHAP_FILT_READPARMS
40			C \|
41	jmc	1.8	C \|-- ZONAL_FILT_READPARMS
42			C \|
43	cnh	1.7	C \|-- OBCS_READPARMS
44			C \|
45			C \|-- COST_READPARMS
46			C \|
47			C \|-- CTRL_INIT
48			C \|
49			C \|-- OPTIM_READPARMS
50			C \|
51			C \|-- GRDCHK_READPARMS
52			C \|
53			C \|-- ECCO_READPARMS
54	jmc	1.28	C \|
55			C \|-- CPL_READPARMS
56	cnh	1.7
57
58			C !USES:
59	heimbach	1.1	IMPLICIT NONE
60			C == Global variables ==
61			#include "SIZE.h"
62			#include "EEPARAMS.h"
63			#include "PARAMS.h"
64
65			C == Routine arguments ==
66			INTEGER myThid
67	cnh	1.7	CEOP
68	heimbach	1.1
69			#ifdef ALLOW_GMREDI
70			C-- Initialize GM/Redi parameters
71			IF (useGMRedi) CALL GMREDI_READPARMS( myThid )
72			#endif
73
74			#ifdef ALLOW_KPP
75			C-- Initialize KPP parameters
76			IF (useKPP) CALL KPP_READPARMS( myThid )
77	dimitri	1.17	#endif
78
79			#ifdef ALLOW_SBO
80			C-- Initialize SBO parameters
81			IF (useSBO) CALL SBO_READPARMS( myThid )
82	heimbach	1.14	#endif
83
84			#ifdef ALLOW_SEAICE
85			C-- Initialize SEAICE parameters
86			IF (useSEAICE) CALL SEAICE_READPARMS( myThid )
87	adcroft	1.5	#endif
88
89			#ifdef ALLOW_SHAP_FILT
90			IF (useSHAP_FILT) CALL SHAP_FILT_READPARMS( myThid )
91	jmc	1.8	#endif
92
93			#ifdef ALLOW_ZONAL_FILT
94			IF (useZONAL_FILT) CALL ZONAL_FILT_READPARMS( myThid )
95	adcroft	1.2	#endif
96
97			#ifdef ALLOW_OBCS
98			IF (useOBCS) CALL OBCS_READPARMS( myThid )
99	adcroft	1.10	#endif
100
101	cheisey	1.16	#ifdef ALLOW_BULK_FORCE
102	cheisey	1.15	C -- initialize Bulkf parameters
103	jmc	1.27	IF (useBulkForce) CALL BULKF_READPARMS( myThid )
104	cheisey	1.15	#endif
105
106	jmc	1.27	#ifdef ALLOW_THSICE
107			C -- initialize Therm.Sea-Ice parameters
108			IF (useThSIce) CALL THSICE_READPARMS( myThid )
109	cheisey	1.15	#endif
110
111	adcroft	1.10	#ifdef ALLOW_PTRACERS
112			IF (usePTRACERS) CALL PTRACERS_READPARMS( myThid )
113	heimbach	1.21	#endif
114
115	stephd	1.20	cswdptr -- add --
116	heimbach	1.21	#ifdef ALLOW_GCHEM
117	stephd	1.20	IF (usePTRACERS) CALL GCHEM_READPARMS( myThid )
118	heimbach	1.21	#endif
119	stephd	1.20	cswdptr -- end add ---
120	heimbach	1.4
121	heimbach	1.24	#ifdef ALLOW_AUTODIFF
122	heimbach	1.11	C-- Initialise the optim. parameters.
123			call optim_readparms( myThid )
124	heimbach	1.19	C-- Initialise the control parameters
125			call ctrl_readparms( myThid )
126			C-- Initialise the cost parameters
127			call cost_readparms( mythid )
128	heimbach	1.6	_BARRIER
129	heimbach	1.11	#endif
130	heimbach	1.6
131	heimbach	1.24	#ifdef ALLOW_GRDCHK
132	heimbach	1.6	C-- Initialise gradient check parameters
133			if (useGrdchk) call grdchk_readparms( myThid )
134	heimbach	1.1	#endif
135	heimbach	1.6
136	edhill	1.22	#ifdef ALLOW_CAL
137	heimbach	1.11	C-- Initialise the calendar package.
138	edhill	1.22	ceh3 should have an IF ( useCAL ) THEN
139	heimbach	1.11	call cal_readparms( myThid )
140			#endif
141
142			C-- Custom routine to set forcing fields.
143	edhill	1.25	#ifdef ALLOW_EXF
144	edhill	1.22	ceh3 needs an IF ( useEXF ) THEN
145	heimbach	1.11	call exf_readparms ( mythid )
146	heimbach	1.30	#endif
147
148			#ifdef ALLOW_EBM
149			IF (useEBM) call ebm_readparms( mythid )
150	heimbach	1.11	#endif
151	heimbach	1.1
152	heimbach	1.26	#ifdef ALLOW_ECCO
153	heimbach	1.1	c-- Initialize ECCO package parameters
154	heimbach	1.19	IF (useECCO) call ecco_readparms ( myThid )
155	heimbach	1.1	#endif
156	jmc	1.28
157			#ifdef COMPONENT_MODULE
158			C-- set Coupling parameters
159			IF ( useCoupler ) CALL CPL_READPARMS( myThid )
160			#endif /* COMPONENT_MODULE */
161	molod	1.29
162			CAMM
163			#ifdef ALLOW_DIAGNOSTICS
164			C-- set diagnostics choices
165			IF ( usediagnostics ) call diag_readparms(myThid )
166			#endif /* ALLOW_DIAGNOSTICS */
167	molod	1.31	CAMM
168
169			CAMM
170			#ifdef ALLOW_FIZHI
171			C-- set model date and time and other fizhi parameters
172			IF ( usefizhi ) call fizhi_readparms(myThid )
173			#endif /* ALLOW_FIZHI */
174	molod	1.29	CAMM
175	heimbach	1.1
176	jmc	1.27	RETURN
177	heimbach	1.1	END