pkg/offline/offline_readparms.F

C $Header: /u/gcmpack/MITgcm/pkg/offline/offline_readparms.F,v 1.8 2010/04/03 22:34:26 jmc Exp $
C $Name:  $

#include "OFFLINE_OPTIONS.h"

      SUBROUTINE OFFLINE_READPARMS( myThid )
C     *==========================================================*
C     | SUBROUTINE OFFLINE_READPARMS
C     | o Routine to initialize OFFLINE variables and constants.
C     *==========================================================*
C     | Initialize OFFLINE    parameters, read in data.off
C     *==========================================================*
      IMPLICIT NONE

C     === Global variables ===
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#ifdef ALLOW_OFFLINE
#include "OFFLINE.h"
#endif

C     === Routine arguments ===
      INTEGER myThid

#ifdef ALLOW_OFFLINE
C     === Local variables ===
C     msgBuf     :: Informational/error message buffer
C     iUnit      :: Work variable for IO unit number
      CHARACTER*(MAX_LEN_MBUF) msgBuf
      INTEGER iUnit
C     Retired main data.offline file parameters
      CHARACTER*(MAX_LEN_FNAM) KPP_ghatFile

C--   Bulk Formula parameter
      NAMELIST /OFFLINE_PARM01/
     &         UvelFile, VvelFile, WvelFile, ThetFile,
     &         SaltFile, ConvFile, GMwxFile, GMwyFile,
     &         GMwzFile, HfluxFile, SfluxFile,
     &         KPP_DiffSFile, KPP_ghatKFile, ICEFile,
     &         KPP_ghatFile

      NAMELIST /OFFLINE_PARM02/
     &         offlineIter0, offlineOffsetIter,
     &         deltaToffline, offlineForcingPeriod,
     &         offlineForcingCycle, offlineLoadPrec

C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|

      _BEGIN_MASTER(myThid)

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


      CALL OPEN_COPY_DATA_FILE(
     I                          'data.off', 'OFFLINE_READPARMS',
     O                          iUnit,
     I                          myThid )

C--   Default values for params in OFFLINE_PARM01 :
      UvelFile=' '
      VvelFile=' '
      WvelFile=' '
      ThetFile=' '
      SaltFile='  '
      ConvFile=' '
      GMwxFile=' '
      GMwyFile=' '
      GMwzFile=' '
      HFluxFile=' '
      SFluxFile=' '
      KPP_DiffSFile=' '
      KPP_ghatKFile=' '
      KPP_ghatFile='KPP_ghatFile has been replaced by KPP_ghatKFile'
      ICEFile=' '

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

      IF ( KPP_ghatFile .NE.
     &    'KPP_ghatFile has been replaced by KPP_ghatKFile' ) THEN
c       nRetired = nRetired+1
        WRITE(msgBuf,'(A,A)') 'S/R OFFLINE_READPARMS: "KPP_ghatFile"',
     &                     ' is no longer allowed in file "data.off"'
        CALL PRINT_ERROR( msgBuf, myThid )
        WRITE(msgBuf,'(A,A)') 'S/R OFFLINE_READPARMS: read instead ',
     &           'the product ghat*diffKz from file "KPP_ghatKFile"'
        CALL PRINT_ERROR( msgBuf, myThid )
        STOP 'ABNORMAL END: S/R OFFLINE_READPARMS'
      ENDIF

C--   Default values for params in OFFLINE_PARM02 :
      deltaToffline=deltaTclock
      offlineIter0=nIter0        !initial offline field timestep
      offlineOffsetIter=0        !offset
      offlineForcingPeriod=2592000.
      offlineForcingCycle=31104000.
      offlineLoadPrec=readBinaryPrec

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

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

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

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

#endif /* ALLOW_OFFLINE */

      RETURN
      END
