/[MITgcm]/MITgcm/pkg/ptracers/ptracers_readparms.F
ViewVC logotype

Diff of /MITgcm/pkg/ptracers/ptracers_readparms.F

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.6 by edhill, Fri Sep 3 20:10:47 2004 UTC revision 1.26 by jmc, Tue Sep 18 21:20:06 2007 UTC
# Line 6  C $Name$ Line 6  C $Name$
6  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
7  CBOP  CBOP
8  C     !ROUTINE: PTRACERS_READPARMS  C     !ROUTINE: PTRACERS_READPARMS
9          
10  C     !INTERFACE:  C     !INTERFACE:
11        SUBROUTINE PTRACERS_READPARMS( myThid )        SUBROUTINE PTRACERS_READPARMS( myThid )
12          
13  C     !DESCRIPTION:  C     !DESCRIPTION:
14  C     Initialize PTRACERS parameters, read in data.ptracers  C     Initialize PTRACERS parameters, read in data.ptracers
15    
# Line 20  C     !USES: Line 20  C     !USES:
20  #include "PTRACERS_SIZE.h"  #include "PTRACERS_SIZE.h"
21  #include "PTRACERS.h"  #include "PTRACERS.h"
22  #include "PARAMS.h"  #include "PARAMS.h"
23          #ifdef ALLOW_MNC
24    #include "MNC_PARAMS.h"
25    #endif
26    
27  C     !INPUT PARAMETERS:  C     !INPUT PARAMETERS:
28        INTEGER myThid        INTEGER myThid
29  CEOP  CEOP
# Line 28  CEOP Line 31  CEOP
31  #ifdef ALLOW_PTRACERS  #ifdef ALLOW_PTRACERS
32    
33  C     !LOCAL VARIABLES:  C     !LOCAL VARIABLES:
34  C     iTracer    :: loop indices  C     k,iTracer  :: loop indices
35  C     iUnit      :: unit number for I/O  C     iUnit      :: unit number for I/O
36  C     msgBuf     :: message buffer  C     msgBuf     :: message buffer
37        INTEGER iTracer        INTEGER k, iTracer
38        INTEGER iUnit        INTEGER iUnit
39        INTEGER ic        INTEGER ic
40        CHARACTER*(MAX_LEN_MBUF) msgBuf        CHARACTER*(MAX_LEN_MBUF) msgBuf
41          _RL PTRACERS_diffKr(PTRACERS_num)
42    
43  C     PTRACERS_taveFreq :: Frequency with which time-averaged PTRACERS  C     PTRACERS_taveFreq :: Frequency with which time-averaged PTRACERS
44  C                          are written to post-processing files.  C                          are written to post-processing files.
45        NAMELIST /PTRACERS_PARM01/        NAMELIST /PTRACERS_PARM01/
46         &     PTRACERS_dumpFreq,
47       &     PTRACERS_taveFreq,       &     PTRACERS_taveFreq,
48         &     PTRACERS_monitorFreq,
49       &     PTRACERS_advScheme,       &     PTRACERS_advScheme,
50         &     PTRACERS_ImplVertAdv,
51       &     PTRACERS_diffKh,       &     PTRACERS_diffKh,
52       &     PTRACERS_diffK4,       &     PTRACERS_diffK4,
53       &     PTRACERS_diffKr,       &     PTRACERS_diffKr,
54         &     PTRACERS_diffKrNr,
55         &     PTRACERS_ref,
56         &     PTRACERS_EvPrRn,
57       &     PTRACERS_useGMRedi,       &     PTRACERS_useGMRedi,
58       &     PTRACERS_useKPP,       &     PTRACERS_useKPP,
59         &     PTRACERS_Iter0,
60       &     PTRACERS_numInUse,       &     PTRACERS_numInUse,
61       &     PTRACERS_initialFile,       &     PTRACERS_initialFile,
62       &     PTRACERS_useRecords,       &     PTRACERS_useRecords,
63       &     PTRACERS_names,       &     PTRACERS_names,
64       &     PTRACERS_long_names,       &     PTRACERS_long_names,
65       &     PTRACERS_units,       &     PTRACERS_units,
66       &     PTRACERS_mnc_read,       &     PTRACERS_timeave_mnc,
67       &     PTRACERS_mnc_write,       &     PTRACERS_snapshot_mnc,
68       &     PTRACERS_iotypes       &     PTRACERS_monitor_mnc,
69         &     PTRACERS_pickup_write_mnc,
70         &     PTRACERS_pickup_read_mnc
71    
72          _BEGIN_MASTER(myThid)
73    
74  C     This routine has been called by the main model so we set our  C     This routine has been called by the main model so we set our
75  C     internal flag to indicate we are in business  C     internal flag to indicate we are in business
76        PTRACERSisON=.TRUE.        PTRACERSisON=.TRUE.
77    
78  C     Set defaults values for parameters in PTRACERS.h  C     Set defaults values for parameters in PTRACERS.h
79        PTRACERS_taveFreq=taveFreq        PTRACERS_dumpFreq    = dumpFreq
80          PTRACERS_taveFreq    = taveFreq
81          PTRACERS_monitorFreq = monitorFreq
82          PTRACERS_Iter0   = 0
83        PTRACERS_numInUse=-1        PTRACERS_numInUse=-1
84        DO iTracer=1,PTRACERS_num        DO iTracer=1,PTRACERS_num
85          PTRACERS_advScheme(iTracer)=saltAdvScheme          PTRACERS_advScheme(iTracer)=saltAdvScheme
86            PTRACERS_ImplVertAdv(iTracer) = .FALSE.
87          PTRACERS_diffKh(iTracer)=diffKhS          PTRACERS_diffKh(iTracer)=diffKhS
88          PTRACERS_diffK4(iTracer)=diffK4S          PTRACERS_diffK4(iTracer)=diffK4S
89          PTRACERS_diffKr(iTracer)=diffKrS          PTRACERS_diffKr(iTracer)=UNSET_RL
90            DO k=1,Nr
91              PTRACERS_diffKrNr(k,iTracer)=diffKrNrS(k)
92              PTRACERS_ref     (k,iTracer)=0. _d 0
93            ENDDO
94            PTRACERS_EvPrRn(iTracer)=UNSET_RL
95          PTRACERS_useGMRedi(iTracer)=useGMRedi          PTRACERS_useGMRedi(iTracer)=useGMRedi
96          PTRACERS_useKPP(iTracer)=useKPP          PTRACERS_useKPP(iTracer)=useKPP
97          PTRACERS_initialFile(iTracer)=' '          PTRACERS_initialFile(iTracer)=' '
# Line 77  C     Set defaults values for parameters Line 101  C     Set defaults values for parameters
101            PTRACERS_units(iTracer)(ic:ic) = ' '            PTRACERS_units(iTracer)(ic:ic) = ' '
102          ENDDO          ENDDO
103        ENDDO        ENDDO
104        PTRACERS_useRecords=.FALSE.        PTRACERS_useRecords       = .FALSE.
105        PTRACERS_iotypes = -1  #ifdef ALLOW_MNC
106        PTRACERS_mnc_read = .true.        PTRACERS_timeave_mnc      = useMNC .AND. timeave_mnc
107        PTRACERS_mnc_write = .true.        PTRACERS_snapshot_mnc     = useMNC .AND. snapshot_mnc
108          PTRACERS_monitor_mnc      = useMNC .AND. monitor_mnc
109          PTRACERS_pickup_write_mnc = useMNC .AND. pickup_write_mnc
110          PTRACERS_pickup_read_mnc  = useMNC .AND. pickup_read_mnc
111    #else
112          PTRACERS_timeave_mnc      = .FALSE.
113          PTRACERS_snapshot_mnc     = .FALSE.
114          PTRACERS_monitor_mnc      = .FALSE.
115          PTRACERS_pickup_write_mnc = .FALSE.
116          PTRACERS_pickup_read_mnc  = .FALSE.
117    #endif
118    
119  C     Open and read the data.ptracers file  C     Open and read the data.ptracers file
       _BEGIN_MASTER(myThid)  
