model/src/packages_boot.F

C $Header: /u/gcmpack/MITgcm/model/src/packages_boot.F,v 1.42 2007/11/24 15:44:52 dimitri Exp $
C $Name:  $

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

CBOP
C     !ROUTINE: PACKAGES_BOOT
C     !INTERFACE:
      SUBROUTINE PACKAGES_BOOT( myThid )

C     !DESCRIPTION: \bv
C     *==========================================================*
C     | SUBROUTINE PACKAGES_BOOT                                  
C     | o Routine to parse runtime package selection file         
C     *==========================================================*
C     | Routine reads a flat file which contains a single flag    
C     | for each known "package". Flag can enables runtime        
C     | activation or deactivation of a package. The data is read 
C     | from a file called data.pkg.                              
C     | Note - If a runtime activation flag is set on but the     
C     |        package code was not included in the build then    
C     |        the default behavior is to stop with an error.     
C     *==========================================================*
C     \ev

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

C     !LOCAL VARIABLES:
C     === Local variables ===
C     msgBuf      - Informational/error meesage buffer
C     iUnit       - Work variable for IO unit number
      CHARACTER*(MAX_LEN_MBUF) msgBuf
      INTEGER iUnit

C     data.pkg namelists
      NAMELIST /PACKAGES/
     &          useOPPS,
     &          usePP81,
     &          useMY82,
     &          useGGL90,
     &          useKPP,
     &          useGMRedi,
     &          useOBCS,
     &          useAIM,
     &          useLand,
     &          useGrdchk,
     &          useEXF,
     &          useECCO,
     &          useSHAP_FILT,
     &          useZONAL_FILT,
     &          useFLT,
     &          usePTRACERS,
     &          useGCHEM,
     &          useRBCS,
     &          useOffLine,
     &          useSBO,
     &          useSEAICE,
     &          useShelfIce,
     &          useThSIce,
     &          useATM2D,
     &          useBulkForce,
     &          useEBM,
     &          usefizhi,
     &          usegridalt,
     &          useDiagnostics,
     &          useMNC,
     &          useREGRID,
     &          useRunClock,
     &          useMATRIX,
     &          useEMBED_FILES,
     &          useMYPACKAGE,
     &          useSaltPlume
CEOP

      _BEGIN_MASTER(myThid)

      WRITE(msgBuf,'(A)') ' PACKAGES_BOOT: opening data.pkg'
      CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
     &                    SQUEEZE_RIGHT , myThid )


      CALL OPEN_COPY_DATA_FILE(
     I                          'data.pkg', 'PACKAGES_BOOT',
     O                          iUnit,
     I                          myThid )

C--   Default package configuration
      useOPPS         =.FALSE.
      usePP81         =.FALSE.
      useMY82         =.FALSE.
      useGGL90        =.FALSE.
      useKPP          =.FALSE.
      useGMRedi       =.FALSE.
      useOBCS         =.FALSE.
      useAIM          =.FALSE.
      useLand         =.FALSE.
      useCAL          =.FALSE.
      useEXF          =.FALSE.
      useEBM          =.FALSE.
      useGrdchk       =.FALSE.
      useECCO         =.FALSE.
      useSHAP_FILT    =.FALSE.
      useZONAL_FILT   =.FALSE.
      useFLT          =.FALSE.
      usePTRACERS     =.FALSE.
      useGCHEM        =.FALSE.
      useRBCS         =.FALSE.
      useOffLine      =.FALSE.
      useMATRIX       =.FALSE.
      useSBO          =.FALSE.
      useSEAICE       =.FALSE.
      useShelfIce     =.FALSE.
      useThSIce       =.FALSE.
      useATM2D        =.FALSE.
      useBulkForce    =.FALSE.
      usefizhi        =.FALSE.
      usegridalt      =.FALSE.
      useDiagnostics  =.FALSE.
      useMNC          =.FALSE.
      useRunClock     =.FALSE.
      useREGRID       =.FALSE.
      useMYPACKAGE    =.FALSE.
      useSaltPlume    =.FALSE.

