model/src/packages_boot.F

C $Header: /u/gcmpack/MITgcm/model/src/packages_boot.F,v 1.20 2004/03/19 05:09:41 edhill 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/
     &          useKPP,
     &          useGMRedi,
     &          useOBCS,
     &          useAIM,
     &          useLand,
     &          useGrdchk,
     &          useECCO,
     &          useSHAP_FILT,
     &          useZONAL_FILT,
     &          useFLT,
     &          usePTRACERS,
     &          useSBO,
     &          useSEAICE,
     &          useBulkForce,
     &          useThSIce,
     &          usefizhi,
     &          usegridalt,
     &          usediagnostics


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
      useKPP=.FALSE.
      useGMRedi=.FALSE.
      useOBCS=.FALSE.
      useAIM=.FALSE.
      useLand=.FALSE.
      useGrdchk=.FALSE.
      useECCO=.FALSE.
      useSHAP_FILT=.FALSE.
      useZONAL_FILT=.FALSE.
      useFLT=.FALSE.
      usePTRACERS=.FALSE.
      useSBO=.FALSE.
      useSeaIce=.FALSE.
      useBulkForce=.FALSE.
      useThSIce=.FALSE.
      usefizhi=.FALSE.
      usegridalt=.FALSE.
      usediagnostics=.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	edhill	1.21	C $Header: /u/gcmpack/MITgcm/model/src/packages_boot.F,v 1.20 2004/03/19 05:09:41 edhill 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
47	heimbach	1.1	NAMELIST /PACKAGES/
48			& useKPP,
49			& useGMRedi,
50	adcroft	1.2	& useOBCS,
51	jmc	1.3	& useAIM,
52	jmc	1.15	& useLand,
53	heimbach	1.5	& useGrdchk,
54	adcroft	1.4	& useECCO,
55	adcroft	1.6	& useSHAP_FILT,
56	jmc	1.8	& useZONAL_FILT,
57	adcroft	1.9	& useFLT,
58	heimbach	1.10	& usePTRACERS,
59	dimitri	1.14	& useSBO,
60	cheisey	1.11	& useSEAICE,
61	jmc	1.16	& useBulkForce,
62	molod	1.18	& useThSIce,
63			& usefizhi,
64	molod	1.19	& usegridalt,
65	edhill	1.21	& usediagnostics
66	cheisey	1.11
67
68	cnh	1.7	CEOP
69	heimbach	1.1
70			_BEGIN_MASTER(myThid)
71
72	cnh	1.7	WRITE(msgBuf,'(A)') ' PACKAGES_BOOT: opening data.pkg'
73	heimbach	1.1	CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
74			& SQUEEZE_RIGHT , 1)
75
76
77			CALL OPEN_COPY_DATA_FILE(
78			I 'data.pkg', 'PACKAGES_BOOT',
79			O iUnit,
80			I myThid )
81
82			C-- Default package configuration
83	jmc	1.8	useKPP=.FALSE.
84	heimbach	1.1	useGMRedi=.FALSE.
85	adcroft	1.2	useOBCS=.FALSE.
86	jmc	1.3	useAIM=.FALSE.
87	jmc	1.15	useLand=.FALSE.
88	jmc	1.8	useGrdchk=.FALSE.
89	heimbach	1.1	useECCO=.FALSE.
90	adcroft	1.4	useSHAP_FILT=.FALSE.
91	jmc	1.8	useZONAL_FILT=.FALSE.
92			useFLT=.FALSE.
93	heimbach	1.10	usePTRACERS=.FALSE.
94	dimitri	1.14	useSBO=.FALSE.
95	cheisey	1.11	useSeaIce=.FALSE.
96	jmc	1.16	useBulkForce=.FALSE.
97			useThSIce=.FALSE.
98	molod	1.18	usefizhi=.FALSE.
99			usegridalt=.FALSE.
100	molod	1.19	usediagnostics=.FALSE.
101	heimbach	1.1
102			C-- Read parameters from open data file
103			READ(UNIT=iUnit,NML=PACKAGES)
104
105
106	cnh	1.7	WRITE(msgBuf,'(A)') ' PACKAGES_BOOT: finished reading data.pkg'
107	heimbach	1.1	CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
108			& SQUEEZE_RIGHT , 1)
109
110			C-- Close the open data file
111			CLOSE(iUnit)
112			_END_MASTER(myThid)
113
114			C-- Everyone else must wait for the parameters to be loaded
115			_BARRIER
116
117	jmc	1.15	RETURN
118			END