/[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.30 - (hide annotations) (download)
Sat Apr 5 18:22:16 2008 UTC (16 years, 1 month ago) by jmc
Branch: MAIN
CVS Tags: checkpoint60, checkpoint61, checkpoint59q, checkpoint59p, checkpoint59r, checkpoint61b, checkpoint61a
Changes since 1.29: +12 -1 lines
move out of PARAMS.h the last piece of old-ptracer code (tauTr1ClimRelax,
 lambdaTr1ClimRelax) and put them (for now) in pkg/ptracers.
(note: but not clear to me what lambdaTr1ClimRelax is used for ...)

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

  ViewVC Help
Powered by ViewVC 1.1.22