/[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.64 - (hide annotations) (download)
Fri Jun 22 02:03:03 2012 UTC (11 years, 11 months ago) by gforget
Branch: MAIN
Changes since 1.63: +3 -9 lines
- add run-time switch usePROFILES.

1 gforget 1.64 C $Header: /u/gcmpack/MITgcm/model/src/config_check.F,v 1.63 2012/06/15 21:03:22 heimbach 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 heimbach 1.63 cc IF ( implicitDiffusion ) THEN
144     cc WRITE(msgBuf,'(2A)') 'CONFIG_CHECK: ',
145     cc & 'implicitDiffusion not available with DEPTH_CONTROL'
146     cc CALL PRINT_ERROR( msgBuf, myThid )
147     cc errCount = errCount + 1
148     cc ENDIF
149 jmc 1.58 IF ( useOBCS ) THEN
150     WRITE(msgBuf,'(A)')
151     & 'CONFIG_CHECK: DEPTH_CONTROL code not compatible with OBCS'
152     CALL PRINT_ERROR( msgBuf, myThid )
153 jmc 1.61 errCount = errCount + 1
154 jmc 1.58 ENDIF
155     #endif
156    
157 jmc 1.1 #ifndef EXACT_CONSERV
158 jmc 1.40 IF (exactConserv) THEN
159     WRITE(msgBuf,'(A)')
160 jmc 1.1 & 'CONFIG_CHECK: #undef EXACT_CONSERV and'
161 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
162 jmc 1.1 WRITE(msgBuf,'(A)')
163     & 'CONFIG_CHECK: exactConserv is TRUE'
164 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
165 jmc 1.61 errCount = errCount + 1
166 jmc 1.1 ENDIF
167     #endif
168    
169     #ifndef NONLIN_FRSURF
170 jmc 1.40 IF (nonlinFreeSurf.NE.0) THEN
171     WRITE(msgBuf,'(A)')
172 jmc 1.1 & 'CONFIG_CHECK: #undef NONLIN_FRSURF and'
173 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
174 jmc 1.1 WRITE(msgBuf,'(A)')
175     & 'CONFIG_CHECK: nonlinFreeSurf is non-zero'
176 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
177 jmc 1.61 errCount = errCount + 1
178 jmc 1.1 ENDIF
179     #endif
180    
181 jmc 1.9 #ifndef NONLIN_FRSURF
182     IF (select_rStar .NE. 0) THEN
183 jmc 1.40 WRITE(msgBuf,'(A)')
184 jmc 1.9 & 'CONFIG_CHECK: rStar is part of NonLin-FS '
185 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
186 jmc 1.9 WRITE(msgBuf,'(A)')
187 jmc 1.56 & 'CONFIG_CHECK: ==> set #define NONLIN_FRSURF to use it'
188 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
189 jmc 1.61 errCount = errCount + 1
190 jmc 1.9 ENDIF
191     #endif /* NONLIN_FRSURF */
192    
193 jmc 1.56 #ifdef DISABLE_RSTAR_CODE
194     IF ( select_rStar.NE.0 ) THEN
195     WRITE(msgBuf,'(A)')
196     & 'CONFIG_CHECK: rStar code disable (DISABLE_RSTAR_CODE defined)'
197     CALL PRINT_ERROR( msgBuf, myThid )
198     WRITE(msgBuf,'(A)')
199     & 'CONFIG_CHECK: ==> set #undef DISABLE_RSTAR_CODE to use it'
200     CALL PRINT_ERROR( msgBuf, myThid )
201 jmc 1.61 errCount = errCount + 1
202 jmc 1.56 ENDIF
203     #endif /* DISABLE_RSTAR_CODE */
204    
205     #ifdef DISABLE_SIGMA_CODE
206     IF ( selectSigmaCoord.NE.0 ) THEN
207     WRITE(msgBuf,'(A)')
208     & 'CONFIG_CHECK: Sigma code disable (DISABLE_SIGMA_CODE defined)'
209     CALL PRINT_ERROR( msgBuf, myThid )
210     WRITE(msgBuf,'(A)')
211     & 'CONFIG_CHECK: ==> set #undef DISABLE_SIGMA_CODE to use it'
212     CALL PRINT_ERROR( msgBuf, myThid )
213 jmc 1.61 errCount = errCount + 1
214 jmc 1.56 ENDIF
215     #endif /* DISABLE_SIGMA_CODE */
216    
217 jmc 1.1 #ifdef USE_NATURAL_BCS
218 jmc 1.40 WRITE(msgBuf,'(A)')
219 jmc 1.3 & 'CONFIG_CHECK: USE_NATURAL_BCS option has been replaced'
220 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
221 jmc 1.1 WRITE(msgBuf,'(A)')
222 jmc 1.3 & 'CONFIG_CHECK: by useRealFreshWaterFlux=TRUE in data file'
223 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
224 jmc 1.61 errCount = errCount + 1
225 jmc 1.3 #endif
226    
227 jmc 1.50 #ifndef ALLOW_ADDFLUID
228     IF ( selectAddFluid.NE.0 ) THEN
229     WRITE(msgBuf,'(A)')
230     & 'CONFIG_CHECK: #undef ALLOW_ADDFLUID and'
231     CALL PRINT_ERROR( msgBuf, myThid )
232     WRITE(msgBuf,'(A,I4,A)') 'CONFIG_CHECK: selectAddFluid=',
233     & selectAddFluid, ' is not zero'
234     CALL PRINT_ERROR( msgBuf, myThid )
235 jmc 1.61 errCount = errCount + 1
236 jmc 1.50 ENDIF
237     #endif /* ALLOW_ADDFLUID */
238    
239 jmc 1.4 C o If pLoadFile is set, then we should make sure the corresponing
240     C code is being compiled
241     #ifndef ATMOSPHERIC_LOADING
242     IF (pLoadFile.NE.' ') THEN
243     WRITE(msgBuf,'(A)')
244     & 'CONFIG_CHECK: pLoadFile is set but you have not'
245 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
246 jmc 1.4 WRITE(msgBuf,'(A)')
247     & 'compiled the model with the pressure loading code.'
248 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
249 jmc 1.15 WRITE(msgBuf,'(A)')
250     & 'Re-compile with: #define ATMOSPHERIC_LOADING'
251 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
252 jmc 1.61 errCount = errCount + 1
253 jmc 1.15 ENDIF
254     IF ( useRealFreshWaterFlux .AND. useThSIce ) THEN
255     WRITE(msgBuf,'(A)')
256     & 'CONFIG_CHECK: sIceLoad is computed but'
257 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
258 jmc 1.15 WRITE(msgBuf,'(A)')
259     & 'pressure loading code is not compiled.'
260 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
261 jmc 1.15 WRITE(msgBuf,'(A)')
262     & 'Re-compile with: #define ATMOSPHERIC_LOADING'
263 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
264 jmc 1.61 errCount = errCount + 1
265 jmc 1.4 ENDIF
266     #endif
267    
268 mlosch 1.31 #ifndef ALLOW_BALANCE_FLUXES
269     IF (balanceEmPmR .OR. balanceQnet) THEN
270     WRITE(msgBuf,'(A,A)')
271     & 'CONFIG_CHECK: balanceEmPmR/Qnet is set but balance code ',
272     & 'is not compiled.'
273 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
274 mlosch 1.31 WRITE(msgBuf,'(A)')
275     & 'Re-compile with ALLOW_BALANCE_FLUXES defined'
276 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
277 jmc 1.61 errCount = errCount + 1
278 mlosch 1.31 ENDIF
279     #endif
280    
281 mlosch 1.52 #ifndef ALLOW_SRCG
282     IF (useSRCGSolver) THEN
283     WRITE(msgBuf,'(A,A)')
284     & 'CONFIG_CHECK: useSRCGSolver = .TRUE., but single reduction ',
285     & 'code is not compiled.'
286 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
287 mlosch 1.52 WRITE(msgBuf,'(A)')
288     & 'CONFIG_CHECK: Re-compile with ALLOW_SRCG defined'
289 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
290 jmc 1.61 errCount = errCount + 1
291 mlosch 1.52 ENDIF
292     #endif /* ALLOW_SRCG */
293    
294 jmc 1.3 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
295    
296 jmc 1.48 C-- Check parameter consistency :
297 jmc 1.8
298 jmc 1.59 IF ( ( OLx.LT.3 .OR. OLy.LT.3 ) .AND.
299 jmc 1.28 & ( viscC4leithD.NE.0. .OR. viscC4leith.NE.0.
300     & .OR. viscC4smag.NE.0. .OR. viscA4Grid.NE.0.
301     & .OR. viscA4D.NE.0. .OR. viscA4Z.NE.0. ) ) THEN
302 jmc 1.8 WRITE(msgBuf,'(A,A)')
303     & 'CONFIG_CHECK: cannot use Biharmonic Visc. (viscA4) with',
304 jmc 1.59 & ' overlap (OLx,OLy) smaller than 3'
305 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
306 jmc 1.61 errCount = errCount + 1
307 jmc 1.33 ENDIF
308 jmc 1.59 IF ( ( OLx.LT.3 .OR. OLy.LT.3 ) .AND.
309 jmc 1.28 & ( viscC2leithD.NE.0. .OR. viscC4leithD.NE.0. )
310     & ) THEN
311     WRITE(msgBuf,'(A,A)')
312     & 'CONFIG_CHECK: cannot use Leith Visc.(div.part) with',
313 jmc 1.59 & ' overlap (OLx,OLy) smaller than 3'
314 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
315 jmc 1.61 errCount = errCount + 1
316 jmc 1.33 ENDIF
317 jmc 1.3
318 jmc 1.62 #ifndef DISCONNECTED_TILES
319     C Overlaps cannot be larger than interior tile except for special cases
320 mlosch 1.60 IF ( sNx.LT.OLx ) THEN
321     #ifdef ALLOW_EXCH2
322     WRITE(msgBuf,'(A)')
323     & 'CONFIG_CHECK: sNx<OLx not allowed with ALLOW_EXCH2 defined'
324     CALL PRINT_ERROR( msgBuf, myThid )
325 jmc 1.61 errCount = errCount + 1
326 mlosch 1.60 #endif /* ALLOW_EXCH2 */
327     IF ( Nx.NE.1 ) THEN
328     WRITE(msgBuf,'(A)')
329     & 'CONFIG_CHECK: sNx<OLx not allowed unless Nx=1'
330     CALL PRINT_ERROR( msgBuf, myThid )
331 jmc 1.61 errCount = errCount + 1
332 mlosch 1.60 ENDIF
333     ENDIF
334     IF ( sNy.LT.OLy ) THEN
335     #ifdef ALLOW_EXCH2
336     WRITE(msgBuf,'(A)')
337     & 'CONFIG_CHECK: sNy<OLy not allowed with ALLOW_EXCH2 defined'
338     CALL PRINT_ERROR( msgBuf, myThid )
339 jmc 1.61 errCount = errCount + 1
340 mlosch 1.60 #endif /* ALLOW_EXCH2 */
341     IF ( Ny.NE.1 ) THEN
342     WRITE(msgBuf,'(A)')
343     & 'CONFIG_CHECK: sNy<OLy not allowed unless Ny=1'
344     CALL PRINT_ERROR( msgBuf, myThid )
345 jmc 1.61 errCount = errCount + 1
346 mlosch 1.60 ENDIF
347     ENDIF
348 jmc 1.62 #endif /* ndef DISCONNECTED_TILES */
349 mlosch 1.60
350 jmc 1.48 C-- Deep-Atmosphere & Anelastic limitations:
351 jmc 1.40 IF ( deepAtmosphere .AND.
352     & useRealFreshWaterFlux .AND. usingPCoords ) THEN
353     WRITE(msgBuf,'(A,A)')
354     & 'CONFIG_CHECK: Deep-Atmosphere not yet implemented with',
355     & ' real-Fresh-Water option in P-coordinate'
356 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
357 jmc 1.61 errCount = errCount + 1
358 jmc 1.40 ENDIF
359     IF ( select_rStar.NE.0 .AND.
360     & ( deepAtmosphere .OR.
361     & usingZCoords.AND.rhoRefFile .NE. ' ' ) ) THEN
362     WRITE(msgBuf,'(A,A)')
363     & 'CONFIG_CHECK: Deep-Atmosphere or Anelastic',
364     & ' not yet implemented with rStar'
365 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
366 jmc 1.61 errCount = errCount + 1
367 jmc 1.40 ENDIF
368     IF ( vectorInvariantMomentum .AND.
369     & ( deepAtmosphere .OR.
370     & usingZCoords.AND.rhoRefFile .NE. ' ' ) ) THEN
371     WRITE(msgBuf,'(A,A)')
372     & 'CONFIG_CHECK: Deep-Atmosphere or Anelastic',
373     & ' not yet implemented in Vector-Invariant momentum code'
374 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
375 jmc 1.61 errCount = errCount + 1
376 jmc 1.40 ENDIF
377    
378 jmc 1.48 C-- Free-surface related limitations:
379 jmc 1.3 IF ( rigidLid .AND. implicitFreeSurface ) THEN
380     WRITE(msgBuf,'(A,A)')
381     & 'CONFIG_CHECK: Cannot select both implicitFreeSurface',
382     & ' and rigidLid.'
383 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
384 jmc 1.61 errCount = errCount + 1
385 jmc 1.33 ENDIF
386 jmc 1.3
387     IF (rigidLid .AND. exactConserv) THEN
388 jmc 1.40 WRITE(msgBuf,'(A)')
389 jmc 1.3 & 'CONFIG_CHECK: exactConserv not compatible with'
390 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
391 jmc 1.1 WRITE(msgBuf,'(A)')
392 jmc 1.3 & 'CONFIG_CHECK: rigidLid (meaningless in that case)'
393 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
394 jmc 1.61 errCount = errCount + 1
395 jmc 1.1 ENDIF
396    
397 dfer 1.41 IF ( linFSConserveTr .AND. nonlinFreeSurf.NE.0 ) THEN
398     WRITE(msgBuf,'(A)')
399     & 'CONFIG_CHECK: Cannot select both a Nonlinear Free Surf.'
400 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
401 dfer 1.41 WRITE(msgBuf,'(A)')
402     & 'CONFIG_CHECK: and Tracer Correction of Lin. Free Surf.'
403 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
404 jmc 1.61 errCount = errCount + 1
405 dfer 1.41 ENDIF
406    
407 jmc 1.3 IF (rigidLid .AND. useRealFreshWaterFlux) THEN
408 jmc 1.40 WRITE(msgBuf,'(A)')
409 jmc 1.3 & 'CONFIG_CHECK: useRealFreshWaterFlux not compatible with'
410 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
411 jmc 1.1 WRITE(msgBuf,'(A)')
412     & 'CONFIG_CHECK: rigidLid (meaningless in that case)'
413 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
414 jmc 1.61 errCount = errCount + 1
415 jmc 1.1 ENDIF
416    
417     IF (nonlinFreeSurf.NE.0 .AND. .NOT.exactConserv) THEN
418 jmc 1.40 WRITE(msgBuf,'(A)')
419 jmc 1.1 & 'CONFIG_CHECK: nonlinFreeSurf cannot be used'
420 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
421 jmc 1.1 WRITE(msgBuf,'(A)')
422     & 'CONFIG_CHECK: without exactConserv'
423 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
424 jmc 1.61 errCount = errCount + 1
425 jmc 1.1 ENDIF
426    
427 jmc 1.6 IF (select_rStar.NE.0 .AND. .NOT.exactConserv) THEN
428 jmc 1.40 WRITE(msgBuf,'(A)')
429 jmc 1.6 & 'CONFIG_CHECK: r* Coordinate cannot be used'
430 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
431 jmc 1.6 WRITE(msgBuf,'(A)')
432     & 'CONFIG_CHECK: without exactConserv'
433 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
434 jmc 1.61 errCount = errCount + 1
435 jmc 1.6 ENDIF
436    
437 jmc 1.56 IF ( selectSigmaCoord.NE.0 ) THEN
438     IF ( fluidIsWater ) THEN
439     WRITE(msgBuf,'(A)')
440     & 'CONFIG_CHECK: Sigma-Coords not yet coded for Oceanic set-up'
441     CALL PRINT_ERROR( msgBuf, myThid )
442 jmc 1.61 errCount = errCount + 1
443 jmc 1.56 ENDIF
444     IF ( nonlinFreeSurf.LE.0 ) THEN
445     WRITE(msgBuf,'(A)')
446     & 'CONFIG_CHECK: Sigma-Coords not coded for Lin-FreeSurf'
447     CALL PRINT_ERROR( msgBuf, myThid )
448 jmc 1.61 errCount = errCount + 1
449 jmc 1.56 ENDIF
450     IF (select_rStar.NE.0 ) THEN
451     WRITE(msgBuf,'(A)')
452     & 'CONFIG_CHECK: Sigma-Coords and rStar are not compatible'
453     CALL PRINT_ERROR( msgBuf, myThid )
454 jmc 1.61 errCount = errCount + 1
455 jmc 1.56 ENDIF
456     WRITE(msgBuf,'(A)')
457     & 'CONFIG_CHECK: Sigma-Coords code neither complete nor tested'
458     CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
459     & SQUEEZE_RIGHT, myThid )
460     ENDIF
461    
462 jmc 1.54 C- note : not implemented in checkpoint48b but it is done now (since 01-28-03)
463 jmc 1.7 c IF (select_rStar.GT.0 .AND. useOBCS ) THEN
464     c STOP 'ABNORMAL END: S/R CONFIG_CHECK'
465     c ENDIF
466 jmc 1.1
467 jmc 1.40 IF ( nonlinFreeSurf.NE.0 .AND.
468 jmc 1.18 & deltaTfreesurf.NE.dTtracerLev(1) ) THEN
469 jmc 1.53 WRITE(msgBuf,'(2A)') '** WARNING ** CONFIG_CHECK: ',
470     & 'nonlinFreeSurf might cause problems'
471 jmc 1.4 CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
472 jmc 1.53 & SQUEEZE_RIGHT, myThid )
473     WRITE(msgBuf,'(2A)') '** WARNING ** ',
474     & 'with different FreeSurf & Tracer time-steps'
475 jmc 1.4 CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
476 jmc 1.53 & SQUEEZE_RIGHT, myThid )
477 jmc 1.3 ENDIF
478    
479 jmc 1.15 IF ( useRealFreshWaterFlux .AND. exactConserv
480 jmc 1.50 & .AND. implicDiv2Dflow.EQ.0. _d 0
481 jmc 1.21 & .AND. startTime.NE.baseTime .AND. usePickupBeforeC54 ) THEN
482 jmc 1.40 WRITE(msgBuf,'(A)')
483 jmc 1.3 & 'CONFIG_CHECK: RealFreshWaterFlux+implicSurfP=0+exactConserv:'
484 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
485 jmc 1.3 WRITE(msgBuf,'(A)')
486     & 'CONFIG_CHECK: restart not implemented in this config'
487 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
488 jmc 1.61 errCount = errCount + 1
489 jmc 1.3 ENDIF
490    
491 jmc 1.40 IF ( useRealFreshWaterFlux .AND. .NOT.exactConserv
492 jmc 1.50 & .AND. implicDiv2Dflow.NE.1. ) THEN
493 jmc 1.53 WRITE(msgBuf,'(2A)') '** WARNING ** CONFIG_CHECK: ',
494 jmc 1.50 & 'RealFreshWater & implicDiv2Dflow < 1'
495 jmc 1.15 CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
496 jmc 1.53 & SQUEEZE_RIGHT, myThid )
497     WRITE(msgBuf,'(2A)') '** WARNING ** works better',
498 jmc 1.15 & ' with exactConserv=.T. (+ #define EXACT_CONSERV)'
499     CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
500 jmc 1.53 & SQUEEZE_RIGHT, myThid )
501 jmc 1.15 ENDIF
502    
503     #ifdef EXACT_CONSERV
504 jmc 1.4 IF (useRealFreshWaterFlux .AND. .NOT.exactConserv
505     & .AND. buoyancyRelation.EQ.'OCEANICP' ) THEN
506 jmc 1.40 WRITE(msgBuf,'(A)')
507 jmc 1.4 & 'CONFIG_CHECK: RealFreshWaterFlux with OCEANICP'
508 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
509 jmc 1.4 WRITE(msgBuf,'(A)')
510     & 'CONFIG_CHECK: requires exactConserv=T'
511 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
512 jmc 1.61 errCount = errCount + 1
513 jmc 1.4 ENDIF
514     #else
515     IF (useRealFreshWaterFlux
516     & .AND. buoyancyRelation.EQ.'OCEANICP' ) THEN
517 jmc 1.53 WRITE(msgBuf,'(2A)') '** WARNING ** CONFIG_CHECK: ',
518     & 'E-P effects on wVel are not included'
519 jmc 1.4 CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
520 jmc 1.53 & SQUEEZE_RIGHT, myThid )
521     WRITE(msgBuf,'(2A)') '** WARNING ** CONFIG_CHECK: ',
522     & '==> use #define EXACT_CONSERV to fix it'
523 jmc 1.5 CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
524 jmc 1.53 & SQUEEZE_RIGHT, myThid )
525 jmc 1.5 ENDIF
526 jmc 1.15 #endif /* EXACT_CONSERV */
527 jmc 1.5
528 jmc 1.50 IF ( selectAddFluid.LT.-1 .OR. selectAddFluid.GT.2 ) THEN
529     WRITE(msgBuf,'(A,I10,A)') 'CONFIG_CHECK: selectAddFluid=',
530     & selectAddFluid, ' not allowed'
531 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
532 jmc 1.50 WRITE(msgBuf,'(2A)') 'CONFIG_CHECK: ',
533     & 'should be =0 (Off), 1,2 (Add Mass) or -1 (Virtual Flux)'
534 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
535 jmc 1.61 errCount = errCount + 1
536 jmc 1.50 ENDIF
537     IF ( selectAddFluid.GE.1 .AND. rigidLid ) THEN
538     WRITE(msgBuf,'(A)')
539     & 'CONFIG_CHECK: selectAddFluid > 0 not compatible with'
540 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
541 jmc 1.50 WRITE(msgBuf,'(A)')
542     & 'CONFIG_CHECK: rigidLid (meaningless in that case)'
543 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
544 jmc 1.61 errCount = errCount + 1
545 jmc 1.50 ENDIF
546     IF ( selectAddFluid.GE.1 .AND. .NOT.staggerTimeStep ) THEN
547 jmc 1.53 WRITE(msgBuf,'(2A)') '** WARNING ** CONFIG_CHECK: ',
548     & 'synchronous time-stepping =>'
549 jmc 1.50 CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
550 jmc 1.53 & SQUEEZE_RIGHT, myThid )
551     WRITE(msgBuf,'(2A)') '** WARNING ** ',
552 jmc 1.50 & '1 time-step mismatch in AddFluid effects on T & S'
553     CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
554 jmc 1.53 & SQUEEZE_RIGHT, myThid )
555     ENDIF
556    
557     C-- Non-hydrostatic and 3-D solver related limitations:
558     IF (nonlinFreeSurf.NE.0 .AND. use3Dsolver) THEN
559     WRITE(msgBuf,'(A)')
560     & 'CONFIG_CHECK: nonlinFreeSurf not yet implemented'
561     CALL PRINT_ERROR( msgBuf, myThid )
562     WRITE(msgBuf,'(A)')
563     & 'CONFIG_CHECK: in nonHydrostatic code'
564     CALL PRINT_ERROR( msgBuf, myThid )
565 jmc 1.61 errCount = errCount + 1
566 jmc 1.53 ENDIF
567    
568     IF ( implicitNHPress*implicSurfPress*implicDiv2Dflow.NE.1.
569     & .AND. implicitIntGravWave ) THEN
570     WRITE(msgBuf,'(2A)') 'CONFIG_CHECK: implicitIntGravWave',
571     & ' NOT SAFE with non-fully implicit solver'
572     CALL PRINT_ERROR( msgBuf, myThid )
573     WRITE(msgBuf,'(2A)') 'CONFIG_CHECK: To by-pass this',
574     & 'STOP, comment this test and re-compile config_check'
575     CALL PRINT_ERROR( msgBuf, myThid )
576 jmc 1.61 errCount = errCount + 1
577 jmc 1.53 ENDIF
578     IF ( nonHydrostatic .AND. .NOT.exactConserv
579     & .AND. implicDiv2Dflow.NE.1. ) THEN
580     WRITE(msgBuf,'(2A)') 'CONFIG_CHECK: Needs exactConserv=T',
581     & ' for nonHydrostatic with implicDiv2Dflow < 1'
582     CALL PRINT_ERROR( msgBuf, myThid )
583 jmc 1.61 errCount = errCount + 1
584 jmc 1.53 ENDIF
585     IF ( nonHydrostatic .AND.
586     & implicitNHPress.NE.implicSurfPress ) THEN
587     WRITE(msgBuf,'(2A)') '** WARNING ** CONFIG_CHECK: ',
588     & ' nonHydrostatic might cause problems with'
589     CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
590     & SQUEEZE_RIGHT, myThid )
591     WRITE(msgBuf,'(2A)') '** WARNING ** CONFIG_CHECK: ',
592     & 'different implicitNHPress & implicSurfPress'
593     CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
594     & SQUEEZE_RIGHT, myThid )
595     ENDIF
596    
597     IF ( implicitViscosity .AND. use3Dsolver ) THEN
598     WRITE(msgBuf,'(2A)') '** WARNING ** CONFIG_CHECK: ',
599     & 'Implicit viscosity applies to provisional u,vVel'
600     CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
601     & SQUEEZE_RIGHT, myThid )
602     WRITE(msgBuf,'(2A)') '** WARNING ** => not consistent with',
603     & 'final vertical shear (after appling 3-D solver solution'
604     CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
605     & SQUEEZE_RIGHT, myThid )
606     ENDIF
607     IF ( implicitViscosity .AND. nonHydrostatic ) THEN
608     WRITE(msgBuf,'(2A)') '** WARNING ** CONFIG_CHECK: ',
609     & 'Implicit viscosity not implemented in CALC_GW'
610     CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
611     & SQUEEZE_RIGHT, myThid )
612     WRITE(msgBuf,'(2A)') '** WARNING ** CONFIG_CHECK: ',
613     & 'Explicit viscosity might become unstable if too large'
614     CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
615     & SQUEEZE_RIGHT, myThid )
616 jmc 1.50 ENDIF
617    
618 jmc 1.48 C-- Momentum related limitations:
619 jmc 1.47 IF ( vectorInvariantMomentum.AND.momStepping ) THEN
620     IF ( highOrderVorticity.AND.upwindVorticity ) THEN
621     WRITE(msgBuf,'(2A)') 'CONFIG_CHECK: ',
622     & '"highOrderVorticity" conflicts with "upwindVorticity"'
623 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
624 jmc 1.61 errCount = errCount + 1
625 jmc 1.47 ENDIF
626     ENDIF
627 jmc 1.57 IF ( selectCoriMap.LT.0 .OR. selectCoriMap.GT.3 ) THEN
628     WRITE(msgBuf,'(2A,I4)') 'CONFIG_CHECK: ',
629     & 'Invalid option: selectCoriMap=', selectCoriMap
630     CALL PRINT_ERROR( msgBuf, myThid )
631 jmc 1.61 errCount = errCount + 1
632 jmc 1.57 ENDIF
633 jmc 1.47
634 jmc 1.9 IF (.NOT.useCDscheme .AND. (tauCD.NE.0. .OR. rCD.NE.-1.) ) THEN
635 jmc 1.40 C- jmc: since useCDscheme is a new [04-13-03] flag (default=F),
636     C put this WARNING to stress that even if CD-scheme parameters
637     C (tauCD,rCD) are set, CD-scheme is not used without useCDscheme=T
638 jmc 1.9 C- and STOP if using mom_fluxform (following Chris advise).
639     C- jmc: but ultimately, this block can/will be removed.
640     IF (.NOT.vectorInvariantMomentum.AND.momStepping) THEN
641 jmc 1.40 WRITE(msgBuf,'(A)')
642 jmc 1.9 & 'CONFIG_CHECK: CD-scheme is OFF but params(tauCD,rCD) are set'
643 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
644 jmc 1.9 WRITE(msgBuf,'(2A)')
645     & 'CONFIG_CHECK: to turn ON CD-scheme: => "useCDscheme=.TRUE."',
646 jmc 1.40 & ' in "data", namelist PARM01'
647 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
648 jmc 1.61 errCount = errCount + 1
649 jmc 1.9 ENDIF
650 jmc 1.53 WRITE(msgBuf,'(2A)') '** WARNING ** CONFIG_CHECK: ',
651     & 'CD-scheme is OFF but params(tauCD,rCD) are set'
652 jmc 1.5 CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
653 jmc 1.53 & SQUEEZE_RIGHT, myThid )
654     WRITE(msgBuf,'(3A)') '** WARNING ** ',
655     & 'to turn ON CD-scheme: => "useCDscheme=.TRUE."',
656 jmc 1.40 & ' in "data", namelist PARM01'
657 jmc 1.53 WRITE(msgBuf,'(3A)') '** WARNING ** to turn ON CD-scheme:',
658     & ' => "useCDscheme=.TRUE." in "data", namelist PARM01'
659 jmc 1.4 CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
660 jmc 1.53 & SQUEEZE_RIGHT, myThid )
661 jmc 1.12 ENDIF
662    
663     IF ( useCDscheme .AND. useCubedSphereExchange ) THEN
664     WRITE(msgBuf,'(2A)')
665     & 'CONFIG_CHECK: CD-scheme not implemented on CubedSphere grid'
666 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
667 jmc 1.61 cph errCount = errCount + 1
668 jmc 1.12 ENDIF
669    
670 jmc 1.48 C-- Time-stepping limitations
671 jmc 1.40 IF ( momForcingOutAB.NE.0 .AND. momForcingOutAB.NE.1 ) THEN
672 jmc 1.34 WRITE(msgBuf,'(A,I10,A)') 'CONFIG_CHECK: momForcingOutAB=',
673     & momForcingOutAB, ' not allowed'
674 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
675 jmc 1.34 WRITE(msgBuf,'(2A)') 'CONFIG_CHECK: momForcingOutAB ',
676     & 'should be =1 (Out of AB) or =0 (In AB)'
677 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
678 jmc 1.61 errCount = errCount + 1
679 jmc 1.34 ENDIF
680 jmc 1.40 IF ( tracForcingOutAB.NE.0 .AND. tracForcingOutAB.NE.1 ) THEN
681 jmc 1.34 WRITE(msgBuf,'(A,I10,A)') 'CONFIG_CHECK: tracForcingOutAB=',
682     & tracForcingOutAB, ' not allowed'
683 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
684 jmc 1.34 WRITE(msgBuf,'(2A)') 'CONFIG_CHECK: tracForcingOutAB ',
685     & 'should be =1 (Out of AB) or =0 (In AB)'
686 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
687 jmc 1.61 errCount = errCount + 1
688 jmc 1.4 ENDIF
689 jmc 1.1
690 jmc 1.48 C-- Grid limitations:
691 mlosch 1.44 IF ( rotateGrid ) THEN
692     IF ( .NOT. usingSphericalPolarGrid ) THEN
693     WRITE(msgBuf,'(2A)')
694     & 'CONFIG_CHECK: specifying Euler angles makes only ',
695     & 'sense with usingSphericalGrid=.TRUE.'
696 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
697 jmc 1.61 errCount = errCount + 1
698 mlosch 1.44 ENDIF
699 gforget 1.64 IF ( useFLT .OR. useZonal_Filt .OR. useECCO .OR.
700     & usePROFILES ) THEN
701 mlosch 1.44 WRITE(msgBuf,'(2A)')
702     & 'CONFIG_CHECK: specifying Euler angles will probably ',
703     & 'not work with pkgs FLT, ZONAL_FLT, ECCO'
704 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
705 jmc 1.61 errCount = errCount + 1
706 mlosch 1.44 ENDIF
707     ENDIF
708    
709 jmc 1.48 C-- Packages conflict
710     IF ( useMATRIX .AND. useGCHEM ) THEN
711     WRITE(msgBuf,'(2A)')
712     & 'CONFIG_CHECK: cannot set both: useMATRIX & useGCHEM'
713 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
714 jmc 1.61 errCount = errCount + 1
715 jmc 1.48 ENDIF
716    
717     IF ( useMATRIX .AND. .NOT.usePTRACERS ) THEN
718     WRITE(msgBuf,'(2A)')
719     & 'CONFIG_CHECK: cannot set useMATRIX without ',
720     & 'setting usePTRACERS'
721 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
722 jmc 1.61 errCount = errCount + 1
723 jmc 1.48 ENDIF
724    
725 jmc 1.50 IF ( (useSEAICE .OR. useThSIce) .AND. allowFreezing ) THEN
726     WRITE(msgBuf,'(2A)')
727     & 'CONFIG_CHECK: cannot set allowFreezing',
728     & ' with pkgs SEAICE or THSICE'
729 jmc 1.53 CALL PRINT_ERROR( msgBuf, myThid )
730 jmc 1.61 errCount = errCount + 1
731     ENDIF
732    
733     IF ( errCount.GE.1 ) THEN
734     WRITE(msgBuf,'(A,I3,A)')
735     & 'CONFIG_CHECK: detected', errCount,' fatal error(s)'
736     CALL PRINT_ERROR( msgBuf, myThid )
737     CALL ALL_PROC_DIE( 0 )
738 jmc 1.50 STOP 'ABNORMAL END: S/R CONFIG_CHECK'
739     ENDIF
740 jmc 1.61 _END_MASTER(myThid)
741    
742     C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
743 jmc 1.50
744 jmc 1.61 _BEGIN_MASTER(myThid)
745 jmc 1.49 WRITE(msgBuf,'(A)')
746     &'// ======================================================='
747     CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
748     & SQUEEZE_RIGHT, myThid )
749     WRITE(msgBuf,'(A)') '// CONFIG_CHECK : Normal End'
750     CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
751     & SQUEEZE_RIGHT, myThid )
752     WRITE(msgBuf,'(A)')
753     &'// ======================================================='
754     CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
755     & SQUEEZE_RIGHT, myThid )
756     WRITE(msgBuf,'(A)') ' '
757     CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
758     & SQUEEZE_RIGHT, myThid )
759 jmc 1.61 _END_MASTER(myThid)
760 jmc 1.1
761     RETURN
762     END

  ViewVC Help
Powered by ViewVC 1.1.22