/[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.59 - (hide annotations) (download)
Wed Apr 18 22:06:56 2012 UTC (12 years ago) by jmc
Branch: MAIN
CVS Tags: checkpoint63m, checkpoint63n
Changes since 1.58: +4 -2 lines
move pkg/ptracers summary and setup check into separated S/R.

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

  ViewVC Help
Powered by ViewVC 1.1.22