pkg/mypackage/mypackage_readparms.F

C $Header: /u/gcmpack/MITgcm/pkg/mypackage/mypackage_readparms.F,v 1.5 2014/05/27 23:41:31 jmc Exp $
C $Name: BASE $

#include "MYPACKAGE_OPTIONS.h"

C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP 0
C !ROUTINE: MYPACKAGE_READPARMS

C !INTERFACE:
      SUBROUTINE MYPACKAGE_READPARMS( myThid )

C     !DESCRIPTION:
C     Initialize MYPACKAGE variables and constants.

C     !USES:
      IMPLICIT NONE
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "MYPACKAGE.h"

C     !INPUT PARAMETERS:
      INTEGER myThid
CEOP

#ifdef ALLOW_MYPACKAGE

C     !LOCAL VARIABLES:
C     msgBuf     :: Informational/error message buffer
C     iUnit      :: Work variable for IO unit number
      CHARACTER*(MAX_LEN_MBUF) msgBuf
      INTEGER iUnit

      NAMELIST /MYPACKAGE_PARM01/
     &       myPa_MNC,
     &       myPa_StaV_Cgrid, myPa_Tend_Cgrid,
     &       myPa_applyTendT, myPa_applyTendS,
     &       myPa_applyTendU, myPa_applyTendV,
     &       myPa_doSwitch1,  myPa_doSwitch2,
     &       myPa_index1,     myPa_index2,
     &       myPa_param1,     myPa_param2,
     &       myPa_string1,    myPa_string2,
     &       myPa_Scal1File,  myPa_Scal2File,
     &       myPa_VelUFile,   myPa_VelVFile,
     &       myPa_Surf1File,  myPa_Surf2File

      IF ( .NOT.useMYPACKAGE ) THEN
C-    pkg MYPACKAGE is not used
        _BEGIN_MASTER(myThid)
C-    Track pkg activation status:
C     print a (weak) warning if data.mypackage is found
         CALL PACKAGES_UNUSED_MSG( 'useMYPACKAGE', ' ', ' ' )
        _END_MASTER(myThid)
        RETURN
      ENDIF

      _BEGIN_MASTER(myThid)

C--   Default values for MYPACKAGE
      myPa_MNC         = useMNC
      myPa_StaV_Cgrid  = .TRUE.
      myPa_Tend_Cgrid  = .TRUE.
      myPa_applyTendT  = .FALSE.
      myPa_applyTendS  = .FALSE.
      myPa_applyTendU  = .FALSE.
      myPa_applyTendV  = .FALSE.
C-    additional parameters:
      myPa_doSwitch1   = .FALSE.
      myPa_doSwitch2   = .FALSE.
      myPa_index1      = 0
      myPa_index2      = 0
      myPa_param1      = 0. _d 0
      myPa_param2      = 0. _d 0
      myPa_string1     = ' '
      myPa_string2     = ' '
C-    file names for initial conditions:
      myPa_Scal1File   = ' '
      myPa_Scal2File   = ' '
      myPa_VelUFile    = ' '
      myPa_VelVFile    = ' '
      myPa_Surf1File   = ' '
      myPa_Surf2File   = ' '

      WRITE(msgBuf,'(A)') 'MYPACKAGE_READPARMS: opening data.mypackage'
      CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
     &                    SQUEEZE_RIGHT , 1)
      CALL OPEN_COPY_DATA_FILE(
     I                     'data.mypackage', 'MYPACKAGE_READPARMS',
     O                     iUnit,
     I                     myThid )

C     Read parameters from open data file
      READ(UNIT=iUnit,NML=MYPACKAGE_PARM01)
      WRITE(msgBuf,'(A)')
     &    'MYPACKAGE_READPARMS: finished reading data.mypackage'
      CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
     &    SQUEEZE_RIGHT , 1)
C     Close the open data file
#ifdef SINGLE_DISK_IO
      CLOSE(iUnit)
#else
      CLOSE(iUnit,STATUS='DELETE')
#endif /* SINGLE_DISK_IO */

C     Make sure that we locally honor the global MNC on/off flag
      myPa_MNC = myPa_MNC .AND. useMNC
#ifndef ALLOW_MNC
C     Fix to avoid running without getting any output:
      myPa_MNC = .FALSE.
#endif
      myPa_MDSIO = (.NOT. myPa_MNC) .OR. outputTypesInclusive

      _END_MASTER(myThid)

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

#endif /* ALLOW_MYPACKAGE */

      RETURN
      END
