/[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.52 - (hide annotations) (download)
Fri Dec 24 21:54:03 2010 UTC (13 years, 5 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint62r, checkpoint62q
Changes since 1.51: +11 -1 lines
A hack to prevent a 2nd printing of domain fields with default debugLevel.

1 jmc 1.52 C $Header: /u/gcmpack/MITgcm/model/src/packages_check.F,v 1.51 2010/11/16 17:41:33 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 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     IF (useCDscheme) CALL PACKAGES_ERROR_MSG(
117     & '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 adcroft 1.6 #ifdef ALLOW_OBCS
170     IF (useOBCS) CALL OBCS_CHECK( myThid )
171     #else
172 jmc 1.41 IF (useOBCS) CALL PACKAGES_ERROR_MSG('OBCS',' ',myThid)
173     #endif
174    
175     #ifndef ALLOW_EXF
176     IF (useEXF) CALL PACKAGES_ERROR_MSG('EXF',' ',myThid)
177 jmc 1.17 #endif
178    
179     #ifndef ALLOW_BULK_FORCE
180 jmc 1.41 IF (useBulkForce) CALL PACKAGES_ERROR_MSG(
181     & 'BULK_FORCE', 'useBulkForce=.T.', myThid )
182 jmc 1.17 #endif
183    
184 jmc 1.49 #ifndef ALLOW_EBM
185     IF (useEBM) CALL PACKAGES_ERROR_MSG('EBM',' ',myThid)
186     #endif
187    
188     #ifndef ALLOW_CHEAPAML
189     IF (useCheapAML) CALL PACKAGES_ERROR_MSG('CheapAML',' ',myThid)
190     #endif
191    
192 heimbach 1.40 #ifdef ALLOW_THSICE
193     IF (useThSIce) CALL THSICE_CHECK( myThid )
194     #else
195 jmc 1.41 IF (useThSIce) CALL PACKAGES_ERROR_MSG('ThSIce',' ',myThid)
196 jmc 1.7 #endif
197    
198 jscott 1.37 #ifndef ALLOW_ATM2D
199 jmc 1.41 IF (useATM2D) CALL PACKAGES_ERROR_MSG('ATM2D',' ',myThid)
200 jscott 1.37 #endif
201    
202 jmc 1.7 #ifndef ALLOW_AIM
203 jmc 1.41 IF (useAIM) CALL PACKAGES_ERROR_MSG('AIM',' ',myThid)
204 jmc 1.14 #endif
205    
206     #ifndef ALLOW_LAND
207 jmc 1.49 IF (useLand) CALL PACKAGES_ERROR_MSG('Land',' ',myThid)
208     #endif
209    
210     #ifndef ALLOW_FIZHI
211     IF (useFizhi) CALL PACKAGES_ERROR_MSG('Fizhi',' ',myThid)
212     #endif
213    
214     #ifndef ALLOW_GRIDALT
215     IF (useGridAlt) CALL PACKAGES_ERROR_MSG('GridAlt',' ',myThid)
216 adcroft 1.11 #endif
217    
218     #ifndef ALLOW_PTRACERS
219 jmc 1.41 IF (usePTRACERS) CALL PACKAGES_ERROR_MSG('PTRACERS',' ',myThid)
220 jmc 1.10 #endif
221    
222 mlosch 1.25 #ifdef ALLOW_GCHEM
223     IF (useGCHEM) CALL GCHEM_CHECK( myThid )
224     #else
225 jmc 1.41 IF (useGCHEM) CALL PACKAGES_ERROR_MSG('GCHEM',' ',myThid)
226 mlosch 1.25 #endif
227    
228 jmc 1.49 #ifndef ALLOW_RBCS
229     IF (useRBCS) CALL PACKAGES_ERROR_MSG('RBCS',' ',myThid)
230     #endif
231    
232 jmc 1.33 #ifndef ALLOW_OFFLINE
233 jmc 1.41 IF (useOffLine) CALL PACKAGES_ERROR_MSG('OffLine',' ',myThid)
234 jmc 1.33 #endif
235    
236 jmc 1.49 #ifndef ALLOW_MATRIX
237     IF (useMATRIX) CALL PACKAGES_ERROR_MSG('MATRIX',' ',myThid)
238     #endif
239    
240 jmc 1.10 #ifndef ALLOW_SHAP_FILT
241 jmc 1.41 IF (useSHAP_FILT)
242     & CALL PACKAGES_ERROR_MSG( 'SHAP_FILT', ' ', myThid )
243 jmc 1.10 #endif
244    
245     #ifndef ALLOW_ZONAL_FILT
246 jmc 1.41 IF (useZONAL_FILT)
247     & CALL PACKAGES_ERROR_MSG( 'ZONAL_FILT', ' ', myThid )
248 adcroft 1.8 #endif
249    
250     #ifndef ALLOW_FLT
251 jmc 1.41 IF (useFLT) CALL PACKAGES_ERROR_MSG('FLT',' ',myThid)
252 dimitri 1.13 #endif
253    
254     #ifdef ALLOW_SBO
255     IF (useSBO) CALL SBO_CHECK( myThid )
256     #else
257 jmc 1.41 IF (useSBO) CALL PACKAGES_ERROR_MSG('SBO',' ',myThid)
258 heimbach 1.12 #endif
259    
260     #ifdef ALLOW_SEAICE
261     IF (useSEAICE) CALL SEAICE_CHECK( myThid )
262     #else
263 jmc 1.41 IF (useSEAICE) CALL PACKAGES_ERROR_MSG('SEAICE',' ',myThid)
264 edhill 1.20 #endif
265    
266 jmc 1.49 #ifdef ALLOW_SALT_PLUME
267     IF (useSALT_PLUME)CALL SALT_PLUME_CHECK( myThid )
268     #else
269     IF (useSALT_PLUME)CALL PACKAGES_ERROR_MSG('SALT_PLUME',' ',myThid)
270     #endif
271    
272 mlosch 1.32 #ifdef ALLOW_SHELFICE
273     IF (useShelfIce) CALL SHELFICE_CHECK( myThid )
274     #else
275 jmc 1.41 IF (useShelfIce) CALL PACKAGES_ERROR_MSG('ShelfIce',' ',myThid)
276 mlosch 1.32 #endif
277    
278 dimitri 1.48 #ifdef ALLOW_ICEFRONT
279     IF (useICEFRONT) CALL ICEFRONT_CHECK( myThid )
280     #else
281     IF (useICEFRONT) CALL PACKAGES_ERROR_MSG('ICEFRONT',' ',myThid)
282     #endif
283    
284 heimbach 1.19 #ifdef ALLOW_AUTODIFF
285 heimbach 1.24 CALL AUTODIFF_CHECK( myThid )
286 heimbach 1.26 #endif
287    
288     #ifdef ALLOW_CTRL
289 heimbach 1.15 CALL CTRL_CHECK( myThid )
290 heimbach 1.26 #endif
291    
292     #ifdef ALLOW_COST
293 heimbach 1.15 CALL COST_CHECK( myThid )
294 adcroft 1.6 #endif
295    
296 heimbach 1.29 #ifdef ALLOW_GRDCHK
297 heimbach 1.34 IF (useGRDCHK) CALL GRDCHK_CHECK( myThid )
298 heimbach 1.29 #endif
299    
300 jmc 1.49 #ifndef ALLOW_SMOOTH
301     IF (useSMOOTH) CALL PACKAGES_ERROR_MSG('SMOOTH',' ',myThid)
302     #endif
303    
304 jmc 1.27 #ifdef ALLOW_DIAGNOSTICS
305     IF (useDiagnostics) CALL DIAGNOSTICS_CHECK( myThid )
306     #else
307 jmc 1.33 IF (useDiagnostics)
308 jmc 1.41 & CALL PACKAGES_ERROR_MSG( 'Diagnostics', ' ', myThid )
309 jmc 1.27 #endif
310    
311 edhill 1.36 #ifdef ALLOW_REGRID
312     IF (useREGRID) CALL REGRID_CHECK( myThid )
313     #else
314 jmc 1.41 IF (useREGRID) CALL PACKAGES_ERROR_MSG('REGRID',' ',myThid)
315 edhill 1.36 #endif
316    
317 rpa 1.46 #ifdef ALLOW_LAYERS
318     IF ( useLayers ) CALL LAYERS_CHECK( myThid )
319     #else
320     IF ( useLayers ) CALL PACKAGES_ERROR_MSG('LAYERS',' ',myThid)
321     #endif /* ALLOW_LAYERS */
322    
323 jmc 1.47 #ifdef ALLOW_NEST_CHILD
324     IF (useNEST_CHILD) CALL NEST_CHILD_CHECK( myThid )
325     #else
326     IF (useNEST_CHILD) CALL PACKAGES_ERROR_MSG(
327     & 'NEST_CHILD',' ',myThid)
328     #endif
329    
330     #ifdef ALLOW_NEST_PARENT
331     IF (useNEST_PARENT) CALL NEST_PARENT_CHECK( myThid )
332     #else
333     IF (useNEST_PARENT) CALL PACKAGES_ERROR_MSG(
334     & 'NEST_PARENT',' ',myThid)
335     #endif
336    
337 jmc 1.51 #ifdef ALLOW_OASIS
338     IF (useOASIS) CALL OASIS_CHECK( myThid )
339     #else
340     IF (useOASIS) CALL PACKAGES_ERROR_MSG('OASIS',' ',myThid)
341     #endif
342    
343     #ifdef ALLOW_ECCO
344     CALL ECCO_CHECK( myThid )
345     #endif
346    
347 jmc 1.49 #ifndef ALLOW_EMBED_FILES
348     IF (useEMBED_FILES) CALL PACKAGES_ERROR_MSG(
349     & 'EMBED_FILES',' ',myThid)
350     #endif
351    
352 heimbach 1.35 #ifdef ALLOW_MYPACKAGE
353     IF (useMYPACKAGE) CALL MYPACKAGE_CHECK( myThid )
354     #else
355 jmc 1.41 IF (useMYPACKAGE) CALL PACKAGES_ERROR_MSG('MYPACKAGE',' ',myThid)
356 heimbach 1.35 #endif
357    
358 jmc 1.51 #ifdef ALLOW_GENERIC_ADVDIFF
359     C- Check generic AdvDiff setting and related overlap minimum size:
360     C for this reason, called after other ${pkg}_check S/R
361     IF (useGAD) CALL GAD_CHECK( myThid )
362 rpa 1.46 #endif
363 heimbach 1.45
364 jmc 1.41 C--- Exclusive packages (which cannot be used together):
365     IF ( useEXF .AND. useBulkForce ) THEN
366     WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
367     & 'both useEXF and useBulkForce are set'
368     CALL PRINT_ERROR( msgBuf , myThid )
369     WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
370     & ' but cannot be used together => need to select only one.'
371     CALL PRINT_ERROR( msgBuf , myThid )
372     STOP 'ABNORMAL END: S/R PACKAGES_CHECK'
373     ENDIF
374    
375 jmc 1.52 #ifdef ALLOW_AUTODIFF
376     C-- Here INI_MASK_ETC will be called a 2nd time by INITIALISE_VARIA.
377     C This hack prevents a 2nd printing when default debugLevel is used.
378     _BARRIER
379     _BEGIN_MASTER( myThid )
380     IF ( debugLevel.LE.debLevA ) printDomain = .FALSE.
381     _END_MASTER( myThid )
382     _BARRIER
383     #endif
384    
385 adcroft 1.6 RETURN
386     END

  ViewVC Help
Powered by ViewVC 1.1.22