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