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

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

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


Revision 1.56 - (hide annotations) (download)
Sat Feb 4 01:43:40 2012 UTC (12 years, 3 months ago) by heimbach
Branch: MAIN
CVS Tags: checkpoint63j
Changes since 1.55: +8 -2 lines
Breaking three rules (at least):
1. No check-ins Friday after 5:30pm
2. No check-ins after two beers
3. Forgot the third one

1 heimbach 1.56 C $Header: /u/gcmpack/MITgcm/model/src/packages_check.F,v 1.55 2011/08/07 07:08:15 dimitri Exp $
2 adcroft 1.6 C $Name: $
3 adcroft 1.1
4 edhill 1.16 #include "PACKAGES_CONFIG.h"
5 adcroft 1.1 #include "CPP_OPTIONS.h"
6    
7 cnh 1.9 CBOP
8     C !ROUTINE: PACKAGES_CHECK
9     C !INTERFACE:
10 heimbach 1.2 SUBROUTINE PACKAGES_CHECK( myThid )
11 cnh 1.9 C !DESCRIPTION: \bv
12     C *==========================================================*
13 jmc 1.39 C | SUBROUTINE PACKAGES_CHECK
14     C | o Check runtime activated packages have been built in.
15 cnh 1.9 C *==========================================================*
16 jmc 1.39 C | All packages can be selected/deselected at build time
17     C | ( when code is compiled ) and activated/deactivated at
18     C | runtime. This routine does a quick check to trap packages
19     C | that were activated at runtime but that were not compiled
20     C | in at build time.
21 cnh 1.9 C *==========================================================*
22     C \ev
23    
24     C !USES:
25 adcroft 1.1 IMPLICIT NONE
26     C === Global variables ===
27     #include "SIZE.h"
28     #include "EEPARAMS.h"
29     #include "PARAMS.h"
30    
31 cnh 1.9 C !INPUT/OUTPUT PARAMETERS:
32 adcroft 1.1 C === Routine arguments ===
33 cnh 1.9 C myThid :: Number of this instances
34 adcroft 1.1 INTEGER myThid
35    
36 cnh 1.9 C !LOCAL VARIABLES:
37 adcroft 1.1 C === Local variables ===
38 jmc 1.47 C msgBuf :: Informational/error message buffer
39 jmc 1.39 CHARACTER*(MAX_LEN_MBUF) msgBuf
40 cnh 1.9 CEOP
41 adcroft 1.1
42 jmc 1.43 WRITE(msgBuf,'(A)')
43     &'== Packages configuration : Check & print summary =='
44     CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
45     & SQUEEZE_RIGHT, myThid )
46     WRITE(msgBuf,'(A)') ' '
47     CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
48     & SQUEEZE_RIGHT, myThid )
49    
50 jmc 1.39 C--- Start with non-standard packages (without or with non standard flag)
51    
52     #ifndef ALLOW_MNC
53     IF (useMNC) THEN
54     WRITE(msgBuf,'(2A)') '***WARNING***',
55     & ' PACKAGES_CHECK: useMNC is TRUE'
56     CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
57     & SQUEEZE_RIGHT , myThid)
58     WRITE(msgBuf,'(2A)') '***WARNING***',
59     & ' but pkg/mnc has not been compiled (#undef ALLOW_MNC)'
60     CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
61     & SQUEEZE_RIGHT , myThid)
62     ENDIF
63     #endif
64    
65     #ifndef ALLOW_MOM_VECINV
66     IF ( momStepping .AND. vectorInvariantMomentum ) THEN
67     WRITE(msgBuf,'(2A)')
68     & 'PACKAGES_CHECK: cannot step forward Momentum',
69     & ' without pkg/mom_vecinv'
70 jmc 1.41 CALL PRINT_ERROR( msgBuf , myThid )
71 jmc 1.39 WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
72     & 'Re-compile with pkg "mom_vecinv" in packages.conf'
73 jmc 1.41 CALL PRINT_ERROR( msgBuf , myThid )
74 jmc 1.39 STOP 'ABNORMAL END: S/R PACKAGES_CHECK'
75     ENDIF
76     #endif
77     #ifndef ALLOW_MOM_FLUXFORM
78     IF ( momStepping .AND. .NOT.vectorInvariantMomentum ) THEN
79     WRITE(msgBuf,'(2A)')
80     & 'PACKAGES_CHECK: cannot step forward Momentum',
81     & ' without pkg/mom_fluxform'
82 jmc 1.41 CALL PRINT_ERROR( msgBuf , myThid )
83 jmc 1.39 WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
84     & 'Re-compile with pkg "mom_fluxform" in packages.conf'
85 jmc 1.41 CALL PRINT_ERROR( msgBuf , myThid )
86 jmc 1.39 STOP 'ABNORMAL END: S/R PACKAGES_CHECK'
87     ENDIF
88     #endif
89    
90 jmc 1.51 #ifndef ALLOW_GENERIC_ADVDIFF
91 jmc 1.39 IF ( tempStepping .OR. saltStepping ) THEN
92     WRITE(msgBuf,'(2A)')
93     & 'PACKAGES_CHECK: cannot step forward Temp or Salt',
94     & ' without pkg/generic_advdiff'
95 jmc 1.41 CALL PRINT_ERROR( msgBuf , myThid )
96 jmc 1.39 WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
97     & 'Re-compile with pkg "generic_advdiff" in packages.conf'
98 jmc 1.41 CALL PRINT_ERROR( msgBuf , myThid )
99 jmc 1.39 STOP 'ABNORMAL END: S/R PACKAGES_CHECK'
100     ENDIF
101     #endif
102    
103     #ifndef ALLOW_MONITOR
104     C If monitorFreq is finite, make sure the pkg/monitor is being compiled
105 jmc 1.41 IF (monitorFreq.NE.0.) CALL PACKAGES_ERROR_MSG(
106     & 'MONITOR', 'monitorFreq <> 0', myThid )
107 jmc 1.39 #endif
108    
109     #ifndef ALLOW_TIMEAVE
110     C If taveFreq is finite, make sure the pkg/timeave is being compiled
111 jmc 1.41 IF (taveFreq.NE.0.) CALL PACKAGES_ERROR_MSG(
112     & 'TIMEAVE', 'taveFreq <> 0', myThid )
113     #endif
114    
115     #ifndef ALLOW_CD_CODE
116 heimbach 1.56 IF (useCDscheme) CALL PACKAGES_ERROR_MSG(
117 jmc 1.41 & 'CD_CODE', 'useCDscheme=.T.', myThid )
118 jmc 1.39 #endif
119    
120     C--- Continue with standard packages (with standard usePKG flag)
121    
122 adcroft 1.28 #ifdef ALLOW_RUNCLOCK
123     IF (useRunClock) CALL RUNCLOCK_CHECK( myThid )
124     #else
125 jmc 1.41 IF (useRunClock) CALL PACKAGES_ERROR_MSG('RunClock',' ',myThid)
126 adcroft 1.28 #endif
127    
128 heimbach 1.3 #ifdef ALLOW_KPP
129     IF (useKPP) CALL KPP_CHECK( myThid )
130 adcroft 1.1 #else
131 jmc 1.41 IF (useKPP) CALL PACKAGES_ERROR_MSG('KPP',' ',myThid)
132 adcroft 1.1 #endif
133    
134 mlosch 1.22 #ifdef ALLOW_PP81
135     IF (usePP81) CALL PP81_CHECK( myThid )
136     #else
137 jmc 1.41 IF (usePP81) CALL PACKAGES_ERROR_MSG('PP81',' ',myThid)
138 mlosch 1.22 #endif
139    
140     #ifdef ALLOW_MY82
141     IF (useMY82) CALL MY82_CHECK( myThid )
142     #else
143 jmc 1.41 IF (useMY82) CALL PACKAGES_ERROR_MSG('MY82',' ',myThid)
144 mlosch 1.22 #endif
145    
146 mlosch 1.23 #ifdef ALLOW_GGL90
147     IF (useGGL90) CALL GGL90_CHECK( myThid )
148     #else
149 jmc 1.41 IF (useGGL90) CALL PACKAGES_ERROR_MSG('GGL90',' ',myThid)
150 mlosch 1.23 #endif
151    
152     #ifdef ALLOW_OPPS
153     IF (useOPPS) CALL OPPS_CHECK( myThid )
154     #else
155 jmc 1.41 IF (useOPPS) CALL PACKAGES_ERROR_MSG('OPPS',' ',myThid)
156 mlosch 1.23 #endif
157    
158 heimbach 1.3 #ifdef ALLOW_GMREDI
159     IF (useGMRedi) CALL GMREDI_CHECK( myThid )
160     #else
161 jmc 1.41 IF (useGMRedi) CALL PACKAGES_ERROR_MSG('GMRedi',' ',myThid)
162 adcroft 1.1 #endif
163    
164 jmc 1.44 #ifndef ALLOW_DOWN_SLOPE
165     IF (useDOWN_SLOPE)
166     & CALL PACKAGES_ERROR_MSG('DOWN_SLOPE',' ',myThid)
167     #endif
168    
169 dimitri 1.55 #ifdef ALLOW_BBL
170     IF (useBBL) CALL BBL_CHECK( myThid )
171     #else
172     IF (useBBL) CALL PACKAGES_ERROR_MSG('BBL',' ',myThid)
173     #endif
174    
175 adcroft 1.6 #ifdef ALLOW_OBCS
176     IF (useOBCS) CALL OBCS_CHECK( myThid )
177     #else
178 jmc 1.41 IF (useOBCS) CALL PACKAGES_ERROR_MSG('OBCS',' ',myThid)
179     #endif
180    
181 jmc 1.53 #ifdef ALLOW_EXF
182     IF (useEXF) CALL EXF_CHECK( myThid )
183     #else
184 jmc 1.41 IF (useEXF) CALL PACKAGES_ERROR_MSG('EXF',' ',myThid)
185 jmc 1.17 #endif
186    
187     #ifndef ALLOW_BULK_FORCE
188 jmc 1.41 IF (useBulkForce) CALL PACKAGES_ERROR_MSG(
189     & 'BULK_FORCE', 'useBulkForce=.T.', myThid )
190 jmc 1.17 #endif
191    
192 jmc 1.49 #ifndef ALLOW_EBM
193     IF (useEBM) CALL PACKAGES_ERROR_MSG('EBM',' ',myThid)
194     #endif
195    
196     #ifndef ALLOW_CHEAPAML
197     IF (useCheapAML) CALL PACKAGES_ERROR_MSG('CheapAML',' ',myThid)
198     #endif
199    
200 heimbach 1.40 #ifdef ALLOW_THSICE
201     IF (useThSIce) CALL THSICE_CHECK( myThid )
202     #else
203 jmc 1.41 IF (useThSIce) CALL PACKAGES_ERROR_MSG('ThSIce',' ',myThid)
204 jmc 1.7 #endif
205    
206 jscott 1.37 #ifndef ALLOW_ATM2D
207 jmc 1.41 IF (useATM2D) CALL PACKAGES_ERROR_MSG('ATM2D',' ',myThid)
208 jscott 1.37 #endif
209    
210 jmc 1.7 #ifndef ALLOW_AIM
211 jmc 1.41 IF (useAIM) CALL PACKAGES_ERROR_MSG('AIM',' ',myThid)
212 jmc 1.14 #endif
213    
214     #ifndef ALLOW_LAND
215 jmc 1.49 IF (useLand) CALL PACKAGES_ERROR_MSG('Land',' ',myThid)
216     #endif
217    
218     #ifndef ALLOW_FIZHI
219     IF (useFizhi) CALL PACKAGES_ERROR_MSG('Fizhi',' ',myThid)
220     #endif
221    
222     #ifndef ALLOW_GRIDALT
223     IF (useGridAlt) CALL PACKAGES_ERROR_MSG('GridAlt',' ',myThid)
224 adcroft 1.11 #endif
225    
226     #ifndef ALLOW_PTRACERS
227 jmc 1.41 IF (usePTRACERS) CALL PACKAGES_ERROR_MSG('PTRACERS',' ',myThid)
228 jmc 1.10 #endif
229    
230 mlosch 1.25 #ifdef ALLOW_GCHEM
231     IF (useGCHEM) CALL GCHEM_CHECK( myThid )
232     #else
233 jmc 1.41 IF (useGCHEM) CALL PACKAGES_ERROR_MSG('GCHEM',' ',myThid)
234 mlosch 1.25 #endif
235    
236 jmc 1.49 #ifndef ALLOW_RBCS
237     IF (useRBCS) CALL PACKAGES_ERROR_MSG('RBCS',' ',myThid)
238     #endif
239    
240 jmc 1.33 #ifndef ALLOW_OFFLINE
241 jmc 1.41 IF (useOffLine) CALL PACKAGES_ERROR_MSG('OffLine',' ',myThid)
242 jmc 1.33 #endif
243    
244 jmc 1.49 #ifndef ALLOW_MATRIX
245     IF (useMATRIX) CALL PACKAGES_ERROR_MSG('MATRIX',' ',myThid)
246     #endif
247    
248 jmc 1.10 #ifndef ALLOW_SHAP_FILT
249 jmc 1.41 IF (useSHAP_FILT)
250     & CALL PACKAGES_ERROR_MSG( 'SHAP_FILT', ' ', myThid )
251 jmc 1.10 #endif
252    
253     #ifndef ALLOW_ZONAL_FILT
254 jmc 1.41 IF (useZONAL_FILT)
255     & CALL PACKAGES_ERROR_MSG( 'ZONAL_FILT', ' ', myThid )
256 adcroft 1.8 #endif
257    
258     #ifndef ALLOW_FLT
259 jmc 1.41 IF (useFLT) CALL PACKAGES_ERROR_MSG('FLT',' ',myThid)
260 dimitri 1.13 #endif
261    
262     #ifdef ALLOW_SBO
263     IF (useSBO) CALL SBO_CHECK( myThid )
264     #else
265 jmc 1.41 IF (useSBO) CALL PACKAGES_ERROR_MSG('SBO',' ',myThid)
266 heimbach 1.12 #endif
267    
268     #ifdef ALLOW_SEAICE
269     IF (useSEAICE) CALL SEAICE_CHECK( myThid )
270     #else
271 jmc 1.41 IF (useSEAICE) CALL PACKAGES_ERROR_MSG('SEAICE',' ',myThid)
272 edhill 1.20 #endif
273    
274 jmc 1.49 #ifdef ALLOW_SALT_PLUME
275     IF (useSALT_PLUME)CALL SALT_PLUME_CHECK( myThid )
276     #else
277     IF (useSALT_PLUME)CALL PACKAGES_ERROR_MSG('SALT_PLUME',' ',myThid)
278     #endif
279    
280 mlosch 1.32 #ifdef ALLOW_SHELFICE
281     IF (useShelfIce) CALL SHELFICE_CHECK( myThid )
282     #else
283 jmc 1.41 IF (useShelfIce) CALL PACKAGES_ERROR_MSG('ShelfIce',' ',myThid)
284 mlosch 1.32 #endif
285    
286 heimbach 1.56 #ifdef ALLOW_STREAMICE
287     IF (useStreamIce) CALL STREAMICE_CHECK( myThid )
288     #else
289     IF (useStreamIce) CALL PACKAGES_ERROR_MSG('StreamIce',' ',myThid)
290     #endif
291    
292 dimitri 1.48 #ifdef ALLOW_ICEFRONT
293     IF (useICEFRONT) CALL ICEFRONT_CHECK( myThid )
294     #else
295     IF (useICEFRONT) CALL PACKAGES_ERROR_MSG('ICEFRONT',' ',myThid)
296     #endif
297    
298 heimbach 1.19 #ifdef ALLOW_AUTODIFF
299 heimbach 1.24 CALL AUTODIFF_CHECK( myThid )
300 heimbach 1.26 #endif
301    
302     #ifdef ALLOW_CTRL
303 heimbach 1.15 CALL CTRL_CHECK( myThid )
304 heimbach 1.26 #endif
305    
306     #ifdef ALLOW_COST
307 heimbach 1.15 CALL COST_CHECK( myThid )
308 adcroft 1.6 #endif
309    
310 heimbach 1.29 #ifdef ALLOW_GRDCHK
311 heimbach 1.34 IF (useGRDCHK) CALL GRDCHK_CHECK( myThid )
312 heimbach 1.29 #endif
313    
314 jmc 1.49 #ifndef ALLOW_SMOOTH
315     IF (useSMOOTH) CALL PACKAGES_ERROR_MSG('SMOOTH',' ',myThid)
316     #endif
317    
318 jmc 1.27 #ifdef ALLOW_DIAGNOSTICS
319     IF (useDiagnostics) CALL DIAGNOSTICS_CHECK( myThid )
320     #else
321 jmc 1.33 IF (useDiagnostics)
322 jmc 1.41 & CALL PACKAGES_ERROR_MSG( 'Diagnostics', ' ', myThid )
323 jmc 1.27 #endif
324    
325 edhill 1.36 #ifdef ALLOW_REGRID
326     IF (useREGRID) CALL REGRID_CHECK( myThid )
327     #else
328 jmc 1.41 IF (useREGRID) CALL PACKAGES_ERROR_MSG('REGRID',' ',myThid)
329 edhill 1.36 #endif
330    
331 rpa 1.46 #ifdef ALLOW_LAYERS
332     IF ( useLayers ) CALL LAYERS_CHECK( myThid )
333     #else
334     IF ( useLayers ) CALL PACKAGES_ERROR_MSG('LAYERS',' ',myThid)
335     #endif /* ALLOW_LAYERS */
336    
337 jmc 1.47 #ifdef ALLOW_NEST_CHILD
338     IF (useNEST_CHILD) CALL NEST_CHILD_CHECK( myThid )
339     #else
340     IF (useNEST_CHILD) CALL PACKAGES_ERROR_MSG(
341     & 'NEST_CHILD',' ',myThid)
342     #endif
343    
344     #ifdef ALLOW_NEST_PARENT
345     IF (useNEST_PARENT) CALL NEST_PARENT_CHECK( myThid )
346     #else
347     IF (useNEST_PARENT) CALL PACKAGES_ERROR_MSG(
348     & 'NEST_PARENT',' ',myThid)
349     #endif
350    
351 jmc 1.51 #ifdef ALLOW_OASIS
352     IF (useOASIS) CALL OASIS_CHECK( myThid )
353     #else
354     IF (useOASIS) CALL PACKAGES_ERROR_MSG('OASIS',' ',myThid)
355     #endif
356    
357     #ifdef ALLOW_ECCO
358     CALL ECCO_CHECK( myThid )
359     #endif
360    
361 jmc 1.49 #ifndef ALLOW_EMBED_FILES
362     IF (useEMBED_FILES) CALL PACKAGES_ERROR_MSG(
363     & 'EMBED_FILES',' ',myThid)
364     #endif
365    
366 heimbach 1.35 #ifdef ALLOW_MYPACKAGE
367     IF (useMYPACKAGE) CALL MYPACKAGE_CHECK( myThid )
368     #else
369 jmc 1.41 IF (useMYPACKAGE) CALL PACKAGES_ERROR_MSG('MYPACKAGE',' ',myThid)
370 heimbach 1.35 #endif
371    
372 jmc 1.51 #ifdef ALLOW_GENERIC_ADVDIFF
373     C- Check generic AdvDiff setting and related overlap minimum size:
374     C for this reason, called after other ${pkg}_check S/R
375     IF (useGAD) CALL GAD_CHECK( myThid )
376 rpa 1.46 #endif
377 heimbach 1.45
378 jmc 1.41 C--- Exclusive packages (which cannot be used together):
379     IF ( useEXF .AND. useBulkForce ) THEN
380     WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
381     & 'both useEXF and useBulkForce are set'
382     CALL PRINT_ERROR( msgBuf , myThid )
383     WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
384     & ' but cannot be used together => need to select only one.'
385     CALL PRINT_ERROR( msgBuf , myThid )
386     STOP 'ABNORMAL END: S/R PACKAGES_CHECK'
387     ENDIF
388    
389 dimitri 1.55 C--- Exclusive packages (which cannot be used together):
390     IF ( useDOWN_SLOPE .AND. useBBL ) THEN
391     WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
392     & 'both useDOWN_SLOPE and useBBL are set'
393     CALL PRINT_ERROR( msgBuf , myThid )
394     WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
395     & ' but cannot be used together => need to select only one.'
396     CALL PRINT_ERROR( msgBuf , myThid )
397     STOP 'ABNORMAL END: S/R PACKAGES_CHECK'
398     ENDIF
399    
400 adcroft 1.6 RETURN
401     END

  ViewVC Help
Powered by ViewVC 1.1.22