120        WRITE(msgBuf,'(A)') ' PTRACERS_READPARMS: opening data.ptracers'        WRITE(msgBuf,'(A)') ' PTRACERS_READPARMS: opening data.ptracers'
121        CALL PRINT_MESSAGE(msgBuf, standardMessageUnit,        CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
122       &                   SQUEEZE_RIGHT , 1)       &                    SQUEEZE_RIGHT , myThid )
123        CALL OPEN_COPY_DATA_FILE(        CALL OPEN_COPY_DATA_FILE(
124       I                   'data.ptracers', 'PTRACERS_READPARMS',       I                   'data.ptracers', 'PTRACERS_READPARMS',
125       O                   iUnit,       O                   iUnit,
# Line 94  C     Open and read the data.ptracers fi Line 127  C     Open and read the data.ptracers fi
127        READ(UNIT=iUnit,NML=PTRACERS_PARM01)        READ(UNIT=iUnit,NML=PTRACERS_PARM01)
128        WRITE(msgBuf,'(A)')        WRITE(msgBuf,'(A)')
129       &  ' PTRACERS_READPARMS: finished reading data.ptracers'       &  ' PTRACERS_READPARMS: finished reading data.ptracers'
130        CALL PRINT_MESSAGE(msgBuf, standardMessageUnit,        CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
131       &                   SQUEEZE_RIGHT , 1)       &                    SQUEEZE_RIGHT , myThid )
132    
133  C     Close the open data file  C     Close the open data file
134        CLOSE(iUnit)        CLOSE(iUnit)
       _END_MASTER(myThid)  
   
 C     Everyone else must wait for the parameters to be loaded  
       _BARRIER  
135    
136  C     Now set-up any remaining parameters that result from the input  C     Now set-up any remaining parameters that result from the input
137  C     parameters  C     parameters
# Line 114  C     assume that all PTRACERS fields wi Line 143  C     assume that all PTRACERS fields wi
143        ENDIF        ENDIF
144  C     Check we are not trying to use more tracers than allowed  C     Check we are not trying to use more tracers than allowed
145        IF (PTRACERS_numInUse.GT.PTRACERS_num) THEN        IF (PTRACERS_numInUse.GT.PTRACERS_num) THEN
146          WRITE(msgBuf,'(A,I2,A,I2,A)')          WRITE(msgBuf,'(A,I4,A,I4,A)')
147       &       ' PTRACERS_READPARMS: You requested ',PTRACERS_numInUse,       &       ' PTRACERS_READPARMS: You requested',PTRACERS_numInUse,
148       &       ' tracers at run time when only ',PTRACERS_num,       &       ' tracers at run time when only',PTRACERS_num,
149       &       ' were specified at compile time. Naughty! '       &       ' were specified at compile time. Naughty! '
150          CALL PRINT_ERROR(msgBuf, 1)          CALL PRINT_ERROR( msgBuf, myThid )
151          STOP 'ABNORMAL END: S/R PTRACERS_READPARMS'          STOP 'ABNORMAL END: S/R PTRACERS_READPARMS'
152        ENDIF        ENDIF
153  C     Check that enough parameters were specified  C     Check that enough parameters were specified
154        DO iTracer=1,PTRACERS_numInUse        DO iTracer=1,PTRACERS_numInUse
155          IF (PTRACERS_advScheme(iTracer).EQ.0) THEN          IF (PTRACERS_advScheme(iTracer).EQ.0) THEN
156            WRITE(msgBuf,'(A,A,I2)')            WRITE(msgBuf,'(A,A,I3)')
157       &         ' PTRACERS_READPARMS: ',       &         ' PTRACERS_READPARMS: ',
158       &         'No advect. scheme specified for tracer #',       &         'No advect. scheme specified for tracer #',
159       &         iTracer       &         iTracer
160            CALL PRINT_ERROR(msgBuf, 1)            CALL PRINT_ERROR( msgBuf, myThid )
161            STOP 'ABNORMAL END: S/R PTRACERS_READPARMS'            STOP 'ABNORMAL END: S/R PTRACERS_READPARMS'
162          ENDIF          ENDIF
163        ENDDO        ENDDO
164    #ifndef INCLUDE_IMPLVERTADV_CODE
165  C     Set the default I/O Types        DO iTracer=1,PTRACERS_numInUse
166        IF (PTRACERS_iotypes .EQ. -1) THEN         IF ( PTRACERS_ImplVertAdv(iTracer) ) THEN
167          PTRACERS_iotypes = 1          WRITE(msgBuf,'(A)')
168        ENDIF       &   'PTRACERS_READPARMS: #undef INCLUDE_IMPLVERTADV_CODE'
169            CALL PRINT_ERROR( msgBuf, myThid )
170            WRITE(msgBuf,'(2A,I3,A)') 'PTRACERS_READPARMS:',
171         &   ' but pTracers_ImplVertAdv(',iTracer,' ) is TRUE'
172            CALL PRINT_ERROR( msgBuf, myThid )
173            STOP 'ABNORMAL END: S/R PTRACERS_READPARMS'
174           ENDIF
175          ENDDO
176    #endif
177          DO iTracer=1,PTRACERS_numInUse
178            IF ( PTRACERS_useGMRedi(iTracer) .AND. .NOT.useGMRedi ) THEN
179              WRITE(msgBuf,'(2A,I3,A)') 'PTRACERS_READPARMS:',
180         &     ' pTracers_useGMRedi(',iTracer,' ) is TRUE'
181              CALL PRINT_ERROR( msgBuf, myThid )
182              WRITE(msgBuf,'(A,L5,A)')
183         &     'PTRACERS_READPARMS: But not useGMRedi (=',useGMRedi,')'
184              CALL PRINT_ERROR( msgBuf, myThid )
185              STOP 'ABNORMAL END: S/R PTRACERS_READPARMS'
186            ENDIF
187            IF ( PTRACERS_useKPP(iTracer) .AND. .NOT.useKPP ) THEN
188              WRITE(msgBuf,'(2A,I3,A)') 'PTRACERS_READPARMS:',
189         &     ' pTracers_useKPP(',iTracer,' ) is TRUE'
190              CALL PRINT_ERROR( msgBuf, myThid )
191              WRITE(msgBuf,'(A,L5,A)')
192         &     'PTRACERS_READPARMS: But not useKPP (=',useKPP,')'
193              CALL PRINT_ERROR( msgBuf, myThid )
194              STOP 'ABNORMAL END: S/R PTRACERS_READPARMS'
195            ENDIF
196            IF ( PTRACERS_diffKr(iTracer).NE.UNSET_RL ) THEN
197             DO k=1,Nr
198              PTRACERS_diffKrNr(k,iTracer)=PTRACERS_diffKr(iTracer)
199             ENDDO
200            ENDIF
201          ENDDO
202    
203  #ifdef ALLOW_MNC  #ifdef ALLOW_MNC
204  C     Initialize the MNC variable types for PTRACERS        PTRACERS_timeave_mnc      = useMNC .AND. PTRACERS_timeave_mnc
205        IF (useMNC) THEN        PTRACERS_snapshot_mnc     = useMNC .AND. PTRACERS_snapshot_mnc
206          CALL PTRACERS_MNC_INIT( myThid )        PTRACERS_monitor_mnc      = useMNC .AND. PTRACERS_monitor_mnc
207        ENDIF        PTRACERS_pickup_write_mnc = useMNC .AND. PTRACERS_pickup_write_mnc
208  #endif /*  ALLOW_MNC  */        PTRACERS_pickup_read_mnc  = useMNC .AND. PTRACERS_pickup_read_mnc
209          
210          PTRACERS_timeave_mdsio      = (.NOT. PTRACERS_timeave_mnc)
211         &     .OR. outputTypesInclusive
212          PTRACERS_snapshot_mdsio     = (.NOT. PTRACERS_snapshot_mnc)
213         &     .OR. outputTypesInclusive
214          PTRACERS_monitor_stdio      = (.NOT. PTRACERS_monitor_mnc)
215         &     .OR. outputTypesInclusive
216          PTRACERS_pickup_write_mdsio = (.NOT. PTRACERS_pickup_write_mnc)
217         &     .OR. outputTypesInclusive
218          PTRACERS_pickup_read_mdsio  = (.NOT. PTRACERS_pickup_read_mnc)
219         &     .OR. outputTypesInclusive
220    #else
221          PTRACERS_timeave_mnc        = .FALSE.
222          PTRACERS_snapshot_mnc       = .FALSE.
223          PTRACERS_monitor_mnc        = .FALSE.
224          PTRACERS_pickup_write_mnc   = .FALSE.
225          PTRACERS_pickup_read_mnc    = .FALSE.
226          PTRACERS_timeave_mdsio      = .TRUE.
227          PTRACERS_snapshot_mdsio     = .TRUE.
228          PTRACERS_monitor_stdio      = .TRUE.
229          PTRACERS_pickup_write_mdsio = .TRUE.
230          PTRACERS_pickup_read_mdsio  = .TRUE.
231    #endif
232    
233    C--   Print a summary of pTracer parameter values:
234          iUnit = standardMessageUnit
235          WRITE(msgBuf,'(A)') '// ==================================='
236          CALL PRINT_MESSAGE( msgBuf, iUnit, SQUEEZE_RIGHT , myThid )
237          WRITE(msgBuf,'(A)') '// PTRACERS parameters '
238          CALL PRINT_MESSAGE( msgBuf, iUnit, SQUEEZE_RIGHT , myThid )
239          WRITE(msgBuf,'(A)') '// ==================================='
240          CALL PRINT_MESSAGE( msgBuf, iUnit, SQUEEZE_RIGHT , myThid )
241          CALL WRITE_0D_I( PTRACERS_numInUse, INDEX_NONE,
242         &   'PTRACERS_numInUse =',
243         &   ' /* number of tracers */')
244          CALL WRITE_0D_I( PTRACERS_Iter0, INDEX_NONE,
245         &   'PTRACERS_Iter0 =',
246         &   ' /* timestep number when tracers are initialized */')
247          CALL WRITE_0D_R8(PTRACERS_dumpFreq, INDEX_NONE,
248         &   'PTRACERS_dumpFreq =',
249         &   ' /* Frequency^-1 for snapshot output (s) */')
250          CALL WRITE_0D_R8(PTRACERS_taveFreq, INDEX_NONE,
251         &   'PTRACERS_taveFreq =',
252         &   ' /* Frequency^-1 for time-Aver. output (s) */')
253          CALL WRITE_0D_L( PTRACERS_useRecords, INDEX_NONE,
254         &   'PTRACERS_useRecords =', ' /* all tracers in 1 file */')
255    
256          CALL WRITE_0D_L( PTRACERS_timeave_mnc, INDEX_NONE,
257         &     'PTRACERS_timeave_mnc =',
258         &     ' /* use MNC for Tave output */')
259          CALL WRITE_0D_L( PTRACERS_snapshot_mnc, INDEX_NONE,
260         &     'PTRACERS_snapshot_mnc =',
261         &     ' /* use MNC for snapshot output */')
262          CALL WRITE_0D_L( PTRACERS_pickup_write_mnc, INDEX_NONE,
263         &     'PTRACERS_pickup_write_mnc =',
264         &     ' /* use MNC for writing pickups */')
265          CALL WRITE_0D_L( PTRACERS_pickup_read_mnc, INDEX_NONE,
266         &     'PTRACERS_pickup_read_mnc =',
267         &     ' /* use MNC for reading pickups */')
268    
269          DO iTracer=1,PTRACERS_numInUse
270            WRITE(msgBuf,'(A)') ' -----------------------------------'
271            CALL PRINT_MESSAGE( msgBuf, iUnit, SQUEEZE_RIGHT, myThid )
272            WRITE(msgBuf,'(A,I4)') ' tracer number : ',iTracer
273            CALL PRINT_MESSAGE( msgBuf, iUnit, SQUEEZE_RIGHT, myThid )
274            CALL WRITE_0D_I( PTRACERS_advScheme(iTracer), INDEX_NONE,
275         &     'PTRACERS_advScheme =', ' /* Advection Scheme */')
276            CALL WRITE_0D_L( PTRACERS_ImplVertAdv(iTracer), INDEX_NONE,
277         &     'PTRACERS_ImplVertAdv =',
278         &     ' /* implicit vert. advection flag */')
279            CALL WRITE_0D_R8( PTRACERS_diffKh(iTracer), INDEX_NONE,
280         &     'PTRACERS_diffKh =', ' /* Laplacian Diffusivity */')
281            CALL WRITE_0D_R8( PTRACERS_diffK4(iTracer), INDEX_NONE,
282         &     'PTRACERS_diffK4 =', ' /* Biharmonic Diffusivity */')
283            CALL WRITE_1D_R8( PTRACERS_diffKrNr(1,iTracer), Nr, INDEX_K,
284         &     'PTRACERS_diffKrNr =', ' /* Vertical Diffusivity */')
285            CALL WRITE_0D_L( PTRACERS_useGMRedi(iTracer), INDEX_NONE,
286         &     'PTRACERS_useGMRedi =', ' /* apply GM-Redi */')
287            CALL WRITE_0D_L( PTRACERS_useKPP(iTracer), INDEX_NONE,
288         &     'PTRACERS_useKPP =', ' /* apply KPP scheme */')
289            CALL WRITE_1D_R8( PTRACERS_ref(1,iTracer), Nr, INDEX_K,
290         &     'PTRACERS_ref =', ' /* Reference vertical profile */')
291            CALL WRITE_0D_R8( PTRACERS_EvPrRn(iTracer), INDEX_NONE,
292         &     'PTRACERS_EvPrRn =', '/* tracer conc. in Evap. & Rain */')
293    
294          ENDDO
295            WRITE(msgBuf,'(A)') ' -----------------------------------'
296            CALL PRINT_MESSAGE( msgBuf, iUnit, SQUEEZE_RIGHT, myThid )
297    
298          _END_MASTER(myThid)
299    C     Everyone else must wait for the parameters to be loaded
300          _BARRIER
301    
302  #endif /* ALLOW_PTRACERS */  #endif /* ALLOW_PTRACERS */
303    
304        RETURN        RETURN
Legend:
Removed from v.1.6  
changed lines
  Added in v.1.26
  ViewVC Help
Powered by ViewVC 1.1.22