pkg/ptracers/ptracers_readparms.F

C $Header: /u/gcmpack/MITgcm/pkg/ptracers/ptracers_readparms.F,v 1.8 2004/10/10 06:08:50 edhill Exp $
C $Name:  $

#include "PTRACERS_OPTIONS.h"

C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C     !ROUTINE: PTRACERS_READPARMS
      
C     !INTERFACE:
      SUBROUTINE PTRACERS_READPARMS( myThid )
      
C     !DESCRIPTION:
C     Initialize PTRACERS parameters, read in data.ptracers

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

C     !INPUT PARAMETERS:
      INTEGER myThid
CEOP

#ifdef ALLOW_PTRACERS

C     !LOCAL VARIABLES:
C     iTracer    :: loop indices
C     iUnit      :: unit number for I/O
C     msgBuf     :: message buffer
      INTEGER iTracer
      INTEGER iUnit
      INTEGER ic
      CHARACTER*(MAX_LEN_MBUF) msgBuf

C     PTRACERS_taveFreq :: Frequency with which time-averaged PTRACERS
C                          are written to post-processing files.
      NAMELIST /PTRACERS_PARM01/
     &     PTRACERS_taveFreq,
     &     PTRACERS_advScheme,
     &     PTRACERS_diffKh,
     &     PTRACERS_diffK4,
     &     PTRACERS_diffKr,
     &     PTRACERS_useGMRedi,
     &     PTRACERS_useKPP,
     &     PTRACERS_numInUse,
     &     PTRACERS_initialFile,
     &     PTRACERS_useRecords,
     &     PTRACERS_names,
     &     PTRACERS_long_names,
     &     PTRACERS_units,
     &     PTRACERS_write_ioinc,
     &     PTRACERS_read_mnc,
     &     PTRACERS_write_mnc

C     This routine has been called by the main model so we set our
C     internal flag to indicate we are in business
      PTRACERSisON=.TRUE.

C     Set defaults values for parameters in PTRACERS.h
      PTRACERS_taveFreq=taveFreq
      PTRACERS_numInUse=-1
      DO iTracer=1,PTRACERS_num
        PTRACERS_advScheme(iTracer)=saltAdvScheme
        PTRACERS_diffKh(iTracer)=diffKhS
        PTRACERS_diffK4(iTracer)=diffK4S
        PTRACERS_diffKr(iTracer)=diffKrNrS(1)
        PTRACERS_useGMRedi(iTracer)=useGMRedi
        PTRACERS_useKPP(iTracer)=useKPP
        PTRACERS_initialFile(iTracer)=' '
        DO ic = 1,MAX_LEN_FNAM
          PTRACERS_names(iTracer)(ic:ic) = ' '
          PTRACERS_long_names(iTracer)(ic:ic) = ' '
          PTRACERS_units(iTracer)(ic:ic) = ' '
        ENDDO
      ENDDO
      PTRACERS_useRecords  = .FALSE.
      PTRACERS_read_mdsio  = .TRUE.
      PTRACERS_read_mnc    = .FALSE.
      PTRACERS_write_mdsio = .TRUE.
      PTRACERS_write_mnc   = .FALSE.
      PTRACERS_write_ioinc = .FALSE.

C     Open and read the data.ptracers file
      _BEGIN_MASTER(myThid)
      WRITE(msgBuf,'(A)') ' PTRACERS_READPARMS: opening data.ptracers'
      CALL PRINT_MESSAGE(msgBuf, standardMessageUnit,
     &                   SQUEEZE_RIGHT , 1)
      CALL OPEN_COPY_DATA_FILE(
     I                   'data.ptracers', 'PTRACERS_READPARMS',
     O                   iUnit,
     I                   myThid )
      READ(UNIT=iUnit,NML=PTRACERS_PARM01)
      WRITE(msgBuf,'(A)')
     &  ' PTRACERS_READPARMS: finished reading data.ptracers'
      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

C     Now set-up any remaining parameters that result from the input
C     parameters

C     If PTRACERS_numInUse was not set in data.ptracers then we can
C     assume that all PTRACERS fields will be in use
      IF (PTRACERS_numInUse.LT.0) THEN
        PTRACERS_numInUse=PTRACERS_num
      ENDIF
C     Check we are not trying to use more tracers than allowed
      IF (PTRACERS_numInUse.GT.PTRACERS_num) THEN
        WRITE(msgBuf,'(A,I2,A,I2,A)')
     &       ' PTRACERS_READPARMS: You requested ',PTRACERS_numInUse,
     &       ' tracers at run time when only ',PTRACERS_num,
     &       ' were specified at compile time. Naughty! '
        CALL PRINT_ERROR(msgBuf, 1)
        STOP 'ABNORMAL END: S/R PTRACERS_READPARMS'
      ENDIF