1	C $Header: /u/gcmpack/MITgcm/pkg/offline/offline_readparms.F,v 1.8 2010/04/03 22:34:26 jmc Exp $
2	C $Name: $
3
4	#include "OFFLINE_OPTIONS.h"
5
6	SUBROUTINE OFFLINE_READPARMS( myThid )
7	C ==========================================================
8	C \| SUBROUTINE OFFLINE_READPARMS
9	C \| o Routine to initialize OFFLINE variables and constants.
10	C ==========================================================
11	C \| Initialize OFFLINE parameters, read in data.off
12	C ==========================================================
13	IMPLICIT NONE
14
15	C === Global variables ===
16	#include "SIZE.h"
17	#include "EEPARAMS.h"
18	#include "PARAMS.h"
19	#ifdef ALLOW_OFFLINE
20	#include "OFFLINE.h"
21	#endif
22
23	C === Routine arguments ===
24	INTEGER myThid
25
26	#ifdef ALLOW_OFFLINE
27	C === Local variables ===
28	C msgBuf :: Informational/error message buffer
29	C iUnit :: Work variable for IO unit number
30	CHARACTER*(MAX_LEN_MBUF) msgBuf
31	INTEGER iUnit
32	C Retired main data.offline file parameters
33	CHARACTER*(MAX_LEN_FNAM) KPP_ghatFile
34
35	C-- Bulk Formula parameter
36	NAMELIST /OFFLINE_PARM01/
37	& UvelFile, VvelFile, WvelFile, ThetFile,
38	& SaltFile, ConvFile, GMwxFile, GMwyFile,
39	& GMwzFile, HfluxFile, SfluxFile,
40	& KPP_DiffSFile, KPP_ghatKFile, ICEFile,
41	& KPP_ghatFile
42
43	NAMELIST /OFFLINE_PARM02/
44	& offlineIter0, offlineOffsetIter,
45	& deltaToffline, offlineForcingPeriod,
46	& offlineForcingCycle, offlineLoadPrec
47
48	C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|
49
50	_BEGIN_MASTER(myThid)
51
52	WRITE(msgBuf,'(A)') ' OFFLINE_READPARMS: opening data.off'
53	CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
54	& SQUEEZE_RIGHT, myThid )
55
56
57	CALL OPEN_COPY_DATA_FILE(
58	I 'data.off', 'OFFLINE_READPARMS',
59	O iUnit,
60	I myThid )
61
62	C-- Default values for params in OFFLINE_PARM01 :
63	UvelFile=' '
64	VvelFile=' '
65	WvelFile=' '
66	ThetFile=' '
67	SaltFile=' '
68	ConvFile=' '
69	GMwxFile=' '
70	GMwyFile=' '
71	GMwzFile=' '
72	HFluxFile=' '
73	SFluxFile=' '
74	KPP_DiffSFile=' '
75	KPP_ghatKFile=' '
76	KPP_ghatFile='KPP_ghatFile has been replaced by KPP_ghatKFile'
77	ICEFile=' '
78
79	C-- Read parameters from open data file
80	READ(UNIT=iUnit,NML=OFFLINE_PARM01)
81
82	IF ( KPP_ghatFile .NE.
83	& 'KPP_ghatFile has been replaced by KPP_ghatKFile' ) THEN
84	c nRetired = nRetired+1
85	WRITE(msgBuf,'(A,A)') 'S/R OFFLINE_READPARMS: "KPP_ghatFile"',
86	& ' is no longer allowed in file "data.off"'
87	CALL PRINT_ERROR( msgBuf, myThid )
88	WRITE(msgBuf,'(A,A)') 'S/R OFFLINE_READPARMS: read instead ',
89	& 'the product ghat*diffKz from file "KPP_ghatKFile"'
90	CALL PRINT_ERROR( msgBuf, myThid )
91	STOP 'ABNORMAL END: S/R OFFLINE_READPARMS'
92	ENDIF
93
94	C-- Default values for params in OFFLINE_PARM02 :
95	deltaToffline=deltaTclock
96	offlineIter0=nIter0 !initial offline field timestep
97	offlineOffsetIter=0 !offset
98	offlineForcingPeriod=2592000.
99	offlineForcingCycle=31104000.
100	offlineLoadPrec=readBinaryPrec
101
102	C-- Read parameters from open data file
103	READ(UNIT=iUnit,NML=OFFLINE_PARM02)
104
105	WRITE(msgBuf,'(A)')
106	& ' OFFLINE_READPARMS: finished reading data.off'
107	CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
108	& SQUEEZE_RIGHT, myThid )
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	#endif /* ALLOW_OFFLINE */
118
119	RETURN
120	END