/[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.33 - (hide annotations) (download)
Thu Aug 21 15:16:01 2008 UTC (15 years, 9 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint61f, checkpoint61e, checkpoint61g, checkpoint61d, checkpoint61c, checkpoint61l, checkpoint61j, checkpoint61k, checkpoint61h, checkpoint61i
Changes since 1.32: +2 -2 lines
fix previous check-in (screw up ptracers_useKPP)

1 jmc 1.33 C $Header: /u/gcmpack/MITgcm/pkg/ptracers/ptracers_readparms.F,v 1.32 2008/08/18 14:34:43 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 jmc 1.27 #include "PTRACERS_PARAMS.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 jmc 1.30 _RL tauTr1ClimRelax
43 adcroft 1.1
44 jmc 1.5 C PTRACERS_taveFreq :: Frequency with which time-averaged PTRACERS
45     C are written to post-processing files.
46 jmc 1.30 C tauTr1ClimRelax :: old parameter (will be removed 1 day)
47 jmc 1.5 NAMELIST /PTRACERS_PARM01/
48 jmc 1.30 & tauTr1ClimRelax,
49 mlosch 1.14 & PTRACERS_dumpFreq,
50 edhill 1.6 & PTRACERS_taveFreq,
51 mlosch 1.13 & PTRACERS_monitorFreq,
52 edhill 1.6 & PTRACERS_advScheme,
53 jmc 1.15 & PTRACERS_ImplVertAdv,
54 edhill 1.6 & PTRACERS_diffKh,
55     & PTRACERS_diffK4,
56     & PTRACERS_diffKr,
57 jmc 1.11 & PTRACERS_diffKrNr,
58 mlosch 1.23 & PTRACERS_ref,
59 jmc 1.24 & PTRACERS_EvPrRn,
60 edhill 1.6 & PTRACERS_useGMRedi,
61 jmc 1.32 & PTRACERS_useDWNSLP,
62 edhill 1.6 & PTRACERS_useKPP,
63 jmc 1.19 & PTRACERS_Iter0,
64 edhill 1.6 & PTRACERS_numInUse,
65     & PTRACERS_initialFile,
66     & PTRACERS_useRecords,
67     & PTRACERS_names,
68     & PTRACERS_long_names,
69     & PTRACERS_units,
70 jmc 1.24 & PTRACERS_timeave_mnc,
71 mlosch 1.22 & PTRACERS_snapshot_mnc,
72     & PTRACERS_monitor_mnc,
73 jmc 1.24 & PTRACERS_pickup_write_mnc,
74 mlosch 1.22 & PTRACERS_pickup_read_mnc
75 jmc 1.5
76 jmc 1.25 _BEGIN_MASTER(myThid)
77    
78 edhill 1.6 C This routine has been called by the main model so we set our
79     C internal flag to indicate we are in business
80 jmc 1.29 c PTRACERSisON=.TRUE.
81     C Note(jmc): remove this flag which is not really usefull (not set properly
82     C when usePTRACERS=F and always TRUE otherwise);
83     C much better to use "usePTRACERS" flag instead.
84 adcroft 1.1
85 jmc 1.28 C Set ptracer IO & diagnostics labels (2 characters long)
86     CALL PTRACERS_SET_IOLABEL(
87     O PTRACERS_ioLabel,
88     I PTRACERS_num, myThid )
89    
90 edhill 1.6 C Set defaults values for parameters in PTRACERS.h
91 mlosch 1.17 PTRACERS_dumpFreq = dumpFreq
92 mlosch 1.13 PTRACERS_taveFreq = taveFreq
93     PTRACERS_monitorFreq = monitorFreq
94 jmc 1.19 PTRACERS_Iter0 = 0
95 adcroft 1.1 PTRACERS_numInUse=-1
96     DO iTracer=1,PTRACERS_num
97 edhill 1.6 PTRACERS_advScheme(iTracer)=saltAdvScheme
98 jmc 1.15 PTRACERS_ImplVertAdv(iTracer) = .FALSE.
99 edhill 1.6 PTRACERS_diffKh(iTracer)=diffKhS
100     PTRACERS_diffK4(iTracer)=diffK4S
101 jmc 1.11 PTRACERS_diffKr(iTracer)=UNSET_RL
102     DO k=1,Nr
103     PTRACERS_diffKrNr(k,iTracer)=diffKrNrS(k)
104 mlosch 1.23 PTRACERS_ref (k,iTracer)=0. _d 0
105 jmc 1.11 ENDDO
106 jmc 1.24 PTRACERS_EvPrRn(iTracer)=UNSET_RL
107 edhill 1.6 PTRACERS_useGMRedi(iTracer)=useGMRedi
108 jmc 1.31 PTRACERS_useDWNSLP(iTracer)=useDOWN_SLOPE
109 jmc 1.33 PTRACERS_useKPP(iTracer) =useKPP
110 edhill 1.6 PTRACERS_initialFile(iTracer)=' '
111     DO ic = 1,MAX_LEN_FNAM
112     PTRACERS_names(iTracer)(ic:ic) = ' '
113     PTRACERS_long_names(iTracer)(ic:ic) = ' '
114     PTRACERS_units(iTracer)(ic:ic) = ' '
115     ENDDO
116 adcroft 1.1 ENDDO
117 edhill 1.20 PTRACERS_useRecords = .FALSE.
118     #ifdef ALLOW_MNC
119 jmc 1.25 PTRACERS_timeave_mnc = useMNC .AND. timeave_mnc
120     PTRACERS_snapshot_mnc = useMNC .AND. snapshot_mnc
121     PTRACERS_monitor_mnc = useMNC .AND. monitor_mnc
122     PTRACERS_pickup_write_mnc = useMNC .AND. pickup_write_mnc
123     PTRACERS_pickup_read_mnc = useMNC .AND. pickup_read_mnc
124 edhill 1.20 #else
125     PTRACERS_timeave_mnc = .FALSE.
126     PTRACERS_snapshot_mnc = .FALSE.
127 mlosch 1.22 PTRACERS_monitor_mnc = .FALSE.
128 edhill 1.20 PTRACERS_pickup_write_mnc = .FALSE.
129     PTRACERS_pickup_read_mnc = .FALSE.
130     #endif
131 jmc 1.30 tauTr1ClimRelax = 0.
132 adcroft 1.1
133 edhill 1.6 C Open and read the data.ptracers file
134 adcroft 1.1 WRITE(msgBuf,'(A)') ' PTRACERS_READPARMS: opening data.ptracers'
135 jmc 1.25 CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
136     & SQUEEZE_RIGHT , myThid )
137 adcroft 1.1 CALL OPEN_COPY_DATA_FILE(
138     I 'data.ptracers', 'PTRACERS_READPARMS',
139     O iUnit,
140     I myThid )
141     READ(UNIT=iUnit,NML=PTRACERS_PARM01)
142     WRITE(msgBuf,'(A)')
143     & ' PTRACERS_READPARMS: finished reading data.ptracers'
144 jmc 1.25 CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
145     & SQUEEZE_RIGHT , myThid )
146 adcroft 1.1
147 edhill 1.6 C Close the open data file
148 adcroft 1.1 CLOSE(iUnit)
149    
150 edhill 1.6 C Now set-up any remaining parameters that result from the input
151     C parameters
152 adcroft 1.1
153 jmc 1.30 C Tracer 1 climatology relaxation time scale (<- but the code is gone !)
154     IF ( tauTr1ClimRelax .EQ. 0. ) THEN
155     lambdaTr1ClimRelax = 0.
156     ELSE
157     lambdaTr1ClimRelax = 1./tauTr1ClimRelax
158     ENDIF
159    
160 edhill 1.6 C If PTRACERS_numInUse was not set in data.ptracers then we can
161     C assume that all PTRACERS fields will be in use
162 adcroft 1.1 IF (PTRACERS_numInUse.LT.0) THEN
163 edhill 1.6 PTRACERS_numInUse=PTRACERS_num
164 adcroft 1.1 ENDIF
165 edhill 1.6 C Check we are not trying to use more tracers than allowed
166 adcroft 1.1 IF (PTRACERS_numInUse.GT.PTRACERS_num) THEN
167 jmc 1.26 WRITE(msgBuf,'(A,I4,A,I4,A)')
168     & ' PTRACERS_READPARMS: You requested',PTRACERS_numInUse,
169     & ' tracers at run time when only',PTRACERS_num,
170 edhill 1.6 & ' were specified at compile time. Naughty! '
171 jmc 1.25 CALL PRINT_ERROR( msgBuf, myThid )
172 edhill 1.6 STOP 'ABNORMAL END: S/R PTRACERS_READPARMS'
173 adcroft 1.1 ENDIF
174 edhill 1.6 C Check that enough parameters were specified
175 adcroft 1.1 DO iTracer=1,PTRACERS_numInUse
176 edhill 1.6 IF (PTRACERS_advScheme(iTracer).EQ.0) THEN
177 jmc 1.26 WRITE(msgBuf,'(A,A,I3)')
178 edhill 1.6 & ' PTRACERS_READPARMS: ',
179     & 'No advect. scheme specified for tracer #',
180     & iTracer
181 jmc 1.25 CALL PRINT_ERROR( msgBuf, myThid )
182 edhill 1.6 STOP 'ABNORMAL END: S/R PTRACERS_READPARMS'
183     ENDIF
184 adcroft 1.1 ENDDO
185 jmc 1.15 #ifndef INCLUDE_IMPLVERTADV_CODE
186     DO iTracer=1,PTRACERS_numInUse
187     IF ( PTRACERS_ImplVertAdv(iTracer) ) THEN
188     WRITE(msgBuf,'(A)')
189     & 'PTRACERS_READPARMS: #undef INCLUDE_IMPLVERTADV_CODE'
190 jmc 1.25 CALL PRINT_ERROR( msgBuf, myThid )
191 jmc 1.26 WRITE(msgBuf,'(2A,I3,A)') 'PTRACERS_READPARMS:',
192 jmc 1.15 & ' but pTracers_ImplVertAdv(',iTracer,' ) is TRUE'
193 jmc 1.25 CALL PRINT_ERROR( msgBuf, myThid )
194 jmc 1.15 STOP 'ABNORMAL END: S/R PTRACERS_READPARMS'
195     ENDIF
196     ENDDO
197     #endif
198 jmc 1.11 DO iTracer=1,PTRACERS_numInUse
199 jmc 1.26 IF ( PTRACERS_useGMRedi(iTracer) .AND. .NOT.useGMRedi ) THEN
200     WRITE(msgBuf,'(2A,I3,A)') 'PTRACERS_READPARMS:',
201     & ' pTracers_useGMRedi(',iTracer,' ) is TRUE'
202     CALL PRINT_ERROR( msgBuf, myThid )
203     WRITE(msgBuf,'(A,L5,A)')
204     & 'PTRACERS_READPARMS: But not useGMRedi (=',useGMRedi,')'
205     CALL PRINT_ERROR( msgBuf, myThid )
206     STOP 'ABNORMAL END: S/R PTRACERS_READPARMS'
207     ENDIF
208 jmc 1.31 IF ( PTRACERS_useDWNSLP(iTracer) .AND. .NOT.useDOWN_SLOPE ) THEN
209     WRITE(msgBuf,'(2A,I3,A)') 'PTRACERS_READPARMS:',
210     & ' pTracers_useDWNSLP(',iTracer,' ) is TRUE'
211     CALL PRINT_ERROR( msgBuf, myThid )
212     WRITE(msgBuf,'(2A,L5,A)') 'PTRACERS_READPARMS:',
213     & ' But not useDOWN_SLOPE (=', useDOWN_SLOPE, ')'
214     CALL PRINT_ERROR( msgBuf, myThid )
215     STOP 'ABNORMAL END: S/R PTRACERS_READPARMS'
216     ENDIF
217 jmc 1.26 IF ( PTRACERS_useKPP(iTracer) .AND. .NOT.useKPP ) THEN
218     WRITE(msgBuf,'(2A,I3,A)') 'PTRACERS_READPARMS:',
219     & ' pTracers_useKPP(',iTracer,' ) is TRUE'
220     CALL PRINT_ERROR( msgBuf, myThid )
221     WRITE(msgBuf,'(A,L5,A)')
222     & 'PTRACERS_READPARMS: But not useKPP (=',useKPP,')'
223     CALL PRINT_ERROR( msgBuf, myThid )
224     STOP 'ABNORMAL END: S/R PTRACERS_READPARMS'
225     ENDIF
226 jmc 1.11 IF ( PTRACERS_diffKr(iTracer).NE.UNSET_RL ) THEN
227     DO k=1,Nr
228     PTRACERS_diffKrNr(k,iTracer)=PTRACERS_diffKr(iTracer)
229     ENDDO
230     ENDIF
231     ENDDO
232 adcroft 1.1
233 edhill 1.6 #ifdef ALLOW_MNC
234 jmc 1.25 PTRACERS_timeave_mnc = useMNC .AND. PTRACERS_timeave_mnc
235     PTRACERS_snapshot_mnc = useMNC .AND. PTRACERS_snapshot_mnc
236     PTRACERS_monitor_mnc = useMNC .AND. PTRACERS_monitor_mnc
237     PTRACERS_pickup_write_mnc = useMNC .AND. PTRACERS_pickup_write_mnc
238     PTRACERS_pickup_read_mnc = useMNC .AND. PTRACERS_pickup_read_mnc
239 edhill 1.20
240     PTRACERS_timeave_mdsio = (.NOT. PTRACERS_timeave_mnc)
241     & .OR. outputTypesInclusive
242     PTRACERS_snapshot_mdsio = (.NOT. PTRACERS_snapshot_mnc)
243     & .OR. outputTypesInclusive
244 mlosch 1.22 PTRACERS_monitor_stdio = (.NOT. PTRACERS_monitor_mnc)
245     & .OR. outputTypesInclusive
246 edhill 1.20 PTRACERS_pickup_write_mdsio = (.NOT. PTRACERS_pickup_write_mnc)
247     & .OR. outputTypesInclusive
248     PTRACERS_pickup_read_mdsio = (.NOT. PTRACERS_pickup_read_mnc)
249     & .OR. outputTypesInclusive
250     #else
251     PTRACERS_timeave_mnc = .FALSE.
252     PTRACERS_snapshot_mnc = .FALSE.
253 mlosch 1.22 PTRACERS_monitor_mnc = .FALSE.
254 edhill 1.20 PTRACERS_pickup_write_mnc = .FALSE.
255     PTRACERS_pickup_read_mnc = .FALSE.
256     PTRACERS_timeave_mdsio = .TRUE.
257     PTRACERS_snapshot_mdsio = .TRUE.
258 mlosch 1.22 PTRACERS_monitor_stdio = .TRUE.
259 edhill 1.20 PTRACERS_pickup_write_mdsio = .TRUE.
260     PTRACERS_pickup_read_mdsio = .TRUE.
261     #endif
262 jmc 1.24
263 jmc 1.12 C-- Print a summary of pTracer parameter values:
264     iUnit = standardMessageUnit
265     WRITE(msgBuf,'(A)') '// ==================================='
266 jmc 1.25 CALL PRINT_MESSAGE( msgBuf, iUnit, SQUEEZE_RIGHT , myThid )
267 jmc 1.12 WRITE(msgBuf,'(A)') '// PTRACERS parameters '
268 jmc 1.25 CALL PRINT_MESSAGE( msgBuf, iUnit, SQUEEZE_RIGHT , myThid )
269 jmc 1.12 WRITE(msgBuf,'(A)') '// ==================================='
270 jmc 1.25 CALL PRINT_MESSAGE( msgBuf, iUnit, SQUEEZE_RIGHT , myThid )
271 jmc 1.12 CALL WRITE_0D_I( PTRACERS_numInUse, INDEX_NONE,
272     & 'PTRACERS_numInUse =',
273     & ' /* number of tracers */')
274 jmc 1.19 CALL WRITE_0D_I( PTRACERS_Iter0, INDEX_NONE,
275     & 'PTRACERS_Iter0 =',
276     & ' /* timestep number when tracers are initialized */')
277 mlosch 1.14 CALL WRITE_0D_R8(PTRACERS_dumpFreq, INDEX_NONE,
278     & 'PTRACERS_dumpFreq =',
279     & ' /* Frequency^-1 for snapshot output (s) */')
280 jmc 1.12 CALL WRITE_0D_R8(PTRACERS_taveFreq, INDEX_NONE,
281     & 'PTRACERS_taveFreq =',
282     & ' /* Frequency^-1 for time-Aver. output (s) */')
283     CALL WRITE_0D_L( PTRACERS_useRecords, INDEX_NONE,
284     & 'PTRACERS_useRecords =', ' /* all tracers in 1 file */')
285 jmc 1.25
286 edhill 1.20 CALL WRITE_0D_L( PTRACERS_timeave_mnc, INDEX_NONE,
287     & 'PTRACERS_timeave_mnc =',
288     & ' /* use MNC for Tave output */')
289     CALL WRITE_0D_L( PTRACERS_snapshot_mnc, INDEX_NONE,
290     & 'PTRACERS_snapshot_mnc =',
291     & ' /* use MNC for snapshot output */')
292     CALL WRITE_0D_L( PTRACERS_pickup_write_mnc, INDEX_NONE,
293 jmc 1.25 & 'PTRACERS_pickup_write_mnc =',
294 edhill 1.20 & ' /* use MNC for writing pickups */')
295     CALL WRITE_0D_L( PTRACERS_pickup_read_mnc, INDEX_NONE,
296 jmc 1.25 & 'PTRACERS_pickup_read_mnc =',
297 edhill 1.20 & ' /* use MNC for reading pickups */')
298 jmc 1.12
299     DO iTracer=1,PTRACERS_numInUse
300     WRITE(msgBuf,'(A)') ' -----------------------------------'
301 jmc 1.25 CALL PRINT_MESSAGE( msgBuf, iUnit, SQUEEZE_RIGHT, myThid )
302 jmc 1.12 WRITE(msgBuf,'(A,I4)') ' tracer number : ',iTracer
303 jmc 1.25 CALL PRINT_MESSAGE( msgBuf, iUnit, SQUEEZE_RIGHT, myThid )
304 jmc 1.28 CALL WRITE_0D_C( PTRACERS_ioLabel(iTracer), 0, INDEX_NONE,
305     & 'PTRACERS_ioLabel =', ' /* tracer IO Label */')
306 jmc 1.12 CALL WRITE_0D_I( PTRACERS_advScheme(iTracer), INDEX_NONE,
307     & 'PTRACERS_advScheme =', ' /* Advection Scheme */')
308 jmc 1.15 CALL WRITE_0D_L( PTRACERS_ImplVertAdv(iTracer), INDEX_NONE,
309     & 'PTRACERS_ImplVertAdv =',
310     & ' /* implicit vert. advection flag */')
311 jmc 1.12 CALL WRITE_0D_R8( PTRACERS_diffKh(iTracer), INDEX_NONE,
312     & 'PTRACERS_diffKh =', ' /* Laplacian Diffusivity */')
313     CALL WRITE_0D_R8( PTRACERS_diffK4(iTracer), INDEX_NONE,
314     & 'PTRACERS_diffK4 =', ' /* Biharmonic Diffusivity */')
315     CALL WRITE_1D_R8( PTRACERS_diffKrNr(1,iTracer), Nr, INDEX_K,
316     & 'PTRACERS_diffKrNr =', ' /* Vertical Diffusivity */')
317     CALL WRITE_0D_L( PTRACERS_useGMRedi(iTracer), INDEX_NONE,
318     & 'PTRACERS_useGMRedi =', ' /* apply GM-Redi */')
319 jmc 1.31 CALL WRITE_0D_L( PTRACERS_useDWNSLP(iTracer), INDEX_NONE,
320     & 'PTRACERS_useDWNSLP =', ' /* apply DOWN-SLOPE Flow */')
321 jmc 1.12 CALL WRITE_0D_L( PTRACERS_useKPP(iTracer), INDEX_NONE,
322     & 'PTRACERS_useKPP =', ' /* apply KPP scheme */')
323 jmc 1.24 CALL WRITE_1D_R8( PTRACERS_ref(1,iTracer), Nr, INDEX_K,
324     & 'PTRACERS_ref =', ' /* Reference vertical profile */')
325     CALL WRITE_0D_R8( PTRACERS_EvPrRn(iTracer), INDEX_NONE,
326     & 'PTRACERS_EvPrRn =', '/* tracer conc. in Evap. & Rain */')
327 jmc 1.12
328     ENDDO
329     WRITE(msgBuf,'(A)') ' -----------------------------------'
330 jmc 1.25 CALL PRINT_MESSAGE( msgBuf, iUnit, SQUEEZE_RIGHT, myThid )
331    
332     _END_MASTER(myThid)
333     C Everyone else must wait for the parameters to be loaded
334     _BARRIER
335    
336 adcroft 1.1 #endif /* ALLOW_PTRACERS */
337    
338     RETURN
339     END
340 edhill 1.6

  ViewVC Help
Powered by ViewVC 1.1.22