C     Check that enough parameters were specified
      DO iTracer=1,PTRACERS_numInUse
        IF (PTRACERS_advScheme(iTracer).EQ.0) THEN
          WRITE(msgBuf,'(A,A,I2)')
     &         ' PTRACERS_READPARMS: ',
     &         'No advect. scheme specified for tracer #',
     &         iTracer
          CALL PRINT_ERROR(msgBuf, 1)
          STOP 'ABNORMAL END: S/R PTRACERS_READPARMS'
        ENDIF
      ENDDO

#ifdef ALLOW_MNC
      IF (useMNC) THEN
C       Set the default I/O Types
        IF (PTRACERS_read_mnc) PTRACERS_read_mdsio = .FALSE.
        IF ( (.NOT. PTRACERS_write_ioinc) 
     &       .AND. PTRACERS_write_mnc ) pickup_write_mdsio = .FALSE.
        
C       Initialize the MNC variable types for PTRACERS 
        CALL PTRACERS_MNC_INIT( myThid )
      ENDIF
#endif /*  ALLOW_MNC  */
      
#endif /* ALLOW_PTRACERS */

      RETURN
      END

1	jmc	1.9	C $Header: /u/gcmpack/MITgcm/pkg/ptracers/ptracers_readparms.F,v 1.8 2004/10/10 06:08:50 edhill Exp $
2	dimitri	1.2	C $Name: $
3	adcroft	1.1
4			#include "PTRACERS_OPTIONS.h"
5
6	edhill	1.6	C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|
7	adcroft	1.1	CBOP
8	edhill	1.6	C !ROUTINE: PTRACERS_READPARMS
9
10			C !INTERFACE:
11	adcroft	1.1	SUBROUTINE PTRACERS_READPARMS( myThid )
12	edhill	1.6
13			C !DESCRIPTION:
14	adcroft	1.1	C Initialize PTRACERS parameters, read in data.ptracers
15
16	edhill	1.6	C !USES:
17	adcroft	1.1	IMPLICIT NONE
18			#include "SIZE.h"
19			#include "EEPARAMS.h"
20	jmc	1.5	#include "PTRACERS_SIZE.h"
21	adcroft	1.1	#include "PTRACERS.h"
22	dimitri	1.2	#include "PARAMS.h"
23	edhill	1.7
24	edhill	1.6	C !INPUT PARAMETERS:
25	adcroft	1.1	INTEGER myThid
26	edhill	1.6	CEOP
27	adcroft	1.1
28			#ifdef ALLOW_PTRACERS
29
30	edhill	1.6	C !LOCAL VARIABLES:
31			C iTracer :: loop indices
32			C iUnit :: unit number for I/O
33			C msgBuf :: message buffer
34	adcroft	1.1	INTEGER iTracer
35			INTEGER iUnit
36	edhill	1.6	INTEGER ic
37	adcroft	1.1	CHARACTER*(MAX_LEN_MBUF) msgBuf
38
39	jmc	1.5	C PTRACERS_taveFreq :: Frequency with which time-averaged PTRACERS
40			C are written to post-processing files.
41			NAMELIST /PTRACERS_PARM01/
42	edhill	1.6	& PTRACERS_taveFreq,
43			& PTRACERS_advScheme,
44			& PTRACERS_diffKh,
45			& PTRACERS_diffK4,
46			& PTRACERS_diffKr,
47			& PTRACERS_useGMRedi,
48			& PTRACERS_useKPP,
49			& PTRACERS_numInUse,
50			& PTRACERS_initialFile,
51			& PTRACERS_useRecords,
52			& PTRACERS_names,
53			& PTRACERS_long_names,
54			& PTRACERS_units,
55	edhill	1.7	& PTRACERS_write_ioinc,
56			& PTRACERS_read_mnc,
57			& PTRACERS_write_mnc
58	jmc	1.5
59	edhill	1.6	C This routine has been called by the main model so we set our
60			C internal flag to indicate we are in business
61	adcroft	1.1	PTRACERSisON=.TRUE.
62
63	edhill	1.6	C Set defaults values for parameters in PTRACERS.h
64	dimitri	1.4	PTRACERS_taveFreq=taveFreq
65	adcroft	1.1	PTRACERS_numInUse=-1
66			DO iTracer=1,PTRACERS_num
67	edhill	1.6	PTRACERS_advScheme(iTracer)=saltAdvScheme
68			PTRACERS_diffKh(iTracer)=diffKhS
69			PTRACERS_diffK4(iTracer)=diffK4S
70	jmc	1.9	PTRACERS_diffKr(iTracer)=diffKrNrS(1)
71	edhill	1.6	PTRACERS_useGMRedi(iTracer)=useGMRedi
72			PTRACERS_useKPP(iTracer)=useKPP
73			PTRACERS_initialFile(iTracer)=' '
74			DO ic = 1,MAX_LEN_FNAM
75			PTRACERS_names(iTracer)(ic:ic) = ' '
76			PTRACERS_long_names(iTracer)(ic:ic) = ' '
77			PTRACERS_units(iTracer)(ic:ic) = ' '
78			ENDDO
79	adcroft	1.1	ENDDO
80	edhill	1.7	PTRACERS_useRecords = .FALSE.
81			PTRACERS_read_mdsio = .TRUE.
82			PTRACERS_read_mnc = .FALSE.
83			PTRACERS_write_mdsio = .TRUE.
84			PTRACERS_write_mnc = .FALSE.
85			PTRACERS_write_ioinc = .FALSE.
86	adcroft	1.1
87	edhill	1.6	C Open and read the data.ptracers file
88	adcroft	1.1	_BEGIN_MASTER(myThid)
89			WRITE(msgBuf,'(A)') ' PTRACERS_READPARMS: opening data.ptracers'
90			CALL PRINT_MESSAGE(msgBuf, standardMessageUnit,
91			& SQUEEZE_RIGHT , 1)
92			CALL OPEN_COPY_DATA_FILE(
93			I 'data.ptracers', 'PTRACERS_READPARMS',
94			O iUnit,
95			I myThid )
96			READ(UNIT=iUnit,NML=PTRACERS_PARM01)
97			WRITE(msgBuf,'(A)')
98			& ' PTRACERS_READPARMS: finished reading data.ptracers'
99			CALL PRINT_MESSAGE(msgBuf, standardMessageUnit,
100			& SQUEEZE_RIGHT , 1)
101
102	edhill	1.6	C Close the open data file
103	adcroft	1.1	CLOSE(iUnit)
104			_END_MASTER(myThid)
105
106	edhill	1.6	C Everyone else must wait for the parameters to be loaded
107	adcroft	1.1	_BARRIER
108
109	edhill	1.6	C Now set-up any remaining parameters that result from the input
110			C parameters
111	adcroft	1.1
112	edhill	1.6	C If PTRACERS_numInUse was not set in data.ptracers then we can
113			C assume that all PTRACERS fields will be in use
114	adcroft	1.1	IF (PTRACERS_numInUse.LT.0) THEN
115	edhill	1.6	PTRACERS_numInUse=PTRACERS_num
116	adcroft	1.1	ENDIF
117	edhill	1.6	C Check we are not trying to use more tracers than allowed
118	adcroft	1.1	IF (PTRACERS_numInUse.GT.PTRACERS_num) THEN
119	edhill	1.6	WRITE(msgBuf,'(A,I2,A,I2,A)')
120			& ' PTRACERS_READPARMS: You requested ',PTRACERS_numInUse,
121			& ' tracers at run time when only ',PTRACERS_num,
122			& ' were specified at compile time. Naughty! '
123			CALL PRINT_ERROR(msgBuf, 1)
124			STOP 'ABNORMAL END: S/R PTRACERS_READPARMS'
125	adcroft	1.1	ENDIF
126	edhill	1.6	C Check that enough parameters were specified
127	adcroft	1.1	DO iTracer=1,PTRACERS_numInUse
128	edhill	1.6	IF (PTRACERS_advScheme(iTracer).EQ.0) THEN
129			WRITE(msgBuf,'(A,A,I2)')
130			& ' PTRACERS_READPARMS: ',
131			& 'No advect. scheme specified for tracer #',
132			& iTracer
133			CALL PRINT_ERROR(msgBuf, 1)
134			STOP 'ABNORMAL END: S/R PTRACERS_READPARMS'
135			ENDIF
136	adcroft	1.1	ENDDO
137
138	edhill	1.6	#ifdef ALLOW_MNC
139			IF (useMNC) THEN
140	edhill	1.7	C Set the default I/O Types
141			IF (PTRACERS_read_mnc) PTRACERS_read_mdsio = .FALSE.
142			IF ( (.NOT. PTRACERS_write_ioinc)
143			& .AND. PTRACERS_write_mnc ) pickup_write_mdsio = .FALSE.
144
145			C Initialize the MNC variable types for PTRACERS
146	edhill	1.6	CALL PTRACERS_MNC_INIT( myThid )
147			ENDIF
148			#endif /* ALLOW_MNC */
149
150	adcroft	1.1	#endif /* ALLOW_PTRACERS */
151
152			RETURN
153			END
154	edhill	1.6