/[MITgcm]/MITgcm/model/src/config_check.F
ViewVC logotype

Annotation of /MITgcm/model/src/config_check.F

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

Revision 1.68 - (hide annotations) (download)
Mon Jul 9 19:20:17 2012 UTC (11 years, 11 months ago) by jmc
Branch: MAIN
Changes since 1.67: +1 -7 lines 
remove commented out stop (implicitDiffusion & ALLOW_DEPTH_CONTROL)
1 jmc 1.68 C $Header: /u/gcmpack/MITgcm/model/src/config_check.F,v 1.67 2012/07/07 16:31:46 jmc Exp $
2 jmc 1.1 C $Name: $
3    
4 edhill 1.10 #include "PACKAGES_CONFIG.h"
5 jmc 1.1 #include "CPP_OPTIONS.h"
6    
7     CBOP
8     C !ROUTINE: CONFIG_CHECK
9     C !INTERFACE:
10     SUBROUTINE CONFIG_CHECK( myThid )
11     C !DESCRIPTION: \bv
12     C *=========================================================*
13     C | SUBROUTINE CONFIG_CHECK
14     C | o Check model parameter settings.
15     C *=========================================================*
16     C | This routine help to prevent the use of parameters
17     C | that are not compatible with the model configuration.
18     C *=========================================================*
19 jmc 1.33 C \ev
20 jmc 1.1
21     C !USES:
22     IMPLICIT NONE
23     C === Global variables ===
24     #include "SIZE.h"
25     #include "EEPARAMS.h"
26     #include "PARAMS.h"
27     c #include "GRID.h"
28    
29     C !INPUT/OUTPUT PARAMETERS:
30     C === Routine arguments ===
31     C myThid - Number of this instances of CONFIG_CHECK
32     INTEGER myThid
33     CEndOfInterface
34    
35     C !LOCAL VARIABLES:
36     C == Local variables ==
37 jmc 1.53 C msgBuf :: Informational/error message buffer
38 jmc 1.1 CHARACTER*(MAX_LEN_MBUF) msgBuf
39 jmc 1.61 INTEGER errCount
40 jmc 1.1 CEOP
41    
42 jmc 1.61 C-- MPI + multi-threads: seems to be OK to let master-thread check & stop
43     C (as long as all procs finish cleanly by calling ALL_PROC_DIE)
44     _BEGIN_MASTER(myThid)
45     errCount = 0
46    
47 jmc 1.1 C- check that CPP option is "defined" when running-flag parameter is on:
48    
49 dimitri 1.43 C o If diffKrFile is set, then we should make sure the corresponing
50     C code is being compiled
51 jmc 1.50 #ifndef ALLOW_3D_DIFFKR
52 dimitri 1.43 IF (diffKrFile.NE.' ') THEN
53     WRITE(msgBuf,'(A)')
54     & 'CONFIG_CHECK: diffKrFile is set but never used.'
55 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
56 dimitri 1.43 WRITE(msgBuf,'(A)')
57     & 'Re-compile with: #define ALLOW_3D_DIFFKR'
58 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
59 jmc 1.61 errCount = errCount + 1
60 dimitri 1.43 ENDIF
61     #endif
62    
63 jmc 1.1 #ifndef ALLOW_NONHYDROSTATIC
64 jmc 1.40 IF (use3Dsolver) THEN
65     WRITE(msgBuf,'(A)')
66 jmc 1.1 & 'CONFIG_CHECK: #undef ALLOW_NONHYDROSTATIC and'
67 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
68 jmc 1.32 IF ( implicitIntGravWave ) WRITE(msgBuf,'(A)')
69     & 'CONFIG_CHECK: implicitIntGravWave is TRUE'
70     IF ( nonHydrostatic ) WRITE(msgBuf,'(A)')
71 jmc 1.1 & 'CONFIG_CHECK: nonHydrostatic is TRUE'
72 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
73 jmc 1.61 errCount = errCount + 1
74 jmc 1.1 ENDIF
75     #endif
76    
77 jmc 1.22 #ifndef ALLOW_ADAMSBASHFORTH_3
78     IF ( alph_AB.NE.UNSET_RL .OR. beta_AB.NE.UNSET_RL ) THEN
79     WRITE(msgBuf,'(2A)') 'CONFIG_CHECK: ',
80     & '#undef ALLOW_ADAMSBASHFORTH_3 but alph_AB,beta_AB'
81 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
82 jmc 1.22 WRITE(msgBuf,'(A,1P2E20.7)')
83     & 'CONFIG_CHECK: are set to:',alph_AB,beta_AB
84 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
85 jmc 1.61 errCount = errCount + 1
86 jmc 1.22 ENDIF
87     #endif
88    
89 jmc 1.13 #ifndef INCLUDE_IMPLVERTADV_CODE
90 jmc 1.40 IF ( momImplVertAdv ) THEN
91     WRITE(msgBuf,'(A)')
92 jmc 1.13 & 'CONFIG_CHECK: #undef INCLUDE_IMPLVERTADV_CODE'
93 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
94 jmc 1.13 WRITE(msgBuf,'(A)')
95     & 'CONFIG_CHECK: but momImplVertAdv is TRUE'
96 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
97 jmc 1.61 errCount = errCount + 1
98 jmc 1.13 ENDIF
99 jmc 1.40 IF ( tempImplVertAdv ) THEN
100     WRITE(msgBuf,'(A)')
101 jmc 1.13 & 'CONFIG_CHECK: #undef INCLUDE_IMPLVERTADV_CODE'
102 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
103 jmc 1.13 WRITE(msgBuf,'(A)')
104     & 'CONFIG_CHECK: but tempImplVertAdv is TRUE'
105 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
106 jmc 1.61 errCount = errCount + 1
107 jmc 1.13 ENDIF
108 jmc 1.40 IF ( saltImplVertAdv ) THEN
109     WRITE(msgBuf,'(A)')
110 jmc 1.13 & 'CONFIG_CHECK: #undef INCLUDE_IMPLVERTADV_CODE'
111 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
112 jmc 1.13 WRITE(msgBuf,'(A)')
113     & 'CONFIG_CHECK: but saltImplVertAdv is TRUE'
114 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
115 jmc 1.61 errCount = errCount + 1
116 jmc 1.13 ENDIF
117 jmc 1.19 IF ( dTtracerLev(1).NE.dTtracerLev(Nr) .AND. implicitDiffusion
118 jmc 1.40 & .AND. ( saltStepping .OR. tempStepping .OR. usePTRACERS )
119 jmc 1.19 & ) THEN
120 jmc 1.40 WRITE(msgBuf,'(A)')
121 jmc 1.19 & 'CONFIG_CHECK: #undef INCLUDE_IMPLVERTADV_CODE'
122 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
123 jmc 1.19 WRITE(msgBuf,'(2A)') 'CONFIG_CHECK: ',
124     & 'but implicitDiffusion=T with non-uniform dTtracerLev'
125 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
126 jmc 1.61 errCount = errCount + 1
127 jmc 1.19 ENDIF
128 jmc 1.13 #endif
129    
130 gforget 1.55 #ifdef ALLOW_AUTODIFF_TAMC
131     IF ( momImplVertAdv ) THEN
132     WRITE(msgBuf,'(A)')
133     & 'CONFIG_CHECK: momImplVertAdv is not yet'
134     CALL PRINT_ERROR( msgBuf, myThid )
135     WRITE(msgBuf,'(A)')
136     & 'CONFIG_CHECK: supported in adjoint mode'
137     CALL PRINT_ERROR( msgBuf, myThid )
138 jmc 1.61 errCount = errCount + 1
139 gforget 1.55 ENDIF
140     #endif
141    
142 jmc 1.58 #ifdef ALLOW_DEPTH_CONTROL
143     IF ( useOBCS ) THEN
144     WRITE(msgBuf,'(A)')
145     & 'CONFIG_CHECK: DEPTH_CONTROL code not compatible with OBCS'
146     CALL PRINT_ERROR( msgBuf, myThid )
147 jmc 1.61 errCount = errCount + 1
148 jmc 1.58 ENDIF
149     #endif
150    
151 jmc 1.1 #ifndef EXACT_CONSERV
152 jmc 1.40 IF (exactConserv) THEN
153     WRITE(msgBuf,'(A)')
154 jmc 1.1 & 'CONFIG_CHECK: #undef EXACT_CONSERV and'
155 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
156 jmc 1.1 WRITE(msgBuf,'(A)')
157     & 'CONFIG_CHECK: exactConserv is TRUE'
158 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
159 jmc 1.61 errCount = errCount + 1
160 jmc 1.1 ENDIF
161     #endif
162    
163     #ifndef NONLIN_FRSURF
164 jmc 1.40 IF (nonlinFreeSurf.NE.0) THEN
165     WRITE(msgBuf,'(A)')
166 jmc 1.1 & 'CONFIG_CHECK: #undef NONLIN_FRSURF and'
167 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
168 jmc 1.1 WRITE(msgBuf,'(A)')
169     & 'CONFIG_CHECK: nonlinFreeSurf is non-zero'
170 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
171 jmc 1.61 errCount = errCount + 1
172 jmc 1.1 ENDIF
173     #endif
174    
175 jmc 1.9 #ifndef NONLIN_FRSURF
176     IF (select_rStar .NE. 0) THEN
177 jmc 1.40 WRITE(msgBuf,'(A)')
178 jmc 1.9 & 'CONFIG_CHECK: rStar is part of NonLin-FS '
179 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
180 jmc 1.9 WRITE(msgBuf,'(A)')
181 jmc 1.56 & 'CONFIG_CHECK: ==> set #define NONLIN_FRSURF to use it'
182 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
183 jmc 1.61 errCount = errCount + 1
184 jmc 1.9 ENDIF
185     #endif /* NONLIN_FRSURF */
186    
187 jmc 1.56 #ifdef DISABLE_RSTAR_CODE
188     IF ( select_rStar.NE.0 ) THEN
189     WRITE(msgBuf,'(A)')
190     & 'CONFIG_CHECK: rStar code disable (DISABLE_RSTAR_CODE defined)'
191     CALL PRINT_ERROR( msgBuf, myThid )
192     WRITE(msgBuf,'(A)')
193     & 'CONFIG_CHECK: ==> set #undef DISABLE_RSTAR_CODE to use it'
194     CALL PRINT_ERROR( msgBuf, myThid )
195 jmc 1.61 errCount = errCount + 1
196 jmc 1.56 ENDIF
197     #endif /* DISABLE_RSTAR_CODE */
198    
199     #ifdef DISABLE_SIGMA_CODE
200     IF ( selectSigmaCoord.NE.0 ) THEN
201     WRITE(msgBuf,'(A)')
202     & 'CONFIG_CHECK: Sigma code disable (DISABLE_SIGMA_CODE defined)'
203     CALL PRINT_ERROR( msgBuf, myThid )
204     WRITE(msgBuf,'(A)')
205     & 'CONFIG_CHECK: ==> set #undef DISABLE_SIGMA_CODE to use it'
206     CALL PRINT_ERROR( msgBuf, myThid )
207 jmc 1.61 errCount = errCount + 1
208 jmc 1.56 ENDIF
209     #endif /* DISABLE_SIGMA_CODE */
210    
211 jmc 1.1 #ifdef USE_NATURAL_BCS
212 jmc 1.40 WRITE(msgBuf,'(A)')
213 jmc 1.3 & 'CONFIG_CHECK: USE_NATURAL_BCS option has been replaced'
214 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
215 jmc 1.1 WRITE(msgBuf,'(A)')
216 jmc 1.3 & 'CONFIG_CHECK: by useRealFreshWaterFlux=TRUE in data file'
217 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
218 jmc 1.61 errCount = errCount + 1
219 jmc 1.3 #endif
220    
221 jmc 1.50 #ifndef ALLOW_ADDFLUID
222     IF ( selectAddFluid.NE.0 ) THEN
223     WRITE(msgBuf,'(A)')
224     & 'CONFIG_CHECK: #undef ALLOW_ADDFLUID and'
225     CALL PRINT_ERROR( msgBuf, myThid )
226     WRITE(msgBuf,'(A,I4,A)') 'CONFIG_CHECK: selectAddFluid=',
227     & selectAddFluid, ' is not zero'
228     CALL PRINT_ERROR( msgBuf, myThid )
229 jmc 1.61 errCount = errCount + 1
230 jmc 1.50 ENDIF
231     #endif /* ALLOW_ADDFLUID */
232    
233 jmc 1.4 C o If pLoadFile is set, then we should make sure the corresponing
234     C code is being compiled
235     #ifndef ATMOSPHERIC_LOADING
236     IF (pLoadFile.NE.' ') THEN
237     WRITE(msgBuf,'(A)')
238     & 'CONFIG_CHECK: pLoadFile is set but you have not'
239 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
240 jmc 1.4 WRITE(msgBuf,'(A)')
241     & 'compiled the model with the pressure loading code.'
242 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
243 jmc 1.15 WRITE(msgBuf,'(A)')
244     & 'Re-compile with: #define ATMOSPHERIC_LOADING'
245 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
246 jmc 1.61 errCount = errCount + 1
247 jmc 1.15 ENDIF
248     IF ( useRealFreshWaterFlux .AND. useThSIce ) THEN
249     WRITE(msgBuf,'(A)')
250     & 'CONFIG_CHECK: sIceLoad is computed but'
251 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
252 jmc 1.15 WRITE(msgBuf,'(A)')
253     & 'pressure loading code is not compiled.'
254 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
255 jmc 1.15 WRITE(msgBuf,'(A)')
256     & 'Re-compile with: #define ATMOSPHERIC_LOADING'
257 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
258 jmc 1.61 errCount = errCount + 1
259 jmc 1.4 ENDIF
260     #endif
261    
262 mlosch 1.31 #ifndef ALLOW_BALANCE_FLUXES
263     IF (balanceEmPmR .OR. balanceQnet) THEN
264     WRITE(msgBuf,'(A,A)')
265     & 'CONFIG_CHECK: balanceEmPmR/Qnet is set but balance code ',
266     & 'is not compiled.'
267 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
268 mlosch 1.31 WRITE(msgBuf,'(A)')
269     & 'Re-compile with ALLOW_BALANCE_FLUXES defined'
270 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
271 jmc 1.61 errCount = errCount + 1
272 mlosch 1.31 ENDIF
273     #endif
274    
275 gforget 1.66 #ifndef ALLOW_BALANCE_RELAX
276     IF (balanceThetaClimRelax .OR. balanceSaltClimRelax) THEN
277     WRITE(msgBuf,'(A,A)')
278     & 'CONFIG_CHECK: balanceTheta/SaltClimRelax is set ',
279     & 'but balance code is not compiled.'
280     CALL PRINT_ERROR( msgBuf, myThid )
281     WRITE(msgBuf,'(A)')
282     & 'Re-compile with ALLOW_BALANCE_RELAX defined'
283     CALL PRINT_ERROR( msgBuf, myThid )
284     errCount = errCount + 1
285     ENDIF
286     #endif
287    
288 mlosch 1.52 #ifndef ALLOW_SRCG
289     IF (useSRCGSolver) THEN
290     WRITE(msgBuf,'(A,A)')
291     & 'CONFIG_CHECK: useSRCGSolver = .TRUE., but single reduction ',
292     & 'code is not compiled.'
293 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
294 mlosch 1.52 WRITE(msgBuf,'(A)')
295     & 'CONFIG_CHECK: Re-compile with ALLOW_SRCG defined'
296 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
297 jmc 1.61 errCount = errCount + 1
298 mlosch 1.52 ENDIF
299     #endif /* ALLOW_SRCG */
300    
301 jmc 1.3 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
302    
303 jmc 1.48 C-- Check parameter consistency :
304 jmc 1.8
305 jmc 1.59 IF ( ( OLx.LT.3 .OR. OLy.LT.3 ) .AND.
306 jmc 1.28 & ( viscC4leithD.NE.0. .OR. viscC4leith.NE.0.
307     & .OR. viscC4smag.NE.0. .OR. viscA4Grid.NE.0.
308     & .OR. viscA4D.NE.0. .OR. viscA4Z.NE.0. ) ) THEN
309 jmc 1.8 WRITE(msgBuf,'(A,A)')
310     & 'CONFIG_CHECK: cannot use Biharmonic Visc. (viscA4) with',
311 jmc 1.59 & ' overlap (OLx,OLy) smaller than 3'
312 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
313 jmc 1.61 errCount = errCount + 1
314 jmc 1.33 ENDIF
315 jmc 1.59 IF ( ( OLx.LT.3 .OR. OLy.LT.3 ) .AND.
316 jmc 1.28 & ( viscC2leithD.NE.0. .OR. viscC4leithD.NE.0. )
317     & ) THEN
318     WRITE(msgBuf,'(A,A)')
319     & 'CONFIG_CHECK: cannot use Leith Visc.(div.part) with',
320 jmc 1.59 & ' overlap (OLx,OLy) smaller than 3'
321 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
322 jmc 1.61 errCount = errCount + 1
323 jmc 1.33 ENDIF
324 jmc 1.3
325 jmc 1.62 #ifndef DISCONNECTED_TILES
326     C Overlaps cannot be larger than interior tile except for special cases
327 mlosch 1.60 IF ( sNx.LT.OLx ) THEN
328     #ifdef ALLOW_EXCH2
329     WRITE(msgBuf,'(A)')
330     & 'CONFIG_CHECK: sNx<OLx not allowed with ALLOW_EXCH2 defined'
331     CALL PRINT_ERROR( msgBuf, myThid )
332 jmc 1.61 errCount = errCount + 1
333 mlosch 1.60 #endif /* ALLOW_EXCH2 */
334     IF ( Nx.NE.1 ) THEN
335     WRITE(msgBuf,'(A)')
336     & 'CONFIG_CHECK: sNx<OLx not allowed unless Nx=1'
337     CALL PRINT_ERROR( msgBuf, myThid )
338 jmc 1.61 errCount = errCount + 1
339 mlosch 1.60 ENDIF
340     ENDIF
341     IF ( sNy.LT.OLy ) THEN
342     #ifdef ALLOW_EXCH2
343     WRITE(msgBuf,'(A)')
344     & 'CONFIG_CHECK: sNy<OLy not allowed with ALLOW_EXCH2 defined'
345     CALL PRINT_ERROR( msgBuf, myThid )
346 jmc 1.61 errCount = errCount + 1
347 mlosch 1.60 #endif /* ALLOW_EXCH2 */
348     IF ( Ny.NE.1 ) THEN
349     WRITE(msgBuf,'(A)')
350     & 'CONFIG_CHECK: sNy<OLy not allowed unless Ny=1'
351     CALL PRINT_ERROR( msgBuf, myThid )
352 jmc 1.61 errCount = errCount + 1
353 mlosch 1.60 ENDIF
354     ENDIF
355 jmc 1.62 #endif /* ndef DISCONNECTED_TILES */
356 mlosch 1.60
357 jmc 1.48 C-- Deep-Atmosphere & Anelastic limitations:
358 jmc 1.40 IF ( deepAtmosphere .AND.
359     & useRealFreshWaterFlux .AND. usingPCoords ) THEN
360     WRITE(msgBuf,'(A,A)')
361     & 'CONFIG_CHECK: Deep-Atmosphere not yet implemented with',
362     & ' real-Fresh-Water option in P-coordinate'
363 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
364 jmc 1.61 errCount = errCount + 1
365 jmc 1.40 ENDIF
366     IF ( select_rStar.NE.0 .AND.
367     & ( deepAtmosphere .OR.
368     & usingZCoords.AND.rhoRefFile .NE. ' ' ) ) THEN
369     WRITE(msgBuf,'(A,A)')
370     & 'CONFIG_CHECK: Deep-Atmosphere or Anelastic',
371     & ' not yet implemented with rStar'
372 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
373 jmc 1.61 errCount = errCount + 1
374 jmc 1.40 ENDIF
375     IF ( vectorInvariantMomentum .AND.
376     & ( deepAtmosphere .OR.
377     & usingZCoords.AND.rhoRefFile .NE. ' ' ) ) THEN
378     WRITE(msgBuf,'(A,A)')
379     & 'CONFIG_CHECK: Deep-Atmosphere or Anelastic',
380     & ' not yet implemented in Vector-Invariant momentum code'
381 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
382 jmc 1.61 errCount = errCount + 1
383 jmc 1.40 ENDIF
384    
385 jmc 1.48 C-- Free-surface related limitations:
386 jmc 1.3 IF ( rigidLid .AND. implicitFreeSurface ) THEN
387     WRITE(msgBuf,'(A,A)')
388     & 'CONFIG_CHECK: Cannot select both implicitFreeSurface',
389     & ' and rigidLid.'
390 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
391 jmc 1.61 errCount = errCount + 1
392 jmc 1.33 ENDIF
393 jmc 1.3
394     IF (rigidLid .AND. exactConserv) THEN
395 jmc 1.40 WRITE(msgBuf,'(A)')
396 jmc 1.3 & 'CONFIG_CHECK: exactConserv not compatible with'
397 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
398 jmc 1.1 WRITE(msgBuf,'(A)')
399 jmc 1.3 & 'CONFIG_CHECK: rigidLid (meaningless in that case)'
400 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
401 jmc 1.61 errCount = errCount + 1
402 jmc 1.1 ENDIF
403    
404 dfer 1.41 IF ( linFSConserveTr .AND. nonlinFreeSurf.NE.0 ) THEN
405     WRITE(msgBuf,'(A)')
406     & 'CONFIG_CHECK: Cannot select both a Nonlinear Free Surf.'
407 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
408 dfer 1.41 WRITE(msgBuf,'(A)')
409     & 'CONFIG_CHECK: and Tracer Correction of Lin. Free Surf.'
410 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
411 jmc 1.61 errCount = errCount + 1
412 dfer 1.41 ENDIF
413    
414 jmc 1.3 IF (rigidLid .AND. useRealFreshWaterFlux) THEN
415 jmc 1.40 WRITE(msgBuf,'(A)')
416 jmc 1.3 & 'CONFIG_CHECK: useRealFreshWaterFlux not compatible with'
417 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
418 jmc 1.1 WRITE(msgBuf,'(A)')
419     & 'CONFIG_CHECK: rigidLid (meaningless in that case)'
420 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
421 jmc 1.61 errCount = errCount + 1
422 jmc 1.1 ENDIF
423    
424     IF (nonlinFreeSurf.NE.0 .AND. .NOT.exactConserv) THEN
425 jmc 1.40 WRITE(msgBuf,'(A)')
426 jmc 1.1 & 'CONFIG_CHECK: nonlinFreeSurf cannot be used'
427 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
428 jmc 1.1 WRITE(msgBuf,'(A)')
429     & 'CONFIG_CHECK: without exactConserv'
430 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
431 jmc 1.61 errCount = errCount + 1
432 jmc 1.1 ENDIF
433    
434 jmc 1.6 IF (select_rStar.NE.0 .AND. .NOT.exactConserv) THEN
435 jmc 1.40 WRITE(msgBuf,'(A)')
436 jmc 1.6 & 'CONFIG_CHECK: r* Coordinate cannot be used'
437 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
438 jmc 1.6 WRITE(msgBuf,'(A)')
439     & 'CONFIG_CHECK: without exactConserv'
440 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
441 jmc 1.61 errCount = errCount + 1
442 jmc 1.6 ENDIF
443    
444 jmc 1.67 IF ( select_rStar.GE.1 .AND. nonlinFreeSurf.LE.0 ) THEN
445     WRITE(msgBuf,'(2A,I3,A)') 'CONFIG_CHECK: r* Coordinate',
446     & ' (select_rStar=', select_rStar, ' ) cannot be used'
447     CALL PRINT_ERROR( msgBuf, myThid )
448     WRITE(msgBuf,'(2A,I3,A)') 'CONFIG_CHECK: ',
449     & ' with Linear FreeSurf (nonlinFreeSurf=', nonlinFreeSurf,' )'
450     CALL PRINT_ERROR( msgBuf, myThid )
451     errCount = errCount + 1
452     ENDIF
453    
454 jmc 1.56 IF ( selectSigmaCoord.NE.0 ) THEN
455     IF ( fluidIsWater ) THEN
456     WRITE(msgBuf,'(A)')
457     & 'CONFIG_CHECK: Sigma-Coords not yet coded for Oceanic set-up'
458     CALL PRINT_ERROR( msgBuf, myThid )
459 jmc 1.61 errCount = errCount + 1
460 jmc 1.56 ENDIF
461     IF ( nonlinFreeSurf.LE.0 ) THEN
462     WRITE(msgBuf,'(A)')
463     & 'CONFIG_CHECK: Sigma-Coords not coded for Lin-FreeSurf'
464     CALL PRINT_ERROR( msgBuf, myThid )
465 jmc 1.61 errCount = errCount + 1
466 jmc 1.56 ENDIF
467     IF (select_rStar.NE.0 ) THEN
468     WRITE(msgBuf,'(A)')
469     & 'CONFIG_CHECK: Sigma-Coords and rStar are not compatible'
470     CALL PRINT_ERROR( msgBuf, myThid )
471 jmc 1.61 errCount = errCount + 1
472 jmc 1.56 ENDIF
473     WRITE(msgBuf,'(A)')
474     & 'CONFIG_CHECK: Sigma-Coords code neither complete nor tested'
475     CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
476     & SQUEEZE_RIGHT, myThid )
477     ENDIF
478    
479 jmc 1.54 C- note : not implemented in checkpoint48b but it is done now (since 01-28-03)
480 jmc 1.7 c IF (select_rStar.GT.0 .AND. useOBCS ) THEN
481     c STOP 'ABNORMAL END: S/R CONFIG_CHECK'
482     c ENDIF
483 jmc 1.1
484 jmc 1.40 IF ( nonlinFreeSurf.NE.0 .AND.
485 jmc 1.18 & deltaTfreesurf.NE.dTtracerLev(1) ) THEN
486 jmc 1.53 WRITE(msgBuf,'(2A)') '** WARNING ** CONFIG_CHECK: ',
487     & 'nonlinFreeSurf might cause problems'
488 jmc 1.4 CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
489 jmc 1.53 & SQUEEZE_RIGHT, myThid )
490     WRITE(msgBuf,'(2A)') '** WARNING ** ',
491     & 'with different FreeSurf & Tracer time-steps'
492 jmc 1.4 CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
493 jmc 1.53 & SQUEEZE_RIGHT, myThid )
494 jmc 1.3 ENDIF
495    
496 jmc 1.15 IF ( useRealFreshWaterFlux .AND. exactConserv
497 jmc 1.50 & .AND. implicDiv2Dflow.EQ.0. _d 0
498 jmc 1.21 & .AND. startTime.NE.baseTime .AND. usePickupBeforeC54 ) THEN
499 jmc 1.40 WRITE(msgBuf,'(A)')
500 jmc 1.3 & 'CONFIG_CHECK: RealFreshWaterFlux+implicSurfP=0+exactConserv:'
501 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
502 jmc 1.3 WRITE(msgBuf,'(A)')
503     & 'CONFIG_CHECK: restart not implemented in this config'
504 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
505 jmc 1.61 errCount = errCount + 1
506 jmc 1.3 ENDIF
507    
508 jmc 1.40 IF ( useRealFreshWaterFlux .AND. .NOT.exactConserv
509 jmc 1.50 & .AND. implicDiv2Dflow.NE.1. ) THEN
510 jmc 1.53 WRITE(msgBuf,'(2A)') '** WARNING ** CONFIG_CHECK: ',
511 jmc 1.50 & 'RealFreshWater & implicDiv2Dflow < 1'
512 jmc 1.15 CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
513 jmc 1.53 & SQUEEZE_RIGHT, myThid )
514     WRITE(msgBuf,'(2A)') '** WARNING ** works better',
515 jmc 1.15 & ' with exactConserv=.T. (+ #define EXACT_CONSERV)'
516     CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
517 jmc 1.53 & SQUEEZE_RIGHT, myThid )
518 jmc 1.15 ENDIF
519    
520     #ifdef EXACT_CONSERV
521 jmc 1.4 IF (useRealFreshWaterFlux .AND. .NOT.exactConserv
522     & .AND. buoyancyRelation.EQ.'OCEANICP' ) THEN
523 jmc 1.40 WRITE(msgBuf,'(A)')
524 jmc 1.4 & 'CONFIG_CHECK: RealFreshWaterFlux with OCEANICP'
525 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
526 jmc 1.4 WRITE(msgBuf,'(A)')
527     & 'CONFIG_CHECK: requires exactConserv=T'
528 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
529 jmc 1.61 errCount = errCount + 1
530 jmc 1.4 ENDIF
531     #else
532     IF (useRealFreshWaterFlux
533     & .AND. buoyancyRelation.EQ.'OCEANICP' ) THEN
534 jmc 1.53 WRITE(msgBuf,'(2A)') '** WARNING ** CONFIG_CHECK: ',
535     & 'E-P effects on wVel are not included'
536 jmc 1.4 CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
537 jmc 1.53 & SQUEEZE_RIGHT, myThid )
538     WRITE(msgBuf,'(2A)') '** WARNING ** CONFIG_CHECK: ',
539     & '==> use #define EXACT_CONSERV to fix it'
540 jmc 1.5 CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
541 jmc 1.53 & SQUEEZE_RIGHT, myThid )
542 jmc 1.5 ENDIF
543 jmc 1.15 #endif /* EXACT_CONSERV */
544 jmc 1.5
545 jmc 1.50 IF ( selectAddFluid.LT.-1 .OR. selectAddFluid.GT.2 ) THEN
546     WRITE(msgBuf,'(A,I10,A)') 'CONFIG_CHECK: selectAddFluid=',
547     & selectAddFluid, ' not allowed'
548 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
549 jmc 1.50 WRITE(msgBuf,'(2A)') 'CONFIG_CHECK: ',
550     & 'should be =0 (Off), 1,2 (Add Mass) or -1 (Virtual Flux)'
551 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
552 jmc 1.61 errCount = errCount + 1
553 jmc 1.50 ENDIF
554     IF ( selectAddFluid.GE.1 .AND. rigidLid ) THEN
555     WRITE(msgBuf,'(A)')
556     & 'CONFIG_CHECK: selectAddFluid > 0 not compatible with'
557 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
558 jmc 1.50 WRITE(msgBuf,'(A)')
559     & 'CONFIG_CHECK: rigidLid (meaningless in that case)'
560 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
561 jmc 1.61 errCount = errCount + 1
562 jmc 1.50 ENDIF
563     IF ( selectAddFluid.GE.1 .AND. .NOT.staggerTimeStep ) THEN
564 jmc 1.53 WRITE(msgBuf,'(2A)') '** WARNING ** CONFIG_CHECK: ',
565     & 'synchronous time-stepping =>'
566 jmc 1.50 CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
567 jmc 1.53 & SQUEEZE_RIGHT, myThid )
568     WRITE(msgBuf,'(2A)') '** WARNING ** ',
569 jmc 1.50 & '1 time-step mismatch in AddFluid effects on T & S'
570     CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
571 jmc 1.53 & SQUEEZE_RIGHT, myThid )
572     ENDIF
573    
574     C-- Non-hydrostatic and 3-D solver related limitations:
575     IF (nonlinFreeSurf.NE.0 .AND. use3Dsolver) THEN
576     WRITE(msgBuf,'(A)')
577     & 'CONFIG_CHECK: nonlinFreeSurf not yet implemented'
578     CALL PRINT_ERROR( msgBuf, myThid )
579     WRITE(msgBuf,'(A)')
580     & 'CONFIG_CHECK: in nonHydrostatic code'
581     CALL PRINT_ERROR( msgBuf, myThid )
582 jmc 1.61 errCount = errCount + 1
583 jmc 1.53 ENDIF
584    
585     IF ( implicitNHPress*implicSurfPress*implicDiv2Dflow.NE.1.
586     & .AND. implicitIntGravWave ) THEN
587     WRITE(msgBuf,'(2A)') 'CONFIG_CHECK: implicitIntGravWave',
588     & ' NOT SAFE with non-fully implicit solver'
589     CALL PRINT_ERROR( msgBuf, myThid )
590     WRITE(msgBuf,'(2A)') 'CONFIG_CHECK: To by-pass this',
591     & 'STOP, comment this test and re-compile config_check'
592     CALL PRINT_ERROR( msgBuf, myThid )
593 jmc 1.61 errCount = errCount + 1
594 jmc 1.53 ENDIF
595     IF ( nonHydrostatic .AND. .NOT.exactConserv
596     & .AND. implicDiv2Dflow.NE.1. ) THEN
597     WRITE(msgBuf,'(2A)') 'CONFIG_CHECK: Needs exactConserv=T',
598     & ' for nonHydrostatic with implicDiv2Dflow < 1'
599     CALL PRINT_ERROR( msgBuf, myThid )
600 jmc 1.61 errCount = errCount + 1
601 jmc 1.53 ENDIF
602     IF ( nonHydrostatic .AND.
603     & implicitNHPress.NE.implicSurfPress ) THEN
604     WRITE(msgBuf,'(2A)') '** WARNING ** CONFIG_CHECK: ',
605     & ' nonHydrostatic might cause problems with'
606     CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
607     & SQUEEZE_RIGHT, myThid )
608     WRITE(msgBuf,'(2A)') '** WARNING ** CONFIG_CHECK: ',
609     & 'different implicitNHPress & implicSurfPress'
610     CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
611     & SQUEEZE_RIGHT, myThid )
612     ENDIF
613    
614     IF ( implicitViscosity .AND. use3Dsolver ) THEN
615     WRITE(msgBuf,'(2A)') '** WARNING ** CONFIG_CHECK: ',
616     & 'Implicit viscosity applies to provisional u,vVel'
617     CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
618     & SQUEEZE_RIGHT, myThid )
619     WRITE(msgBuf,'(2A)') '** WARNING ** => not consistent with',
620     & 'final vertical shear (after appling 3-D solver solution'
621     CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
622     & SQUEEZE_RIGHT, myThid )
623     ENDIF
624     IF ( implicitViscosity .AND. nonHydrostatic ) THEN
625     WRITE(msgBuf,'(2A)') '** WARNING ** CONFIG_CHECK: ',
626     & 'Implicit viscosity not implemented in CALC_GW'
627     CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
628     & SQUEEZE_RIGHT, myThid )
629     WRITE(msgBuf,'(2A)') '** WARNING ** CONFIG_CHECK: ',
630     & 'Explicit viscosity might become unstable if too large'
631     CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
632     & SQUEEZE_RIGHT, myThid )
633 jmc 1.50 ENDIF
634    
635 jmc 1.48 C-- Momentum related limitations:
636 jmc 1.47 IF ( vectorInvariantMomentum.AND.momStepping ) THEN
637     IF ( highOrderVorticity.AND.upwindVorticity ) THEN
638     WRITE(msgBuf,'(2A)') 'CONFIG_CHECK: ',
639     & '"highOrderVorticity" conflicts with "upwindVorticity"'
640 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
641 jmc 1.61 errCount = errCount + 1
642 jmc 1.47 ENDIF
643     ENDIF
644 jmc 1.57 IF ( selectCoriMap.LT.0 .OR. selectCoriMap.GT.3 ) THEN
645     WRITE(msgBuf,'(2A,I4)') 'CONFIG_CHECK: ',
646     & 'Invalid option: selectCoriMap=', selectCoriMap
647     CALL PRINT_ERROR( msgBuf, myThid )
648 jmc 1.61 errCount = errCount + 1
649 jmc 1.57 ENDIF
650 jmc 1.47
651 jmc 1.9 IF (.NOT.useCDscheme .AND. (tauCD.NE.0. .OR. rCD.NE.-1.) ) THEN
652 jmc 1.40 C- jmc: since useCDscheme is a new [04-13-03] flag (default=F),
653     C put this WARNING to stress that even if CD-scheme parameters
654     C (tauCD,rCD) are set, CD-scheme is not used without useCDscheme=T
655 jmc 1.9 C- and STOP if using mom_fluxform (following Chris advise).
656     C- jmc: but ultimately, this block can/will be removed.
657     IF (.NOT.vectorInvariantMomentum.AND.momStepping) THEN
658 jmc 1.40 WRITE(msgBuf,'(A)')
659 jmc 1.9 & 'CONFIG_CHECK: CD-scheme is OFF but params(tauCD,rCD) are set'
660 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
661 jmc 1.9 WRITE(msgBuf,'(2A)')
662     & 'CONFIG_CHECK: to turn ON CD-scheme: => "useCDscheme=.TRUE."',
663 jmc 1.40 & ' in "data", namelist PARM01'
664 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
665 jmc 1.61 errCount = errCount + 1
666 jmc 1.9 ENDIF
667 jmc 1.53 WRITE(msgBuf,'(2A)') '** WARNING ** CONFIG_CHECK: ',
668     & 'CD-scheme is OFF but params(tauCD,rCD) are set'
669 jmc 1.5 CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
670 jmc 1.53 & SQUEEZE_RIGHT, myThid )
671     WRITE(msgBuf,'(3A)') '** WARNING ** ',
672     & 'to turn ON CD-scheme: => "useCDscheme=.TRUE."',
673 jmc 1.40 & ' in "data", namelist PARM01'
674 jmc 1.53 WRITE(msgBuf,'(3A)') '** WARNING ** to turn ON CD-scheme:',
675     & ' => "useCDscheme=.TRUE." in "data", namelist PARM01'
676 jmc 1.4 CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
677 jmc 1.53 & SQUEEZE_RIGHT, myThid )
678 jmc 1.12 ENDIF
679    
680     IF ( useCDscheme .AND. useCubedSphereExchange ) THEN
681     WRITE(msgBuf,'(2A)')
682     & 'CONFIG_CHECK: CD-scheme not implemented on CubedSphere grid'
683 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
684 jmc 1.61 cph errCount = errCount + 1
685 jmc 1.12 ENDIF
686    
687 jmc 1.48 C-- Time-stepping limitations
688 jmc 1.40 IF ( momForcingOutAB.NE.0 .AND. momForcingOutAB.NE.1 ) THEN
689 jmc 1.34 WRITE(msgBuf,'(A,I10,A)') 'CONFIG_CHECK: momForcingOutAB=',
690     & momForcingOutAB, ' not allowed'
691 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
692 jmc 1.34 WRITE(msgBuf,'(2A)') 'CONFIG_CHECK: momForcingOutAB ',
693     & 'should be =1 (Out of AB) or =0 (In AB)'
694 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
695 jmc 1.61 errCount = errCount + 1
696 jmc 1.34 ENDIF
697 jmc 1.40 IF ( tracForcingOutAB.NE.0 .AND. tracForcingOutAB.NE.1 ) THEN
698 jmc 1.34 WRITE(msgBuf,'(A,I10,A)') 'CONFIG_CHECK: tracForcingOutAB=',
699     & tracForcingOutAB, ' not allowed'
700 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
701 jmc 1.34 WRITE(msgBuf,'(2A)') 'CONFIG_CHECK: tracForcingOutAB ',
702     & 'should be =1 (Out of AB) or =0 (In AB)'
703 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
704 jmc 1.61 errCount = errCount + 1
705 jmc 1.4 ENDIF
706 jmc 1.1
707 jmc 1.48 C-- Grid limitations:
708 mlosch 1.44 IF ( rotateGrid ) THEN
709     IF ( .NOT. usingSphericalPolarGrid ) THEN
710     WRITE(msgBuf,'(2A)')
711     & 'CONFIG_CHECK: specifying Euler angles makes only ',
712     & 'sense with usingSphericalGrid=.TRUE.'
713 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
714 jmc 1.61 errCount = errCount + 1
715 mlosch 1.44 ENDIF
716 gforget 1.65 IF ( useFLT .OR. useZonal_Filt .OR. useECCO ) THEN
717 mlosch 1.44 WRITE(msgBuf,'(2A)')
718     & 'CONFIG_CHECK: specifying Euler angles will probably ',
719     & 'not work with pkgs FLT, ZONAL_FLT, ECCO'
720 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
721 jmc 1.61 errCount = errCount + 1
722 mlosch 1.44 ENDIF
723     ENDIF
724    
725 jmc 1.48 C-- Packages conflict
726     IF ( useMATRIX .AND. useGCHEM ) THEN
727     WRITE(msgBuf,'(2A)')
728     & 'CONFIG_CHECK: cannot set both: useMATRIX & useGCHEM'
729 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
730 jmc 1.61 errCount = errCount + 1
731 jmc 1.48 ENDIF
732    
733     IF ( useMATRIX .AND. .NOT.usePTRACERS ) THEN
734     WRITE(msgBuf,'(2A)')
735     & 'CONFIG_CHECK: cannot set useMATRIX without ',
736     & 'setting usePTRACERS'
737 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
738 jmc 1.61 errCount = errCount + 1
739 jmc 1.48 ENDIF
740    
741 jmc 1.50 IF ( (useSEAICE .OR. useThSIce) .AND. allowFreezing ) THEN
742     WRITE(msgBuf,'(2A)')
743     & 'CONFIG_CHECK: cannot set allowFreezing',
744     & ' with pkgs SEAICE or THSICE'
745 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
746 jmc 1.61 errCount = errCount + 1
747     ENDIF
748    
749     IF ( errCount.GE.1 ) THEN
750     WRITE(msgBuf,'(A,I3,A)')
751     & 'CONFIG_CHECK: detected', errCount,' fatal error(s)'
752     CALL PRINT_ERROR( msgBuf, myThid )
753     CALL ALL_PROC_DIE( 0 )
754 jmc 1.50 STOP 'ABNORMAL END: S/R CONFIG_CHECK'
755     ENDIF
756 jmc 1.61 _END_MASTER(myThid)
757    
758     C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
759 jmc 1.50
760 jmc 1.61 _BEGIN_MASTER(myThid)
761 jmc 1.49 WRITE(msgBuf,'(A)')
762     &'// ======================================================='
763     CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
764     & SQUEEZE_RIGHT, myThid )
765     WRITE(msgBuf,'(A)') '// CONFIG_CHECK : Normal End'
766     CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
767     & SQUEEZE_RIGHT, myThid )
768     WRITE(msgBuf,'(A)')
769     &'// ======================================================='
770     CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
771     & SQUEEZE_RIGHT, myThid )
772     WRITE(msgBuf,'(A)') ' '
773     CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
774     & SQUEEZE_RIGHT, myThid )
775 jmc 1.61 _END_MASTER(myThid)
776 jmc 1.1
777     RETURN
778     END
  ViewVC Help
Powered by ViewVC 1.1.22