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

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

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


Revision 1.26 - (hide annotations) (download)
Tue Sep 18 21:20:06 2007 UTC (16 years, 8 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint59i, checkpoint59h
Changes since 1.25: +24 -10 lines
stop when PTRACERS_useGMRedi (or PTRACERS_useKPP) is set to True
 in data.ptracers but GMRedi (or KPP) are not used (useGMRedi=F,useKPP=F).

1 jmc 1.26 C $Header: /u/gcmpack/MITgcm/pkg/ptracers/ptracers_readparms.F,v 1.25 2006/08/08 21:20:26 jmc 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 jmc 1.24
10 edhill 1.6 C !INTERFACE:
11 adcroft 1.1 SUBROUTINE PTRACERS_READPARMS( myThid )
12 jmc 1.24
13 edhill 1.6 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.20 #ifdef ALLOW_MNC
24     #include "MNC_PARAMS.h"
25     #endif
26 edhill 1.7
27 edhill 1.6 C !INPUT PARAMETERS:
28 adcroft 1.1 INTEGER myThid
29 edhill 1.6 CEOP
30 adcroft 1.1
31     #ifdef ALLOW_PTRACERS
32    
33 edhill 1.6 C !LOCAL VARIABLES:
34 jmc 1.11 C k,iTracer :: loop indices
35 edhill 1.6 C iUnit :: unit number for I/O
36     C msgBuf :: message buffer
37 jmc 1.11 INTEGER k, iTracer
38 adcroft 1.1 INTEGER iUnit
39 edhill 1.6 INTEGER ic
40 adcroft 1.1 CHARACTER*(MAX_LEN_MBUF) msgBuf
41 jmc 1.11 _RL PTRACERS_diffKr(PTRACERS_num)
42 adcroft 1.1
43 jmc 1.5 C PTRACERS_taveFreq :: Frequency with which time-averaged PTRACERS
44     C are written to post-processing files.
45     NAMELIST /PTRACERS_PARM01/
46 mlosch 1.14 & PTRACERS_dumpFreq,
47 edhill 1.6 & PTRACERS_taveFreq,
48 mlosch 1.13 & PTRACERS_monitorFreq,
49 edhill 1.6 & PTRACERS_advScheme,
50 jmc 1.15 & PTRACERS_ImplVertAdv,
51 edhill 1.6 & PTRACERS_diffKh,
52     & PTRACERS_diffK4,
53     & PTRACERS_diffKr,
54 jmc 1.11 & PTRACERS_diffKrNr,
55 mlosch 1.23 & PTRACERS_ref,
56 jmc 1.24 & PTRACERS_EvPrRn,
57 edhill 1.6 & PTRACERS_useGMRedi,
58     & PTRACERS_useKPP,
59 jmc 1.19 & PTRACERS_Iter0,
60 edhill 1.6 & PTRACERS_numInUse,
61     & PTRACERS_initialFile,
62     & PTRACERS_useRecords,
63     & PTRACERS_names,
64     & PTRACERS_long_names,
65     & PTRACERS_units,
66 jmc 1.24 & PTRACERS_timeave_mnc,
67 mlosch 1.22 & PTRACERS_snapshot_mnc,
68     & PTRACERS_monitor_mnc,
69 jmc 1.24 & PTRACERS_pickup_write_mnc,
70 mlosch 1.22 & PTRACERS_pickup_read_mnc
71 jmc 1.5
72 jmc 1.25 _BEGIN_MASTER(myThid)
73    
74 edhill 1.6 C This routine has been called by the main model so we set our
75     C internal flag to indicate we are in business
76 adcroft 1.1 PTRACERSisON=.TRUE.
77    
78 edhill 1.6 C Set defaults values for parameters in PTRACERS.h
79 mlosch 1.17 PTRACERS_dumpFreq = dumpFreq
80 mlosch 1.13 PTRACERS_taveFreq = taveFreq
81     PTRACERS_monitorFreq = monitorFreq
82 jmc 1.19 PTRACERS_Iter0 = 0
83 adcroft 1.1 PTRACERS_numInUse=-1
84     DO iTracer=1,PTRACERS_num
85 edhill 1.6 PTRACERS_advScheme(iTracer)=saltAdvScheme
86 jmc 1.15 PTRACERS_ImplVertAdv(iTracer) = .FALSE.
87 edhill 1.6 PTRACERS_diffKh(iTracer)=diffKhS
88     PTRACERS_diffK4(iTracer)=diffK4S
89 jmc 1.11 PTRACERS_diffKr(iTracer)=UNSET_RL
90     DO k=1,Nr
91     PTRACERS_diffKrNr(k,iTracer)=diffKrNrS(k)
92 mlosch 1.23 PTRACERS_ref (k,iTracer)=0. _d 0
93 jmc 1.11 ENDDO
94 jmc 1.24 PTRACERS_EvPrRn(iTracer)=UNSET_RL
95 edhill 1.6 PTRACERS_useGMRedi(iTracer)=useGMRedi
96     PTRACERS_useKPP(iTracer)=useKPP
97     PTRACERS_initialFile(iTracer)=' '
98     DO ic = 1,MAX_LEN_FNAM
99     PTRACERS_names(iTracer)(ic:ic) = ' '
100     PTRACERS_long_names(iTracer)(ic:ic) = ' '
101     PTRACERS_units(iTracer)(ic:ic) = ' '
102     ENDDO
103 adcroft 1.1 ENDDO
104 edhill 1.20 PTRACERS_useRecords = .FALSE.
105     #ifdef ALLOW_MNC
106 jmc 1.25 PTRACERS_timeave_mnc = useMNC .AND. timeave_mnc
107     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 edhill 1.20 #else
112     PTRACERS_timeave_mnc = .FALSE.
113     PTRACERS_snapshot_mnc = .FALSE.
114 mlosch 1.22 PTRACERS_monitor_mnc = .FALSE.
115 edhill 1.20 PTRACERS_pickup_write_mnc = .FALSE.
116     PTRACERS_pickup_read_mnc = .FALSE.
117     #endif
118 adcroft 1.1
119 edhill 1.6 C Open and read the data.ptracers file
120 adcroft 1.1 WRITE(msgBuf,'(A)') ' PTRACERS_READPARMS: opening data.ptracers'
121 jmc 1.25 CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
122     & SQUEEZE_RIGHT , myThid )
123 adcroft 1.1 CALL OPEN_COPY_DATA_FILE(
124     I 'data.ptracers', 'PTRACERS_READPARMS',
125     O iUnit,
126     I myThid )
127     READ(UNIT=iUnit,NML=PTRACERS_PARM01)
128     WRITE(msgBuf,'(A)')
129     & ' PTRACERS_READPARMS: finished reading data.ptracers'
130 jmc 1.25 CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
131     & SQUEEZE_RIGHT , myThid )
132 adcroft 1.1
133 edhill 1.6 C Close the open data file
134 adcroft 1.1 CLOSE(iUnit)
135    
136 edhill 1.6 C Now set-up any remaining parameters that result from the input
137     C parameters
138 adcroft 1.1
139 edhill 1.6 C If PTRACERS_numInUse was not set in data.ptracers then we can
140     C assume that all PTRACERS fields will be in use
141 adcroft 1.1 IF (PTRACERS_numInUse.LT.0) THEN
142 edhill 1.6 PTRACERS_numInUse=PTRACERS_num
143 adcroft 1.1 ENDIF
144 edhill 1.6 C Check we are not trying to use more tracers than allowed
145 adcroft 1.1 IF (PTRACERS_numInUse.GT.PTRACERS_num) THEN
146 jmc 1.26 WRITE(msgBuf,'(A,I4,A,I4,A)')
147     & ' PTRACERS_READPARMS: You requested',PTRACERS_numInUse,
148     & ' tracers at run time when only',PTRACERS_num,
149 edhill 1.6 & ' were specified at compile time. Naughty! '
150 jmc 1.25 CALL PRINT_ERROR( msgBuf, myThid )
151 edhill 1.6 STOP 'ABNORMAL END: S/R PTRACERS_READPARMS'
152 adcroft 1.1 ENDIF
153 edhill 1.6 C Check that enough parameters were specified
154 adcroft 1.1 DO iTracer=1,PTRACERS_numInUse
155 edhill 1.6 IF (PTRACERS_advScheme(iTracer).EQ.0) THEN
156 jmc 1.26 WRITE(msgBuf,'(A,A,I3)')
157 edhill 1.6 & ' PTRACERS_READPARMS: ',
158     & 'No advect. scheme specified for tracer #',
159     & iTracer
160 jmc 1.25 CALL PRINT_ERROR( msgBuf, myThid )
161 edhill 1.6 STOP 'ABNORMAL END: S/R PTRACERS_READPARMS'
162     ENDIF
163 adcroft 1.1 ENDDO
164 jmc 1.15 #ifndef INCLUDE_IMPLVERTADV_CODE
165     DO iTracer=1,PTRACERS_numInUse
166     IF ( PTRACERS_ImplVertAdv(iTracer) ) THEN
167     WRITE(msgBuf,'(A)')
168     & 'PTRACERS_READPARMS: #undef INCLUDE_IMPLVERTADV_CODE'
169 jmc 1.25 CALL PRINT_ERROR( msgBuf, myThid )
170 jmc 1.26 WRITE(msgBuf,'(2A,I3,A)') 'PTRACERS_READPARMS:',
171 jmc 1.15 & ' but pTracers_ImplVertAdv(',iTracer,' ) is TRUE'
172 jmc 1.25 CALL PRINT_ERROR( msgBuf, myThid )
173 jmc 1.15 STOP 'ABNORMAL END: S/R PTRACERS_READPARMS'
174     ENDIF
175     ENDDO
176     #endif
177 jmc 1.11 DO iTracer=1,PTRACERS_numInUse
178 jmc 1.26 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 jmc 1.11 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 adcroft 1.1
203 edhill 1.6 #ifdef ALLOW_MNC
204 jmc 1.25 PTRACERS_timeave_mnc = useMNC .AND. PTRACERS_timeave_mnc
205     PTRACERS_snapshot_mnc = useMNC .AND. PTRACERS_snapshot_mnc
206     PTRACERS_monitor_mnc = useMNC .AND. PTRACERS_monitor_mnc
207     PTRACERS_pickup_write_mnc = useMNC .AND. PTRACERS_pickup_write_mnc
208     PTRACERS_pickup_read_mnc = useMNC .AND. PTRACERS_pickup_read_mnc
209 edhill 1.20
210     PTRACERS_timeave_mdsio = (.NOT. PTRACERS_timeave_mnc)
211     & .OR. outputTypesInclusive
212     PTRACERS_snapshot_mdsio = (.NOT. PTRACERS_snapshot_mnc)
213     & .OR. outputTypesInclusive
214 mlosch 1.22 PTRACERS_monitor_stdio = (.NOT. PTRACERS_monitor_mnc)
215     & .OR. outputTypesInclusive
216 edhill 1.20 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 mlosch 1.22 PTRACERS_monitor_mnc = .FALSE.
224 edhill 1.20 PTRACERS_pickup_write_mnc = .FALSE.
225     PTRACERS_pickup_read_mnc = .FALSE.
226     PTRACERS_timeave_mdsio = .TRUE.
227     PTRACERS_snapshot_mdsio = .TRUE.
228 mlosch 1.22 PTRACERS_monitor_stdio = .TRUE.
229 edhill 1.20 PTRACERS_pickup_write_mdsio = .TRUE.
230     PTRACERS_pickup_read_mdsio = .TRUE.
231     #endif
232 jmc 1.24
233 jmc 1.12 C-- Print a summary of pTracer parameter values:
234     iUnit = standardMessageUnit
235     WRITE(msgBuf,'(A)') '// ==================================='
236 jmc 1.25 CALL PRINT_MESSAGE( msgBuf, iUnit, SQUEEZE_RIGHT , myThid )
237 jmc 1.12 WRITE(msgBuf,'(A)') '// PTRACERS parameters '
238 jmc 1.25 CALL PRINT_MESSAGE( msgBuf, iUnit, SQUEEZE_RIGHT , myThid )
239 jmc 1.12 WRITE(msgBuf,'(A)') '// ==================================='
240 jmc 1.25 CALL PRINT_MESSAGE( msgBuf, iUnit, SQUEEZE_RIGHT , myThid )
241 jmc 1.12 CALL WRITE_0D_I( PTRACERS_numInUse, INDEX_NONE,
242     & 'PTRACERS_numInUse =',
243     & ' /* number of tracers */')
244 jmc 1.19 CALL WRITE_0D_I( PTRACERS_Iter0, INDEX_NONE,
245     & 'PTRACERS_Iter0 =',
246     & ' /* timestep number when tracers are initialized */')
247 mlosch 1.14 CALL WRITE_0D_R8(PTRACERS_dumpFreq, INDEX_NONE,
248     & 'PTRACERS_dumpFreq =',
249     & ' /* Frequency^-1 for snapshot output (s) */')
250 jmc 1.12 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 jmc 1.25
256 edhill 1.20 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 jmc 1.25 & 'PTRACERS_pickup_write_mnc =',
264 edhill 1.20 & ' /* use MNC for writing pickups */')
265     CALL WRITE_0D_L( PTRACERS_pickup_read_mnc, INDEX_NONE,
266 jmc 1.25 & 'PTRACERS_pickup_read_mnc =',
267 edhill 1.20 & ' /* use MNC for reading pickups */')
268 jmc 1.12
269     DO iTracer=1,PTRACERS_numInUse
270     WRITE(msgBuf,'(A)') ' -----------------------------------'
271 jmc 1.25 CALL PRINT_MESSAGE( msgBuf, iUnit, SQUEEZE_RIGHT, myThid )
272 jmc 1.12 WRITE(msgBuf,'(A,I4)') ' tracer number : ',iTracer
273 jmc 1.25 CALL PRINT_MESSAGE( msgBuf, iUnit, SQUEEZE_RIGHT, myThid )
274 jmc 1.12 CALL WRITE_0D_I( PTRACERS_advScheme(iTracer), INDEX_NONE,
275     & 'PTRACERS_advScheme =', ' /* Advection Scheme */')
276 jmc 1.15 CALL WRITE_0D_L( PTRACERS_ImplVertAdv(iTracer), INDEX_NONE,
277     & 'PTRACERS_ImplVertAdv =',
278     & ' /* implicit vert. advection flag */')
279 jmc 1.12 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 jmc 1.24 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 jmc 1.12
294     ENDDO
295     WRITE(msgBuf,'(A)') ' -----------------------------------'
296 jmc 1.25 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 adcroft 1.1 #endif /* ALLOW_PTRACERS */
303    
304     RETURN
305     END
306 edhill 1.6

  ViewVC Help
Powered by ViewVC 1.1.22