model/src/packages_readparms.F

C $Header: /u/gcmpack/models/MITgcmUV/model/src/packages_readparms.F,v 1.7 2001/09/26 18:09:16 cnh Exp $
C $Name:  $

#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       |-- SHAP_FILT_READPARMS
C       |
C       |-- ZONAL_FILT_READPARMS
C       |
C       |-- OBCS_READPARMS
C       |
C       |-- AIM_READPARMS
C       |
C       |-- COST_READPARMS
C       |
C       |-- CTRL_INIT
C       |
C       |-- OPTIM_READPARMS
C       |
C       |-- GRDCHK_READPARMS
C       |
C       |-- ECCO_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_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_AIM
c--   Read in AIM package parameters
C     Currently AIM does not have any runtime parameters
C     IF (useAIM) CALL AIM_READPARMS ( myThid )
#endif

#ifdef ALLOW_ADJOINT_RUN

C--   Initialise the cost function.
      call cost_readparms( mythid )
      _BARRIER

C--   Initialise the control vector.
      CALL ctrl_init( myThid )
      _BARRIER
C--   Initialise the optim. parameters.
      call optim_readparms( myThid )
      _BARRIER

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

#endif /* ALLOW_ADJOINT_RUN */

#ifdef INCLUDE_ECCO_PACKAGE
c--   Initialize ECCO package parameters
      IF (useECCO) CALL ECCO_READPARMS ( myThid )
#endif

      END
1	jmc	1.8	C $Header: /u/gcmpack/models/MITgcmUV/model/src/packages_readparms.F,v 1.7 2001/09/26 18:09:16 cnh Exp $
2	cnh	1.7	C $Name: $
3	adcroft	1.2
4	heimbach	1.1	#include "CPP_OPTIONS.h"
5
6			CStartOfInterface
7	cnh	1.7	CBOP
8			C !ROUTINE: PACKAGES_READPARMS
9			C !INTERFACE:
10	heimbach	1.1	SUBROUTINE PACKAGES_READPARMS(myThid)
11	cnh	1.7
12			C !DESCRIPTION: \bv
13			C ==========================================================
14			C \| SUBROUTINE PACKAGES_READPARMS
15			C \| o Read runtime package configuration parameters
16			C ==========================================================
17			C \| Packages can have internal runtime configuration
18			C \| parameters. A package provides a routine
19			C \| ${PKGNAME}_READ_PARMS to read these parameters. In
20			C \| general this routine should read parameters from a file
21			C \| called data.${pkgname}.
22			C \| This routine (S/R PACKAGES_READPARMS) calls per-package
23			C \| parameter reading routines.
24			C ==========================================================
25			C \ev
26
27			C !CALLING SEQUENCE:
28			C PACKAGES_READPARMS
29			C \|
30			C \|-- GMREDI_READPARMS
31			C \|
32			C \|-- KPP_READPARMS
33			C \|
34			C \|-- SHAP_FILT_READPARMS
35			C \|
36	jmc	1.8	C \|-- ZONAL_FILT_READPARMS
37			C \|
38	cnh	1.7	C \|-- OBCS_READPARMS
39			C \|
40			C \|-- AIM_READPARMS
41			C \|
42			C \|-- COST_READPARMS
43			C \|
44			C \|-- CTRL_INIT
45			C \|
46			C \|-- OPTIM_READPARMS
47			C \|
48			C \|-- GRDCHK_READPARMS
49			C \|
50			C \|-- ECCO_READPARMS
51
52
53			C !USES:
54	heimbach	1.1	IMPLICIT NONE
55			C == Global variables ==
56			#include "SIZE.h"
57			#include "EEPARAMS.h"
58			#include "PARAMS.h"
59
60			C == Routine arguments ==
61			INTEGER myThid
62	cnh	1.7	CEOP
63	heimbach	1.1
64			#ifdef ALLOW_GMREDI
65			C-- Initialize GM/Redi parameters
66			IF (useGMRedi) CALL GMREDI_READPARMS( myThid )
67			#endif
68
69			#ifdef ALLOW_KPP
70			C-- Initialize KPP parameters
71			IF (useKPP) CALL KPP_READPARMS( myThid )
72	adcroft	1.5	#endif
73
74			#ifdef ALLOW_SHAP_FILT
75			IF (useSHAP_FILT) CALL SHAP_FILT_READPARMS( myThid )
76	jmc	1.8	#endif
77
78			#ifdef ALLOW_ZONAL_FILT
79			IF (useZONAL_FILT) CALL ZONAL_FILT_READPARMS( myThid )
80	adcroft	1.2	#endif
81
82			#ifdef ALLOW_OBCS
83			IF (useOBCS) CALL OBCS_READPARMS( myThid )
84	jmc	1.3	#endif
85
86			#ifdef ALLOW_AIM
87			c-- Read in AIM package parameters
88			C Currently AIM does not have any runtime parameters
89			C IF (useAIM) CALL AIM_READPARMS ( myThid )
90	heimbach	1.4	#endif
91
92	heimbach	1.6	#ifdef ALLOW_ADJOINT_RUN
93
94	heimbach	1.4	C-- Initialise the cost function.
95			call cost_readparms( mythid )
96			_BARRIER
97
98			C-- Initialise the control vector.
99	heimbach	1.6	CALL ctrl_init( myThid )
100			_BARRIER
101			C-- Initialise the optim. parameters.
102			call optim_readparms( myThid )
103	heimbach	1.4	_BARRIER
104	heimbach	1.6
105			#ifdef ALLOW_GRADIENT_CHECK
106			C-- Initialise gradient check parameters
107			if (useGrdchk) call grdchk_readparms( myThid )
108	heimbach	1.1	#endif
109	heimbach	1.6
110			#endif /* ALLOW_ADJOINT_RUN */
111	heimbach	1.1
112			#ifdef INCLUDE_ECCO_PACKAGE
113			c-- Initialize ECCO package parameters
114			IF (useECCO) CALL ECCO_READPARMS ( myThid )
115			#endif
116
117			END