1	mlosch	1.6	C $Header: /u/gcmpack/MITgcm/pkg/mypackage/mypackage_readparms.F,v 1.5 2014/05/27 23:41:31 jmc Exp $
2			C $Name: BASE $
3	heimbach	1.1
4			#include "MYPACKAGE_OPTIONS.h"
5
6	edhill	1.2	C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|
7			CBOP 0
8			C !ROUTINE: MYPACKAGE_READPARMS
9
10			C !INTERFACE:
11	heimbach	1.1	SUBROUTINE MYPACKAGE_READPARMS( myThid )
12	edhill	1.2
13			C !DESCRIPTION:
14			C Initialize MYPACKAGE variables and constants.
15
16			C !USES:
17	heimbach	1.1	IMPLICIT NONE
18			#include "SIZE.h"
19			#include "EEPARAMS.h"
20			#include "PARAMS.h"
21			#include "MYPACKAGE.h"
22
23	edhill	1.2	C !INPUT PARAMETERS:
24	heimbach	1.1	INTEGER myThid
25	edhill	1.2	CEOP
26	heimbach	1.1
27			#ifdef ALLOW_MYPACKAGE
28
29	jmc	1.4	C !LOCAL VARIABLES:
30			C msgBuf :: Informational/error message buffer
31			C iUnit :: Work variable for IO unit number
32			CHARACTER*(MAX_LEN_MBUF) msgBuf
33			INTEGER iUnit
34
35	heimbach	1.1	NAMELIST /MYPACKAGE_PARM01/
36	jmc	1.3	& myPa_MNC,
37			& myPa_StaV_Cgrid, myPa_Tend_Cgrid,
38			& myPa_applyTendT, myPa_applyTendS,
39			& myPa_applyTendU, myPa_applyTendV,
40			& myPa_doSwitch1, myPa_doSwitch2,
41			& myPa_index1, myPa_index2,
42			& myPa_param1, myPa_param2,
43			& myPa_string1, myPa_string2,
44			& myPa_Scal1File, myPa_Scal2File,
45			& myPa_VelUFile, myPa_VelVFile,
46			& myPa_Surf1File, myPa_Surf2File
47	heimbach	1.1
48	jmc	1.5	IF ( .NOT.useMYPACKAGE ) THEN
49			C- pkg MYPACKAGE is not used
50			_BEGIN_MASTER(myThid)
51			C- Track pkg activation status:
52			C print a (weak) warning if data.mypackage is found
53			CALL PACKAGES_UNUSED_MSG( 'useMYPACKAGE', ' ', ' ' )
54			_END_MASTER(myThid)
55			RETURN
56			ENDIF
57
58	heimbach	1.1	_BEGIN_MASTER(myThid)
59
60			C-- Default values for MYPACKAGE
61	jmc	1.3	myPa_MNC = useMNC
62			myPa_StaV_Cgrid = .TRUE.
63			myPa_Tend_Cgrid = .TRUE.
64			myPa_applyTendT = .FALSE.
65			myPa_applyTendS = .FALSE.
66			myPa_applyTendU = .FALSE.
67			myPa_applyTendV = .FALSE.
68			C- additional parameters:
69			myPa_doSwitch1 = .FALSE.
70			myPa_doSwitch2 = .FALSE.
71			myPa_index1 = 0
72			myPa_index2 = 0
73			myPa_param1 = 0. _d 0
74			myPa_param2 = 0. _d 0
75			myPa_string1 = ' '
76			myPa_string2 = ' '
77			C- file names for initial conditions:
78			myPa_Scal1File = ' '
79			myPa_Scal2File = ' '
80			myPa_VelUFile = ' '
81			myPa_VelVFile = ' '
82			myPa_Surf1File = ' '
83			myPa_Surf2File = ' '
84
85	heimbach	1.1	WRITE(msgBuf,'(A)') 'MYPACKAGE_READPARMS: opening data.mypackage'
86			CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
87			& SQUEEZE_RIGHT , 1)
88			CALL OPEN_COPY_DATA_FILE(
89			I 'data.mypackage', 'MYPACKAGE_READPARMS',
90			O iUnit,
91			I myThid )
92
93			C Read parameters from open data file
94			READ(UNIT=iUnit,NML=MYPACKAGE_PARM01)
95	jmc	1.3	WRITE(msgBuf,'(A)')
96	heimbach	1.1	& 'MYPACKAGE_READPARMS: finished reading data.mypackage'
97			CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
98			& SQUEEZE_RIGHT , 1)
99			C Close the open data file
100	mlosch	1.6	#ifdef SINGLE_DISK_IO
101	heimbach	1.1	CLOSE(iUnit)
102	mlosch	1.6	#else
103			CLOSE(iUnit,STATUS='DELETE')
104			#endif /* SINGLE_DISK_IO */
105	heimbach	1.1
106			C Make sure that we locally honor the global MNC on/off flag
107	jmc	1.3	myPa_MNC = myPa_MNC .AND. useMNC
108	heimbach	1.1	#ifndef ALLOW_MNC
109			C Fix to avoid running without getting any output:
110	jmc	1.3	myPa_MNC = .FALSE.
111	heimbach	1.1	#endif
112	jmc	1.3	myPa_MDSIO = (.NOT. myPa_MNC) .OR. outputTypesInclusive
113	heimbach	1.1
114			_END_MASTER(myThid)
115
116			C-- Everyone else must wait for the parameters to be loaded
117			_BARRIER
118
119			#endif /* ALLOW_MYPACKAGE */
120
121			RETURN
122			END