C--   Read parameters from open data file
      READ(UNIT=iUnit,NML=PACKAGES)


      WRITE(msgBuf,'(A)') ' PACKAGES_BOOT: finished reading data.pkg'
      CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
     &                    SQUEEZE_RIGHT , myThid )

C--   Close the open data file
      CLOSE(iUnit)

C--   packages with hard-coded switch
#ifdef ALLOW_CAL
      IF (useEXF) useCAL = .TRUE.
#endif

#ifdef ALLOW_PROFILES
      useCAL = .TRUE.
#endif

C--   packages with an implied switch
      useGAD = tempStepping .OR. saltStepping .OR. usePTRACERS

      _END_MASTER(myThid)

C--   Everyone else must wait for the parameters to be loaded
      _BARRIER

      RETURN
      END
1	dimitri	1.43	C $Header: /u/gcmpack/MITgcm/model/src/packages_boot.F,v 1.42 2007/11/24 15:44:52 dimitri Exp $
2	adcroft	1.6	C $Name: $
3	heimbach	1.1
4	jmc	1.33	#include "PACKAGES_CONFIG.h"
5	heimbach	1.1	#include "CPP_OPTIONS.h"
6
7	cnh	1.7	CBOP
8			C !ROUTINE: PACKAGES_BOOT
9			C !INTERFACE:
10	heimbach	1.1	SUBROUTINE PACKAGES_BOOT( myThid )
11	cnh	1.7
12			C !DESCRIPTION: \bv
13			C ==========================================================
14			C \| SUBROUTINE PACKAGES_BOOT
15			C \| o Routine to parse runtime package selection file
16			C ==========================================================
17			C \| Routine reads a flat file which contains a single flag
18			C \| for each known "package". Flag can enables runtime
19			C \| activation or deactivation of a package. The data is read
20			C \| from a file called data.pkg.
21			C \| Note - If a runtime activation flag is set on but the
22			C \| package code was not included in the build then
23			C \| the default behavior is to stop with an error.
24			C ==========================================================
25			C \ev
26
27			C !USES:
28	heimbach	1.1	IMPLICIT NONE
29			C === Global variables ===
30			#include "SIZE.h"
31			#include "EEPARAMS.h"
32			#include "PARAMS.h"
33
34	cnh	1.7	C !INPUT/OUTPUT PARAMETERS:
35	heimbach	1.1	C === Routine arguments ===
36			C myThid - Number of this instances
37			INTEGER myThid
38
39	cnh	1.7	C !LOCAL VARIABLES:
40			C === Local variables ===
41			C msgBuf - Informational/error meesage buffer
42			C iUnit - Work variable for IO unit number
43			CHARACTER*(MAX_LEN_MBUF) msgBuf
44			INTEGER iUnit
45
46	cheisey	1.11	C data.pkg namelists
47	heimbach	1.1	NAMELIST /PACKAGES/
48	mlosch	1.24	& useOPPS,
49	mlosch	1.23	& usePP81,
50			& useMY82,
51	mlosch	1.24	& useGGL90,
52	heimbach	1.1	& useKPP,
53			& useGMRedi,
54	adcroft	1.2	& useOBCS,
55	jmc	1.3	& useAIM,
56	jmc	1.15	& useLand,
57	heimbach	1.5	& useGrdchk,
58	heimbach	1.39	& useEXF,
59	adcroft	1.4	& useECCO,
60	adcroft	1.6	& useSHAP_FILT,
61	jmc	1.8	& useZONAL_FILT,
62	adcroft	1.9	& useFLT,
63	heimbach	1.10	& usePTRACERS,
64	mlosch	1.26	& useGCHEM,
65	stephd	1.29	& useRBCS,
66	jmc	1.32	& useOffLine,
67	dimitri	1.14	& useSBO,
68	cheisey	1.11	& useSEAICE,
69	mlosch	1.31	& useShelfIce,
70	jmc	1.33	& useThSIce,
71	jscott	1.36	& useATM2D,
72	jmc	1.16	& useBulkForce,
73	jmc	1.33	& useEBM,
74	molod	1.18	& usefizhi,
75	molod	1.19	& usegridalt,
76	jmc	1.32	& useDiagnostics,
77	spk	1.27	& useMNC,
78	edhill	1.35	& useREGRID,
79	adcroft	1.28	& useRunClock,
80	edhill	1.30	& useMATRIX,
81	heimbach	1.34	& useEMBED_FILES,
82	dimitri	1.42	& useMYPACKAGE,
83	dimitri	1.43	& useSaltPlume
84	cnh	1.7	CEOP
85	heimbach	1.1
86			_BEGIN_MASTER(myThid)
87
88	cnh	1.7	WRITE(msgBuf,'(A)') ' PACKAGES_BOOT: opening data.pkg'
89	heimbach	1.1	CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
90	jmc	1.37	& SQUEEZE_RIGHT , myThid )
91	jmc	1.38
92	heimbach	1.1
93			CALL OPEN_COPY_DATA_FILE(
94			I 'data.pkg', 'PACKAGES_BOOT',
95			O iUnit,
96			I myThid )
97
98			C-- Default package configuration
99	jmc	1.33	useOPPS =.FALSE.
100			usePP81 =.FALSE.
101			useMY82 =.FALSE.
102			useGGL90 =.FALSE.
103			useKPP =.FALSE.
104			useGMRedi =.FALSE.
105			useOBCS =.FALSE.
106			useAIM =.FALSE.
107			useLand =.FALSE.
108			useCAL =.FALSE.
109			useEXF =.FALSE.
110			useEBM =.FALSE.
111			useGrdchk =.FALSE.
112			useECCO =.FALSE.
113			useSHAP_FILT =.FALSE.
114			useZONAL_FILT =.FALSE.
115			useFLT =.FALSE.
116			usePTRACERS =.FALSE.
117			useGCHEM =.FALSE.
118			useRBCS =.FALSE.
119			useOffLine =.FALSE.
120			useMATRIX =.FALSE.
121			useSBO =.FALSE.
122			useSEAICE =.FALSE.
123			useShelfIce =.FALSE.
124			useThSIce =.FALSE.
125	jscott	1.36	useATM2D =.FALSE.
126	jmc	1.33	useBulkForce =.FALSE.
127			usefizhi =.FALSE.
128			usegridalt =.FALSE.
129			useDiagnostics =.FALSE.
130			useMNC =.FALSE.
131			useRunClock =.FALSE.
132	edhill	1.35	useREGRID =.FALSE.
133	heimbach	1.34	useMYPACKAGE =.FALSE.
134	dimitri	1.43	useSaltPlume =.FALSE.
135	heimbach	1.1
136			C-- Read parameters from open data file
137			READ(UNIT=iUnit,NML=PACKAGES)
138
139
140	cnh	1.7	WRITE(msgBuf,'(A)') ' PACKAGES_BOOT: finished reading data.pkg'
141	heimbach	1.1	CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
142	jmc	1.37	& SQUEEZE_RIGHT , myThid )
143	heimbach	1.1
144			C-- Close the open data file
145			CLOSE(iUnit)
146	jmc	1.38
147	jmc	1.33	C-- packages with hard-coded switch
148			#ifdef ALLOW_CAL
149	heimbach	1.40	IF (useEXF) useCAL = .TRUE.
150	jmc	1.33	#endif
151
152	gforget	1.41	#ifdef ALLOW_PROFILES
153			useCAL = .TRUE.
154			#endif
155
156	jmc	1.38	C-- packages with an implied switch
157			useGAD = tempStepping .OR. saltStepping .OR. usePTRACERS
158
159	jmc	1.37	_END_MASTER(myThid)
160
161	heimbach	1.1	C-- Everyone else must wait for the parameters to be loaded
162			_BARRIER
163
164	jmc	1.15	RETURN
165			END