/[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.28 - (hide annotations) (download)
Sat Nov 10 22:09:32 2007 UTC (16 years, 7 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint59k
Changes since 1.27: +8 -1 lines
use a 2 characters string ioLabel to identify tracers (if more than 99 tracers)

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

  ViewVC Help
Powered by ViewVC 1.1.22