/[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.17 - (hide annotations) (download)
Tue Nov 2 01:02:25 2004 UTC (19 years, 7 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint56b_post, checkpoint56, checkpoint55j_post, checkpoint56a_post, checkpoint56c_post
Changes since 1.16: +4 -2 lines
update: size of overlap when using biharmonic viscosity

1 jmc 1.17 C $Header: /u/gcmpack/MITgcm/model/src/config_check.F,v 1.16 2004/10/14 13:44:54 edhill 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     C \ev
20    
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     C msgBuf :: Informational/error meesage buffer
38     CHARACTER*(MAX_LEN_MBUF) msgBuf
39     CEOP
40    
41     C- check that CPP option is "defined" when running-flag parameter is on:
42    
43 edhill 1.16 #ifndef ALLOW_MNC
44     IF (useMNC) THEN
45     WRITE(msgBuf,'(2A)') '**WARNNING** ',
46     & 'CONFIG_CHECK: useMNC is TRUE and #undef ALLOW_MNC'
47     CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
48     & SQUEEZE_RIGHT , myThid)
49     ENDIF
50     #endif
51    
52 edhill 1.11 #ifndef ALLOW_CD_CODE
53 jmc 1.9 IF (useCDscheme) THEN
54 adcroft 1.14 WRITE(msgBuf,'(A)')
55     & 'CONFIG_CHECK: useCDscheme is TRUE and #undef ALLOW_CD_CODE'
56 jmc 1.9 CALL PRINT_ERROR( msgBuf , myThid)
57 adcroft 1.14 STOP 'ABNORMAL END: S/R CONFIG_CHECK'
58     ENDIF
59     IF (tauCD.NE.0.) THEN
60 jmc 1.9 WRITE(msgBuf,'(A)')
61 adcroft 1.14 & 'CONFIG_CHECK: tauCD has been set but the cd_code package is',
62     & ' enabled'
63 jmc 1.9 CALL PRINT_ERROR( msgBuf , myThid)
64     STOP 'ABNORMAL END: S/R CONFIG_CHECK'
65     ENDIF
66     #endif
67    
68 jmc 1.1 #ifndef ALLOW_NONHYDROSTATIC
69     IF (nonHydrostatic) THEN
70     WRITE(msgBuf,'(A)')
71     & 'CONFIG_CHECK: #undef ALLOW_NONHYDROSTATIC and'
72 jmc 1.3 CALL PRINT_ERROR( msgBuf , myThid)
73 jmc 1.1 WRITE(msgBuf,'(A)')
74     & 'CONFIG_CHECK: nonHydrostatic is TRUE'
75 jmc 1.3 CALL PRINT_ERROR( msgBuf , myThid)
76 jmc 1.1 STOP 'ABNORMAL END: S/R CONFIG_CHECK'
77     ENDIF
78     #endif
79    
80 jmc 1.13 #ifndef INCLUDE_IMPLVERTADV_CODE
81     IF ( momImplVertAdv ) THEN
82     WRITE(msgBuf,'(A)')
83     & 'CONFIG_CHECK: #undef INCLUDE_IMPLVERTADV_CODE'
84     CALL PRINT_ERROR( msgBuf , myThid)
85     WRITE(msgBuf,'(A)')
86     & 'CONFIG_CHECK: but momImplVertAdv is TRUE'
87     CALL PRINT_ERROR( msgBuf , myThid)
88     STOP 'ABNORMAL END: S/R CONFIG_CHECK'
89     ENDIF
90     IF ( tempImplVertAdv ) THEN
91     WRITE(msgBuf,'(A)')
92     & 'CONFIG_CHECK: #undef INCLUDE_IMPLVERTADV_CODE'
93     CALL PRINT_ERROR( msgBuf , myThid)
94     WRITE(msgBuf,'(A)')
95     & 'CONFIG_CHECK: but tempImplVertAdv is TRUE'
96     CALL PRINT_ERROR( msgBuf , myThid)
97     STOP 'ABNORMAL END: S/R CONFIG_CHECK'
98     ENDIF
99     IF ( saltImplVertAdv ) THEN
100     WRITE(msgBuf,'(A)')
101     & 'CONFIG_CHECK: #undef INCLUDE_IMPLVERTADV_CODE'
102     CALL PRINT_ERROR( msgBuf , myThid)
103     WRITE(msgBuf,'(A)')
104     & 'CONFIG_CHECK: but saltImplVertAdv is TRUE'
105     CALL PRINT_ERROR( msgBuf , myThid)
106     STOP 'ABNORMAL END: S/R CONFIG_CHECK'
107     ENDIF
108     #endif
109    
110 jmc 1.1 #ifndef EXACT_CONSERV
111     IF (exactConserv) THEN
112     WRITE(msgBuf,'(A)')
113     & 'CONFIG_CHECK: #undef EXACT_CONSERV and'
114 jmc 1.3 CALL PRINT_ERROR( msgBuf , myThid)
115 jmc 1.1 WRITE(msgBuf,'(A)')
116     & 'CONFIG_CHECK: exactConserv is TRUE'
117 jmc 1.3 CALL PRINT_ERROR( msgBuf , myThid)
118 jmc 1.1 STOP 'ABNORMAL END: S/R CONFIG_CHECK'
119     ENDIF
120     #endif
121    
122     #ifndef NONLIN_FRSURF
123     IF (nonlinFreeSurf.NE.0) THEN
124     WRITE(msgBuf,'(A)')
125     & 'CONFIG_CHECK: #undef NONLIN_FRSURF and'
126 jmc 1.3 CALL PRINT_ERROR( msgBuf , myThid)
127 jmc 1.1 WRITE(msgBuf,'(A)')
128     & 'CONFIG_CHECK: nonlinFreeSurf is non-zero'
129 jmc 1.3 CALL PRINT_ERROR( msgBuf , myThid)
130 jmc 1.1 STOP 'ABNORMAL END: S/R CONFIG_CHECK'
131     ENDIF
132     #endif
133    
134 jmc 1.9 #ifndef NONLIN_FRSURF
135     IF (select_rStar .NE. 0) THEN
136     WRITE(msgBuf,'(A)')
137     & 'CONFIG_CHECK: rStar is part of NonLin-FS '
138     CALL PRINT_ERROR( msgBuf, myThid)
139     WRITE(msgBuf,'(A)')
140     & 'CONFIG_CHECK: ==> use #define NONLIN_FRSURF to use it'
141     CALL PRINT_ERROR( msgBuf, myThid)
142     STOP 'ABNORMAL END: S/R CONFIG_CHECK'
143     ENDIF
144     #endif /* NONLIN_FRSURF */
145    
146 jmc 1.1 #ifdef USE_NATURAL_BCS
147     WRITE(msgBuf,'(A)')
148 jmc 1.3 & 'CONFIG_CHECK: USE_NATURAL_BCS option has been replaced'
149     CALL PRINT_ERROR( msgBuf , myThid)
150 jmc 1.1 WRITE(msgBuf,'(A)')
151 jmc 1.3 & 'CONFIG_CHECK: by useRealFreshWaterFlux=TRUE in data file'
152     CALL PRINT_ERROR( msgBuf , myThid)
153 jmc 1.1 STOP 'ABNORMAL END: S/R CONFIG_CHECK'
154 jmc 1.3 #endif
155    
156 jmc 1.4 C o If pLoadFile is set, then we should make sure the corresponing
157     C code is being compiled
158     #ifndef ATMOSPHERIC_LOADING
159     IF (pLoadFile.NE.' ') THEN
160     WRITE(msgBuf,'(A)')
161     & 'CONFIG_CHECK: pLoadFile is set but you have not'
162     CALL PRINT_ERROR( msgBuf , myThid)
163     WRITE(msgBuf,'(A)')
164     & 'compiled the model with the pressure loading code.'
165     CALL PRINT_ERROR( msgBuf , myThid)
166 jmc 1.15 WRITE(msgBuf,'(A)')
167     & 'Re-compile with: #define ATMOSPHERIC_LOADING'
168     CALL PRINT_ERROR( msgBuf , myThid)
169     STOP 'ABNORMAL END: S/R CONFIG_CHECK'
170     ENDIF
171     IF ( useRealFreshWaterFlux .AND. useThSIce ) THEN
172     WRITE(msgBuf,'(A)')
173     & 'CONFIG_CHECK: sIceLoad is computed but'
174     CALL PRINT_ERROR( msgBuf , myThid)
175     WRITE(msgBuf,'(A)')
176     & 'pressure loading code is not compiled.'
177     CALL PRINT_ERROR( msgBuf , myThid)
178     WRITE(msgBuf,'(A)')
179     & 'Re-compile with: #define ATMOSPHERIC_LOADING'
180 jmc 1.4 CALL PRINT_ERROR( msgBuf , myThid)
181     STOP 'ABNORMAL END: S/R CONFIG_CHECK'
182     ENDIF
183     #endif
184    
185     C o If taveFreq is finite, then we must make sure the diagnostics
186     C code is being compiled
187     #ifndef ALLOW_TIMEAVE
188     IF (taveFreq.NE.0.) THEN
189     WRITE(msgBuf,'(A)')
190 jmc 1.15 & 'CONFIG_CHECK: taveFreq <> 0 but pkg/timeave is not compiled'
191 jmc 1.4 CALL PRINT_ERROR( msgBuf , 1)
192     WRITE(msgBuf,'(A)')
193 jmc 1.15 & 'Re-compile with pkg "timeave" in packages.conf'
194 jmc 1.4 CALL PRINT_ERROR( msgBuf , 1)
195     STOP 'ABNORMAL END: S/R CONFIG_CHECK'
196     ENDIF
197     #endif
198    
199 jmc 1.3 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
200    
201     C- check parameter consistency :
202 jmc 1.8
203 jmc 1.17 IF ( ( Olx.LT.3 .OR. Oly.LT.3 ) .AND.
204     & ( viscC4leith.NE.0. .OR. viscA4Grid.NE.0.
205     & .OR. viscA4D.NE.0. .OR. viscA4Z.NE.0. ) ) THEN
206 jmc 1.8 WRITE(msgBuf,'(A,A)')
207     & 'CONFIG_CHECK: cannot use Biharmonic Visc. (viscA4) with',
208     & ' overlap (Olx,Oly) smaller than 3'
209     CALL PRINT_ERROR( msgBuf , myThid)
210     STOP 'ABNORMAL END: S/R CONFIG_CHECK'
211     ENDIF
212 jmc 1.3
213     IF ( rigidLid .AND. implicitFreeSurface ) THEN
214     WRITE(msgBuf,'(A,A)')
215     & 'CONFIG_CHECK: Cannot select both implicitFreeSurface',
216     & ' and rigidLid.'
217     CALL PRINT_ERROR( msgBuf , myThid)
218     STOP 'ABNORMAL END: S/R CONFIG_CHECK'
219     ENDIF
220    
221     IF (rigidLid .AND. exactConserv) THEN
222 jmc 1.1 WRITE(msgBuf,'(A)')
223 jmc 1.3 & 'CONFIG_CHECK: exactConserv not compatible with'
224     CALL PRINT_ERROR( msgBuf , myThid)
225 jmc 1.1 WRITE(msgBuf,'(A)')
226 jmc 1.3 & 'CONFIG_CHECK: rigidLid (meaningless in that case)'
227     CALL PRINT_ERROR( msgBuf , myThid)
228 jmc 1.1 STOP 'ABNORMAL END: S/R CONFIG_CHECK'
229     ENDIF
230    
231 jmc 1.3 IF (rigidLid .AND. useRealFreshWaterFlux) THEN
232 jmc 1.1 WRITE(msgBuf,'(A)')
233 jmc 1.3 & 'CONFIG_CHECK: useRealFreshWaterFlux not compatible with'
234     CALL PRINT_ERROR( msgBuf , myThid)
235 jmc 1.1 WRITE(msgBuf,'(A)')
236     & 'CONFIG_CHECK: rigidLid (meaningless in that case)'
237 jmc 1.3 CALL PRINT_ERROR( msgBuf , myThid)
238     STOP 'ABNORMAL END: S/R CONFIG_CHECK'
239     ENDIF
240    
241     IF ( (implicSurfPress.NE.1. .OR. implicDiv2DFlow.NE.1.)
242     & .AND. nonHydrostatic ) THEN
243     WRITE(msgBuf,'(A,A)') 'CONFIG_CHECK: nonHydrostatic',
244     & ' NOT SAFE with non-fully implicit Barotropic solver'
245     CALL PRINT_ERROR( msgBuf , myThid)
246     WRITE(msgBuf,'(A,A)') 'CONFIG_CHECK: To by-pass this',
247     & 'STOP, comment this test and re-compile config_check'
248     CALL PRINT_ERROR( msgBuf , myThid)
249 jmc 1.1 STOP 'ABNORMAL END: S/R CONFIG_CHECK'
250     ENDIF
251    
252     IF (nonlinFreeSurf.NE.0 .AND. .NOT.exactConserv) THEN
253     WRITE(msgBuf,'(A)')
254     & 'CONFIG_CHECK: nonlinFreeSurf cannot be used'
255 jmc 1.3 CALL PRINT_ERROR( msgBuf , myThid)
256 jmc 1.1 WRITE(msgBuf,'(A)')
257     & 'CONFIG_CHECK: without exactConserv'
258 jmc 1.3 CALL PRINT_ERROR( msgBuf , myThid)
259 jmc 1.1 STOP 'ABNORMAL END: S/R CONFIG_CHECK'
260     ENDIF
261    
262 jmc 1.6 IF (select_rStar.NE.0 .AND. .NOT.exactConserv) THEN
263     WRITE(msgBuf,'(A)')
264     & 'CONFIG_CHECK: r* Coordinate cannot be used'
265     CALL PRINT_ERROR( msgBuf , myThid)
266     WRITE(msgBuf,'(A)')
267     & 'CONFIG_CHECK: without exactConserv'
268     CALL PRINT_ERROR( msgBuf , myThid)
269     STOP 'ABNORMAL END: S/R CONFIG_CHECK'
270     ENDIF
271    
272 jmc 1.7 C- note : not implemented in checkpoint48b but it's done now (since 01-28-03)
273     c IF (select_rStar.GT.0 .AND. useOBCS ) THEN
274     c WRITE(msgBuf,'(A)')
275     c & 'CONFIG_CHECK: r* Coordinate not yet implemented'
276     c CALL PRINT_ERROR( msgBuf , 1)
277     c WRITE(msgBuf,'(A)')
278     c & 'CONFIG_CHECK: in OBC package'
279     c CALL PRINT_ERROR( msgBuf , 1)
280     c STOP 'ABNORMAL END: S/R CONFIG_CHECK'
281     c ENDIF
282 jmc 1.1
283     IF (nonlinFreeSurf.NE.0 .AND. nonHydrostatic) THEN
284     WRITE(msgBuf,'(A)')
285     & 'CONFIG_CHECK: nonlinFreeSurf not yet implemented'
286 jmc 1.3 CALL PRINT_ERROR( msgBuf , myThid)
287 jmc 1.1 WRITE(msgBuf,'(A)')
288     & 'CONFIG_CHECK: in nonHydrostatic code'
289 jmc 1.3 CALL PRINT_ERROR( msgBuf , myThid)
290 jmc 1.1 STOP 'ABNORMAL END: S/R CONFIG_CHECK'
291     ENDIF
292 jmc 1.3
293 jmc 1.4 IF (nonlinFreeSurf.NE.0.AND.deltaTfreesurf.NE.deltaTtracer) THEN
294 jmc 1.3 WRITE(msgBuf,'(A)')
295 jmc 1.4 & 'CONFIG_CHECK: WARNING: nonlinFreeSurf might cause problems'
296     CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
297     & SQUEEZE_RIGHT , myThid)
298     WRITE(msgBuf,'(A)')
299     & 'CONFIG_CHECK: with different FreeSurf & Tracer time-steps'
300     CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
301     & SQUEEZE_RIGHT , myThid)
302 jmc 1.3 ENDIF
303    
304 jmc 1.15 IF ( useRealFreshWaterFlux .AND. exactConserv
305     & .AND. implicDiv2DFlow.EQ.0. _d 0
306     & .AND. startTime.NE.0. .AND. usePickupBeforeC54 ) THEN
307 jmc 1.3 WRITE(msgBuf,'(A)')
308     & 'CONFIG_CHECK: RealFreshWaterFlux+implicSurfP=0+exactConserv:'
309     CALL PRINT_ERROR( msgBuf , myThid)
310     WRITE(msgBuf,'(A)')
311     & 'CONFIG_CHECK: restart not implemented in this config'
312     CALL PRINT_ERROR( msgBuf , myThid)
313     STOP 'ABNORMAL END: S/R CONFIG_CHECK'
314     ENDIF
315    
316 jmc 1.15 IF ( useRealFreshWaterFlux .AND. .NOT.exactConserv
317     & .AND. implicDiv2DFlow.NE.1. ) THEN
318     WRITE(msgBuf,'(2A)') 'CONFIG_CHECK: **WARNNING** ',
319     & 'RealFreshWater & implicDiv2DFlow < 1'
320     CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
321     & SQUEEZE_RIGHT , myThid)
322     WRITE(msgBuf,'(2A)') 'CONFIG_CHECK: works better',
323     & ' with exactConserv=.T. (+ #define EXACT_CONSERV)'
324     CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
325     & SQUEEZE_RIGHT , myThid)
326     ENDIF
327    
328     #ifdef EXACT_CONSERV
329 jmc 1.4 IF (useRealFreshWaterFlux .AND. .NOT.exactConserv
330     & .AND. buoyancyRelation.EQ.'OCEANICP' ) THEN
331     WRITE(msgBuf,'(A)')
332     & 'CONFIG_CHECK: RealFreshWaterFlux with OCEANICP'
333     CALL PRINT_ERROR( msgBuf , myThid)
334     WRITE(msgBuf,'(A)')
335     & 'CONFIG_CHECK: requires exactConserv=T'
336     CALL PRINT_ERROR( msgBuf , myThid)
337     STOP 'ABNORMAL END: S/R CONFIG_CHECK'
338     ENDIF
339     #else
340     IF (useRealFreshWaterFlux
341     & .AND. buoyancyRelation.EQ.'OCEANICP' ) THEN
342     WRITE(msgBuf,'(A)')
343     & 'CONFIG_CHECK: E-P effects on wVel are not included'
344     CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
345     & SQUEEZE_RIGHT , myThid)
346     WRITE(msgBuf,'(A)')
347 jmc 1.15 & 'CONFIG_CHECK: ==> use #define EXACT_CONSERV to fix it'
348 jmc 1.5 CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
349     & SQUEEZE_RIGHT , myThid)
350     ENDIF
351 jmc 1.15 #endif /* EXACT_CONSERV */
352 jmc 1.5
353 jmc 1.9 IF (.NOT.useCDscheme .AND. (tauCD.NE.0. .OR. rCD.NE.-1.) ) THEN
354     C- jmc: since useCDscheme is a new [04-13-03] flag (default=F),
355     C put this WARNING to stress that even if CD-scheme parameters
356     C (tauCD,rCD) are set, CD-scheme is not used without useCDscheme=T
357     C- and STOP if using mom_fluxform (following Chris advise).
358     C- jmc: but ultimately, this block can/will be removed.
359     IF (.NOT.vectorInvariantMomentum.AND.momStepping) THEN
360     WRITE(msgBuf,'(A)')
361     & 'CONFIG_CHECK: CD-scheme is OFF but params(tauCD,rCD) are set'
362     CALL PRINT_ERROR( msgBuf , myThid)
363     WRITE(msgBuf,'(2A)')
364     & 'CONFIG_CHECK: to turn ON CD-scheme: => "useCDscheme=.TRUE."',
365     & ' in "data", namelist PARM01'
366     CALL PRINT_ERROR( msgBuf , myThid)
367     STOP 'ABNORMAL END: S/R CONFIG_CHECK'
368     ENDIF
369     WRITE(msgBuf,'(2A)') '**WARNNING** ',
370     & 'CONFIG_CHECK: CD-scheme is OFF but params(tauCD,rCD) are set'
371 jmc 1.5 CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
372     & SQUEEZE_RIGHT , myThid)
373 jmc 1.9 WRITE(msgBuf,'(2A)')
374     & 'CONFIG_CHECK: to turn ON CD-scheme: => "useCDscheme=.TRUE."',
375     & ' in "data", namelist PARM01'
376 jmc 1.4 CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
377     & SQUEEZE_RIGHT , myThid)
378 jmc 1.12 ENDIF
379    
380     IF ( useCDscheme .AND. useCubedSphereExchange ) THEN
381     WRITE(msgBuf,'(2A)')
382     & 'CONFIG_CHECK: CD-scheme not implemented on CubedSphere grid'
383     CALL PRINT_ERROR( msgBuf , myThid)
384     STOP 'ABNORMAL END: S/R CONFIG_CHECK'
385     ENDIF
386    
387     IF ( useOldFreezing .AND. allowFreezing ) THEN
388     WRITE(msgBuf,'(2A)')
389     & 'CONFIG_CHECK: cannot set both: allowFreezing & useOldFreezing'
390     CALL PRINT_ERROR( msgBuf , myThid)
391     STOP 'ABNORMAL END: S/R CONFIG_CHECK'
392 jmc 1.4 ENDIF
393 jmc 1.1
394     WRITE(msgBuf,'(A)') 'CONFIG_CHECK: OK'
395     CALL PRINT_MESSAGE(msgBuf,standardMessageUnit,
396     & SQUEEZE_RIGHT,myThid)
397    
398     RETURN
399     END

  ViewVC Help
Powered by ViewVC 1.1.22