pkg/offline/offline_readparms.F

C $Header: /u/gcmpack/MITgcm/pkg/offline/offline_readparms.F,v 1.7 2010/03/30 14:56:30 dfer 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"
c#include "GRID.h"
#ifdef ALLOW_OFFLINE
#include "OFFLINE.h"
#endif

C     === Routine arguments ===
      INTEGER myThid

#ifdef ALLOW_OFFLINE
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     === 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

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