model/src/packages_boot.F

C $Header: /u/gcmpack/MITgcm/model/src/packages_boot.F,v 1.28 2005/05/31 18:24:29 adcroft Exp $
C $Name:  $

#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,
     &          useECCO,
     &          useSHAP_FILT,
     &          useZONAL_FILT,
     &          useFLT,
     &          usePTRACERS,
     &          useGCHEM,
     &          useRBCS,
     &          useSBO,
     &          useSEAICE,
     &          useBulkForce,
     &          useThSIce,
     &          usefizhi,
     &          usegridalt,
     &          usediagnostics,
     &          useEBM,
     &          useMNC,
     &          useRunClock,
     &          useMATRIX
CEOP

      _BEGIN_MASTER(myThid)

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

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

C--   Default package configuration
      usePP81=.FALSE.
      useMY82=.FALSE.
      useGGL90=.FALSE.
      useKPP=.FALSE.
      useGMRedi=.FALSE.
      useOBCS=.FALSE.
      useAIM=.FALSE.
      useLand=.FALSE.
      useGrdchk=.FALSE.
      useECCO=.FALSE.
      useSHAP_FILT=.FALSE.
      useZONAL_FILT=.FALSE.
      useFLT=.FALSE.
      usePTRACERS=.FALSE.
      useGCHEM=.FALSE.
      useRBCS=.FALSE.
      useSBO=.FALSE.
      useSeaIce=.FALSE.
      useBulkForce=.FALSE.
      useThSIce=.FALSE.
      usefizhi=.FALSE.
      usegridalt=.FALSE.
      usediagnostics=.FALSE.
      useEBM=.FALSE.
      useMNC=.FALSE.
      useRunClock=.FALSE.
      useMATRIX=.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 , 1)

C--   Close the open data file
      CLOSE(iUnit)
      _END_MASTER(myThid)
 
C--   Everyone else must wait for the parameters to be loaded
      _BARRIER

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