/[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.31 - (hide annotations) (download)
Sun Aug 17 02:09:36 2008 UTC (15 years, 10 months ago) by jmc
Branch: MAIN
Changes since 1.30: +14 -2 lines
new pkg "down_slope".

1 jmc 1.31 C $Header: /u/gcmpack/MITgcm/pkg/ptracers/ptracers_readparms.F,v 1.30 2008/04/05 18:22:16 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 jmc 1.31 PTRACERS_useGMRedi(iTracer)=useGMRedi
108     PTRACERS_useDWNSLP(iTracer)=useDOWN_SLOPE
109 edhill 1.6 PTRACERS_initialFile(iTracer)=' '
110     DO ic = 1,MAX_LEN_FNAM
111     PTRACERS_names(iTracer)(ic:ic) = ' '
112     PTRACERS_long_names(iTracer)(ic:ic) = ' '
113     PTRACERS_units(iTracer)(ic:ic) = ' '
114     ENDDO
115 adcroft 1.1 ENDDO
116 edhill 1.20 PTRACERS_useRecords = .FALSE.
117     #ifdef ALLOW_MNC
118 jmc 1.25 PTRACERS_timeave_mnc = useMNC .AND. timeave_mnc
119     PTRACERS_snapshot_mnc = useMNC .AND. snapshot_mnc
120     PTRACERS_monitor_mnc = useMNC .AND. monitor_mnc
121     PTRACERS_pickup_write_mnc = useMNC .AND. pickup_write_mnc
122     PTRACERS_pickup_read_mnc = useMNC .AND. pickup_read_mnc
123 edhill 1.20 #else
124     PTRACERS_timeave_mnc = .FALSE.
125     PTRACERS_snapshot_mnc = .FALSE.
126 mlosch 1.22 PTRACERS_monitor_mnc = .FALSE.
127 edhill 1.20 PTRACERS_pickup_write_mnc = .FALSE.
128     PTRACERS_pickup_read_mnc = .FALSE.
129     #endif
130 jmc 1.30 tauTr1ClimRelax = 0.
131 adcroft 1.1
132 edhill 1.6 C Open and read the data.ptracers file
133 adcroft 1.1 WRITE(msgBuf,'(A)') ' PTRACERS_READPARMS: opening data.ptracers'
134 jmc 1.25 CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
135     & SQUEEZE_RIGHT , myThid )
136 adcroft 1.1 CALL OPEN_COPY_DATA_FILE(
137     I 'data.ptracers', 'PTRACERS_READPARMS',
138     O iUnit,
139     I myThid )
140     READ(UNIT=iUnit,NML=PTRACERS_PARM01)
141     WRITE(msgBuf,'(A)')
142     & ' PTRACERS_READPARMS: finished reading data.ptracers'
143 jmc 1.25 CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
144     & SQUEEZE_RIGHT , myThid )
145 adcroft 1.1
146 edhill 1.6 C Close the open data file
147 adcroft 1.1 CLOSE(iUnit)
148    
149 edhill 1.6 C Now set-up any remaining parameters that result from the input
150     C parameters
151 adcroft 1.1
152 jmc 1.30 C Tracer 1 climatology relaxation time scale (<- but the code is gone !)
153     IF ( tauTr1ClimRelax .EQ. 0. ) THEN
154     lambdaTr1ClimRelax = 0.
155     ELSE
156     lambdaTr1ClimRelax = 1./tauTr1ClimRelax
157     ENDIF
158    
159 edhill 1.6 C If PTRACERS_numInUse was not set in data.ptracers then we can
160     C assume that all PTRACERS fields will be in use
161 adcroft 1.1 IF (PTRACERS_numInUse.LT.0) THEN
162 edhill 1.6 PTRACERS_numInUse=PTRACERS_num
163 adcroft 1.1 ENDIF
164 edhill 1.6 C Check we are not trying to use more tracers than allowed
165 adcroft 1.1 IF (PTRACERS_numInUse.GT.PTRACERS_num) THEN
166 jmc 1.26 WRITE(msgBuf,'(A,I4,A,I4,A)')
167     & ' PTRACERS_READPARMS: You requested',PTRACERS_numInUse,
168     & ' tracers at run time when only',PTRACERS_num,
169 edhill 1.6 & ' were specified at compile time. Naughty! '
170 jmc 1.25 CALL PRINT_ERROR( msgBuf, myThid )
171 edhill 1.6 STOP 'ABNORMAL END: S/R PTRACERS_READPARMS'
172 adcroft 1.1 ENDIF
173 edhill 1.6 C Check that enough parameters were specified
174 adcroft 1.1 DO iTracer=1,PTRACERS_numInUse
175 edhill 1.6 IF (PTRACERS_advScheme(iTracer).EQ.0) THEN
176 jmc 1.26 WRITE(msgBuf,'(A,A,I3)')
177 edhill 1.6 & ' PTRACERS_READPARMS: ',
178     & 'No advect. scheme specified for tracer #',
179     & iTracer
180 jmc 1.25 CALL PRINT_ERROR( msgBuf, myThid )
181 edhill 1.6 STOP 'ABNORMAL END: S/R PTRACERS_READPARMS'
182     ENDIF
183 adcroft 1.1 ENDDO
184 jmc 1.15 #ifndef INCLUDE_IMPLVERTADV_CODE
185     DO iTracer=1,PTRACERS_numInUse
186     IF ( PTRACERS_ImplVertAdv(iTracer) ) THEN
187     WRITE(msgBuf,'(A)')
188     & 'PTRACERS_READPARMS: #undef INCLUDE_IMPLVERTADV_CODE'
189 jmc 1.25 CALL PRINT_ERROR( msgBuf, myThid )
190 jmc 1.26 WRITE(msgBuf,'(2A,I3,A)') 'PTRACERS_READPARMS:',
191 jmc 1.15 & ' but pTracers_ImplVertAdv(',iTracer,' ) is TRUE'
192 jmc 1.25 CALL PRINT_ERROR( msgBuf, myThid )
193 jmc 1.15 STOP 'ABNORMAL END: S/R PTRACERS_READPARMS'
194     ENDIF
195     ENDDO
196     #endif
197 jmc 1.11 DO iTracer=1,PTRACERS_numInUse
198 jmc 1.26 IF ( PTRACERS_useGMRedi(iTracer) .AND. .NOT.useGMRedi ) THEN
199     WRITE(msgBuf,'(2A,I3,A)') 'PTRACERS_READPARMS:',
200     & ' pTracers_useGMRedi(',iTracer,' ) is TRUE'
201     CALL PRINT_ERROR( msgBuf, myThid )
202     WRITE(msgBuf,'(A,L5,A)')
203     & 'PTRACERS_READPARMS: But not useGMRedi (=',useGMRedi,')'
204     CALL PRINT_ERROR( msgBuf, myThid )
205     STOP 'ABNORMAL END: S/R PTRACERS_READPARMS'
206     ENDIF
207 jmc 1.31 IF ( PTRACERS_useDWNSLP(iTracer) .AND. .NOT.useDOWN_SLOPE ) THEN
208     WRITE(msgBuf,'(2A,I3,A)') 'PTRACERS_READPARMS:',
209     & ' pTracers_useDWNSLP(',iTracer,' ) is TRUE'
210     CALL PRINT_ERROR( msgBuf, myThid )
211     WRITE(msgBuf,'(2A,L5,A)') 'PTRACERS_READPARMS:',
212     & ' But not useDOWN_SLOPE (=', useDOWN_SLOPE, ')'
213     CALL PRINT_ERROR( msgBuf, myThid )
214     STOP 'ABNORMAL END: S/R PTRACERS_READPARMS'
215     ENDIF
216 jmc 1.26 IF ( PTRACERS_useKPP(iTracer) .AND. .NOT.useKPP ) THEN
217     WRITE(msgBuf,'(2A,I3,A)') 'PTRACERS_READPARMS:',
218     & ' pTracers_useKPP(',iTracer,' ) is TRUE'
219     CALL PRINT_ERROR( msgBuf, myThid )
220     WRITE(msgBuf,'(A,L5,A)')
221     & 'PTRACERS_READPARMS: But not useKPP (=',useKPP,')'
222     CALL PRINT_ERROR( msgBuf, myThid )
223     STOP 'ABNORMAL END: S/R PTRACERS_READPARMS'
224     ENDIF
225 jmc 1.11 IF ( PTRACERS_diffKr(iTracer).NE.UNSET_RL ) THEN
226     DO k=1,Nr
227     PTRACERS_diffKrNr(k,iTracer)=PTRACERS_diffKr(iTracer)
228     ENDDO
229     ENDIF
230     ENDDO
231 adcroft 1.1
232 edhill 1.6 #ifdef ALLOW_MNC
233 jmc 1.25 PTRACERS_timeave_mnc = useMNC .AND. PTRACERS_timeave_mnc
234     PTRACERS_snapshot_mnc = useMNC .AND. PTRACERS_snapshot_mnc
235     PTRACERS_monitor_mnc = useMNC .AND. PTRACERS_monitor_mnc
236     PTRACERS_pickup_write_mnc = useMNC .AND. PTRACERS_pickup_write_mnc
237     PTRACERS_pickup_read_mnc = useMNC .AND. PTRACERS_pickup_read_mnc
238 edhill 1.20
239     PTRACERS_timeave_mdsio = (.NOT. PTRACERS_timeave_mnc)
240     & .OR. outputTypesInclusive
241     PTRACERS_snapshot_mdsio = (.NOT. PTRACERS_snapshot_mnc)
242     & .OR. outputTypesInclusive
243 mlosch 1.22 PTRACERS_monitor_stdio = (.NOT. PTRACERS_monitor_mnc)
244     & .OR. outputTypesInclusive
245 edhill 1.20 PTRACERS_pickup_write_mdsio = (.NOT. PTRACERS_pickup_write_mnc)
246     & .OR. outputTypesInclusive
247     PTRACERS_pickup_read_mdsio = (.NOT. PTRACERS_pickup_read_mnc)
248     & .OR. outputTypesInclusive
249     #else
250     PTRACERS_timeave_mnc = .FALSE.
251     PTRACERS_snapshot_mnc = .FALSE.
252 mlosch 1.22 PTRACERS_monitor_mnc = .FALSE.
253 edhill 1.20 PTRACERS_pickup_write_mnc = .FALSE.
254     PTRACERS_pickup_read_mnc = .FALSE.
255     PTRACERS_timeave_mdsio = .TRUE.
256     PTRACERS_snapshot_mdsio = .TRUE.
257 mlosch 1.22 PTRACERS_monitor_stdio = .TRUE.
258 edhill 1.20 PTRACERS_pickup_write_mdsio = .TRUE.
259     PTRACERS_pickup_read_mdsio = .TRUE.
260     #endif
261 jmc 1.24
262 jmc 1.12 C-- Print a summary of pTracer parameter values:
263     iUnit = standardMessageUnit
264     WRITE(msgBuf,'(A)') '// ==================================='
265 jmc 1.25 CALL PRINT_MESSAGE( msgBuf, iUnit, SQUEEZE_RIGHT , myThid )
266 jmc 1.12 WRITE(msgBuf,'(A)') '// PTRACERS parameters '
267 jmc 1.25 CALL PRINT_MESSAGE( msgBuf, iUnit, SQUEEZE_RIGHT , myThid )
268 jmc 1.12 WRITE(msgBuf,'(A)') '// ==================================='
269 jmc 1.25 CALL PRINT_MESSAGE( msgBuf, iUnit, SQUEEZE_RIGHT , myThid )
270 jmc 1.12 CALL WRITE_0D_I( PTRACERS_numInUse, INDEX_NONE,
271     & 'PTRACERS_numInUse =',
272     & ' /* number of tracers */')
273 jmc 1.19 CALL WRITE_0D_I( PTRACERS_Iter0, INDEX_NONE,
274     & 'PTRACERS_Iter0 =',
275     & ' /* timestep number when tracers are initialized */')
276 mlosch 1.14 CALL WRITE_0D_R8(PTRACERS_dumpFreq, INDEX_NONE,
277     & 'PTRACERS_dumpFreq =',
278     & ' /* Frequency^-1 for snapshot output (s) */')
279 jmc 1.12 CALL WRITE_0D_R8(PTRACERS_taveFreq, INDEX_NONE,
280     & 'PTRACERS_taveFreq =',
281     & ' /* Frequency^-1 for time-Aver. output (s) */')
282     CALL WRITE_0D_L( PTRACERS_useRecords, INDEX_NONE,
283     & 'PTRACERS_useRecords =', ' /* all tracers in 1 file */')
284 jmc 1.25
285 edhill 1.20 CALL WRITE_0D_L( PTRACERS_timeave_mnc, INDEX_NONE,
286     & 'PTRACERS_timeave_mnc =',
287     & ' /* use MNC for Tave output */')
288     CALL WRITE_0D_L( PTRACERS_snapshot_mnc, INDEX_NONE,
289     & 'PTRACERS_snapshot_mnc =',
290     & ' /* use MNC for snapshot output */')
291     CALL WRITE_0D_L( PTRACERS_pickup_write_mnc, INDEX_NONE,
292 jmc 1.25 & 'PTRACERS_pickup_write_mnc =',
293 edhill 1.20 & ' /* use MNC for writing pickups */')
294     CALL WRITE_0D_L( PTRACERS_pickup_read_mnc, INDEX_NONE,
295 jmc 1.25 & 'PTRACERS_pickup_read_mnc =',
296 edhill 1.20 & ' /* use MNC for reading pickups */')
297 jmc 1.12
298     DO iTracer=1,PTRACERS_numInUse
299     WRITE(msgBuf,'(A)') ' -----------------------------------'
300 jmc 1.25 CALL PRINT_MESSAGE( msgBuf, iUnit, SQUEEZE_RIGHT, myThid )
301 jmc 1.12 WRITE(msgBuf,'(A,I4)') ' tracer number : ',iTracer
302 jmc 1.25 CALL PRINT_MESSAGE( msgBuf, iUnit, SQUEEZE_RIGHT, myThid )
303 jmc 1.28 CALL WRITE_0D_C( PTRACERS_ioLabel(iTracer), 0, INDEX_NONE,
304     & 'PTRACERS_ioLabel =', ' /* tracer IO Label */')
305 jmc 1.12 CALL WRITE_0D_I( PTRACERS_advScheme(iTracer), INDEX_NONE,
306     & 'PTRACERS_advScheme =', ' /* Advection Scheme */')
307 jmc 1.15 CALL WRITE_0D_L( PTRACERS_ImplVertAdv(iTracer), INDEX_NONE,
308     & 'PTRACERS_ImplVertAdv =',
309     & ' /* implicit vert. advection flag */')
310 jmc 1.12 CALL WRITE_0D_R8( PTRACERS_diffKh(iTracer), INDEX_NONE,
311     & 'PTRACERS_diffKh =', ' /* Laplacian Diffusivity */')
312     CALL WRITE_0D_R8( PTRACERS_diffK4(iTracer), INDEX_NONE,
313     & 'PTRACERS_diffK4 =', ' /* Biharmonic Diffusivity */')
314     CALL WRITE_1D_R8( PTRACERS_diffKrNr(1,iTracer), Nr, INDEX_K,
315     & 'PTRACERS_diffKrNr =', ' /* Vertical Diffusivity */')
316     CALL WRITE_0D_L( PTRACERS_useGMRedi(iTracer), INDEX_NONE,
317     & 'PTRACERS_useGMRedi =', ' /* apply GM-Redi */')
318 jmc 1.31 CALL WRITE_0D_L( PTRACERS_useDWNSLP(iTracer), INDEX_NONE,
319     & 'PTRACERS_useDWNSLP =', ' /* apply DOWN-SLOPE Flow */')
320 jmc 1.12 CALL WRITE_0D_L( PTRACERS_useKPP(iTracer), INDEX_NONE,
321     & 'PTRACERS_useKPP =', ' /* apply KPP scheme */')
322 jmc 1.24 CALL WRITE_1D_R8( PTRACERS_ref(1,iTracer), Nr, INDEX_K,
323     & 'PTRACERS_ref =', ' /* Reference vertical profile */')
324     CALL WRITE_0D_R8( PTRACERS_EvPrRn(iTracer), INDEX_NONE,
325     & 'PTRACERS_EvPrRn =', '/* tracer conc. in Evap. & Rain */')
326 jmc 1.12
327     ENDDO
328     WRITE(msgBuf,'(A)') ' -----------------------------------'
329 jmc 1.25 CALL PRINT_MESSAGE( msgBuf, iUnit, SQUEEZE_RIGHT, myThid )
330    
331     _END_MASTER(myThid)
332     C Everyone else must wait for the parameters to be loaded
333     _BARRIER
334    
335 adcroft 1.1 #endif /* ALLOW_PTRACERS */
336    
337     RETURN
338     END
339 edhill 1.6

  ViewVC Help
Powered by ViewVC 1.1.22