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

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

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


Revision 1.66 - (show annotations) (download)
Wed Jul 30 03:31:35 2014 UTC (9 years, 10 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint65b, checkpoint65c
Changes since 1.65: +7 -1 lines
-  add new pkg "kl10" for mixing due to internal wave breaking
  ( http://www.sciencedirect.com/science/article/pii/S1463500310000144 )

1 C $Header: /u/gcmpack/MITgcm/model/src/packages_check.F,v 1.65 2014/05/28 22:01:57 jmc Exp $
2 C $Name: $
3
4 #include "PACKAGES_CONFIG.h"
5 #include "CPP_OPTIONS.h"
6
7 CBOP
8 C !ROUTINE: PACKAGES_CHECK
9 C !INTERFACE:
10 SUBROUTINE PACKAGES_CHECK( myThid )
11 C !DESCRIPTION: \bv
12 C *==========================================================*
13 C | SUBROUTINE PACKAGES_CHECK
14 C | o Check runtime activated packages have been built in.
15 C *==========================================================*
16 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 C *==========================================================*
22 C \ev
23
24 C !USES:
25 IMPLICIT NONE
26 C === Global variables ===
27 #include "SIZE.h"
28 #include "EEPARAMS.h"
29 #include "PARAMS.h"
30
31 C !INPUT/OUTPUT PARAMETERS:
32 C === Routine arguments ===
33 C myThid :: my Thread Id number
34 INTEGER myThid
35
36 C !LOCAL VARIABLES:
37 C === Local variables ===
38 C msgBuf :: Informational/error message buffer
39 CHARACTER*(MAX_LEN_MBUF) msgBuf
40 CEOP
41
42 _BEGIN_MASTER(myThid)
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 _END_MASTER(myThid)
51
52 C--- Start with non-standard packages (without or with non standard flag)
53
54 #ifndef ALLOW_MNC
55 IF (useMNC) THEN
56 _BEGIN_MASTER(myThid)
57 WRITE(msgBuf,'(2A)') '** WARNING **',
58 & ' PACKAGES_CHECK: useMNC is TRUE'
59 CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
60 & SQUEEZE_RIGHT, myThid )
61 WRITE(msgBuf,'(2A)') '** WARNING **',
62 & ' but pkg/mnc has not been compiled (#undef ALLOW_MNC)'
63 CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
64 & SQUEEZE_RIGHT, myThid )
65 _END_MASTER(myThid)
66 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 CALL PRINT_ERROR( msgBuf , myThid )
75 WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
76 & 'Re-compile with pkg "mom_vecinv" in packages.conf'
77 CALL PRINT_ERROR( msgBuf , myThid )
78 CALL ALL_PROC_DIE( myThid )
79 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 CALL PRINT_ERROR( msgBuf , myThid )
88 WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
89 & 'Re-compile with pkg "mom_fluxform" in packages.conf'
90 CALL PRINT_ERROR( msgBuf , myThid )
91 CALL ALL_PROC_DIE( myThid )
92 STOP 'ABNORMAL END: S/R PACKAGES_CHECK'
93 ENDIF
94 #endif
95
96 #ifndef ALLOW_GENERIC_ADVDIFF
97 IF ( tempStepping .OR. saltStepping ) THEN
98 WRITE(msgBuf,'(2A)')
99 & 'PACKAGES_CHECK: cannot step forward Temp or Salt',
100 & ' without pkg/generic_advdiff'
101 CALL PRINT_ERROR( msgBuf , myThid )
102 WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
103 & 'Re-compile with pkg "generic_advdiff" in packages.conf'
104 CALL PRINT_ERROR( msgBuf , myThid )
105 CALL ALL_PROC_DIE( myThid )
106 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 IF (monitorFreq.NE.0.) CALL PACKAGES_ERROR_MSG(
113 & 'MONITOR', 'monitorFreq <> 0', myThid )
114 #endif
115
116 #ifndef ALLOW_TIMEAVE
117 C If taveFreq is finite, make sure the pkg/timeave is being compiled
118 IF (taveFreq.NE.0.) CALL PACKAGES_ERROR_MSG(
119 & 'TIMEAVE', 'taveFreq <> 0', myThid )
120 #endif
121
122 #ifndef ALLOW_CD_CODE
123 IF (useCDscheme) CALL PACKAGES_ERROR_MSG(
124 & 'CD_CODE', 'useCDscheme=.T.', myThid )
125 #endif
126
127 C--- Continue with standard packages (with standard usePKG flag)
128
129 #ifdef ALLOW_OBCS
130 IF (useOBCS) CALL OBCS_CHECK( myThid )
131 #else
132 IF (useOBCS) CALL PACKAGES_ERROR_MSG('OBCS',' ',myThid)
133 #endif
134
135 #ifndef ALLOW_SHAP_FILT
136 IF (useSHAP_FILT)
137 & CALL PACKAGES_ERROR_MSG( 'SHAP_FILT', ' ', myThid )
138 #endif
139
140 #ifndef ALLOW_ZONAL_FILT
141 IF (useZONAL_FILT)
142 & CALL PACKAGES_ERROR_MSG( 'ZONAL_FILT', ' ', myThid )
143 #endif
144
145 #ifdef ALLOW_OPPS
146 IF (useOPPS) CALL OPPS_CHECK( myThid )
147 #else
148 IF (useOPPS) CALL PACKAGES_ERROR_MSG('OPPS',' ',myThid)
149 #endif
150
151 #ifdef ALLOW_PP81
152 IF (usePP81) CALL PP81_CHECK( myThid )
153 #else
154 IF (usePP81) CALL PACKAGES_ERROR_MSG('PP81',' ',myThid)
155 #endif
156
157 #ifdef ALLOW_KL10
158 IF (useKL10) CALL KL10_CHECK( myThid )
159 #else
160 IF (useKL10) CALL PACKAGES_ERROR_MSG('KL10',' ',myThid)
161 #endif
162
163 #ifdef ALLOW_MY82
164 IF (useMY82) CALL MY82_CHECK( myThid )
165 #else
166 IF (useMY82) CALL PACKAGES_ERROR_MSG('MY82',' ',myThid)
167 #endif
168
169 #ifdef ALLOW_GGL90
170 IF (useGGL90) CALL GGL90_CHECK( myThid )
171 #else
172 IF (useGGL90) CALL PACKAGES_ERROR_MSG('GGL90',' ',myThid)
173 #endif
174
175 #ifdef ALLOW_KPP
176 IF (useKPP) CALL KPP_CHECK( myThid )
177 #else
178 IF (useKPP) CALL PACKAGES_ERROR_MSG('KPP',' ',myThid)
179 #endif
180
181 #ifdef ALLOW_GMREDI
182 IF (useGMRedi) CALL GMREDI_CHECK( myThid )
183 #else
184 IF (useGMRedi) CALL PACKAGES_ERROR_MSG('GMRedi',' ',myThid)
185 #endif
186
187 #ifdef ALLOW_BBL
188 IF (useBBL) CALL BBL_CHECK( myThid )
189 #else
190 IF (useBBL) CALL PACKAGES_ERROR_MSG('BBL',' ',myThid)
191 #endif
192
193 #ifndef ALLOW_DOWN_SLOPE
194 IF (useDOWN_SLOPE)
195 & CALL PACKAGES_ERROR_MSG('DOWN_SLOPE',' ',myThid)
196 #endif
197
198 #ifndef ALLOW_CAL
199 IF (useCAL) CALL PACKAGES_ERROR_MSG('CAL',' ',myThid)
200 #endif
201
202 #ifdef ALLOW_EXF
203 IF (useEXF) CALL EXF_CHECK( myThid )
204 #else
205 IF (useEXF) CALL PACKAGES_ERROR_MSG('EXF',' ',myThid)
206 #endif
207
208 #ifndef ALLOW_BULK_FORCE
209 IF (useBulkForce) CALL PACKAGES_ERROR_MSG(
210 & 'BULK_FORCE', 'useBulkForce=.T.', myThid )
211 #endif
212
213 #ifndef ALLOW_EBM
214 IF (useEBM) CALL PACKAGES_ERROR_MSG('EBM',' ',myThid)
215 #endif
216
217 #ifndef ALLOW_CHEAPAML
218 IF (useCheapAML) CALL PACKAGES_ERROR_MSG('CheapAML',' ',myThid)
219 #endif
220
221 #ifndef ALLOW_FLT
222 IF (useFLT) CALL PACKAGES_ERROR_MSG('FLT',' ',myThid)
223 #endif
224
225 #ifdef ALLOW_PTRACERS
226 IF (usePTRACERS) CALL PTRACERS_CHECK( myThid )
227 #else
228 IF (usePTRACERS) CALL PACKAGES_ERROR_MSG('PTRACERS',' ',myThid)
229 #endif
230
231 #ifdef ALLOW_GCHEM
232 IF (useGCHEM) CALL GCHEM_CHECK( myThid )
233 #else
234 IF (useGCHEM) CALL PACKAGES_ERROR_MSG('GCHEM',' ',myThid)
235 #endif
236
237 #ifndef ALLOW_RBCS
238 IF (useRBCS) CALL PACKAGES_ERROR_MSG('RBCS',' ',myThid)
239 #endif
240
241 #ifdef ALLOW_OFFLINE
242 IF (useOffLine) CALL OFFLINE_CHECK( myThid )
243 #else
244 IF (useOffLine) CALL PACKAGES_ERROR_MSG('OffLine',' ',myThid)
245 #endif
246
247 #ifndef ALLOW_MATRIX
248 IF (useMATRIX) CALL PACKAGES_ERROR_MSG('MATRIX',' ',myThid)
249 #endif
250
251 #ifndef ALLOW_FRAZIL
252 IF (useFRAZIL) CALL PACKAGES_ERROR_MSG('FRAZIL',' ',myThid)
253 #endif
254
255 #ifdef ALLOW_SEAICE
256 IF (useSEAICE) CALL SEAICE_CHECK( myThid )
257 #else
258 IF (useSEAICE) CALL PACKAGES_ERROR_MSG('SEAICE',' ',myThid)
259 #endif
260
261 #ifdef ALLOW_SALT_PLUME
262 IF (useSALT_PLUME)CALL SALT_PLUME_CHECK( myThid )
263 #else
264 IF (useSALT_PLUME)CALL PACKAGES_ERROR_MSG('SALT_PLUME',' ',myThid)
265 #endif
266
267 #ifdef ALLOW_SHELFICE
268 IF (useShelfIce) CALL SHELFICE_CHECK( myThid )
269 #else
270 IF (useShelfIce) CALL PACKAGES_ERROR_MSG('ShelfIce',' ',myThid)
271 #endif
272
273 #ifdef ALLOW_STREAMICE
274 IF (useStreamIce) CALL STREAMICE_CHECK( myThid )
275 #else
276 IF (useStreamIce) CALL PACKAGES_ERROR_MSG('StreamIce',' ',myThid)
277 #endif
278
279 #ifdef ALLOW_ICEFRONT
280 IF (useICEFRONT) CALL ICEFRONT_CHECK( myThid )
281 #else
282 IF (useICEFRONT) CALL PACKAGES_ERROR_MSG('ICEFRONT',' ',myThid)
283 #endif
284
285 #ifdef ALLOW_THSICE
286 IF (useThSIce) CALL THSICE_CHECK( myThid )
287 #else
288 IF (useThSIce) CALL PACKAGES_ERROR_MSG('ThSIce',' ',myThid)
289 #endif
290
291 #ifdef ALLOW_LAND
292 IF (useLand) CALL LAND_CHECK( myThid )
293 #else
294 IF (useLand) CALL PACKAGES_ERROR_MSG('Land',' ',myThid)
295 #endif
296
297 #ifndef ALLOW_ATM2D
298 IF (useATM2D) CALL PACKAGES_ERROR_MSG('ATM2D',' ',myThid)
299 #endif
300
301 #ifndef ALLOW_AIM
302 IF (useAIM) CALL PACKAGES_ERROR_MSG('AIM',' ',myThid)
303 #endif
304
305 #ifdef ALLOW_ATM_PHYS
306 IF (useAtm_Phys) CALL ATM_PHYS_CHECK( myThid )
307 #else
308 IF (useAtm_Phys) CALL PACKAGES_ERROR_MSG('Atm_Phys',' ',myThid)
309 #endif
310
311 #ifndef ALLOW_FIZHI
312 IF (useFizhi) CALL PACKAGES_ERROR_MSG('Fizhi',' ',myThid)
313 #endif
314
315 #ifndef ALLOW_GRIDALT
316 IF (useGridAlt) CALL PACKAGES_ERROR_MSG('GridAlt',' ',myThid)
317 #endif
318
319 #ifdef ALLOW_AUTODIFF
320 CALL AUTODIFF_CHECK( myThid )
321 #endif
322
323 #ifdef ALLOW_CTRL
324 CALL CTRL_CHECK( myThid )
325 #endif
326
327 #ifdef ALLOW_COST
328 CALL COST_CHECK( myThid )
329 #endif
330
331 #ifdef ALLOW_GRDCHK
332 IF (useGrdChk) CALL GRDCHK_CHECK( myThid )
333 #else
334 IF (useGrdChk) CALL PACKAGES_ERROR_MSG('GrdChk',' ',myThid)
335 #endif
336
337 #ifndef ALLOW_SMOOTH
338 IF (useSMOOTH) CALL PACKAGES_ERROR_MSG('SMOOTH',' ',myThid)
339 #endif
340
341 #ifndef ALLOW_PROFILES
342 IF (usePROFILES) CALL PACKAGES_ERROR_MSG('PROFILES',' ',myThid)
343 #endif
344
345 #ifdef ALLOW_SBO
346 IF (useSBO) CALL SBO_CHECK( myThid )
347 #else
348 IF (useSBO) CALL PACKAGES_ERROR_MSG('SBO',' ',myThid)
349 #endif
350
351 #ifdef ALLOW_ECCO
352 CALL ECCO_CHECK( myThid )
353 #endif
354
355 #ifdef ALLOW_DIAGNOSTICS
356 IF (useDiagnostics) CALL DIAGNOSTICS_CHECK( myThid )
357 #else
358 IF (useDiagnostics)
359 & CALL PACKAGES_ERROR_MSG( 'Diagnostics', ' ', myThid )
360 #endif
361
362 #ifdef ALLOW_REGRID
363 IF (useREGRID) CALL REGRID_CHECK( myThid )
364 #else
365 IF (useREGRID) CALL PACKAGES_ERROR_MSG('REGRID',' ',myThid)
366 #endif
367
368 #ifdef ALLOW_LAYERS
369 IF ( useLayers ) CALL LAYERS_CHECK( myThid )
370 #else
371 IF ( useLayers ) CALL PACKAGES_ERROR_MSG('LAYERS',' ',myThid)
372 #endif /* ALLOW_LAYERS */
373
374 #ifdef ALLOW_NEST_CHILD
375 IF (useNEST_CHILD) CALL NEST_CHILD_CHECK( myThid )
376 #else
377 IF (useNEST_CHILD) CALL PACKAGES_ERROR_MSG(
378 & 'NEST_CHILD',' ',myThid)
379 #endif
380
381 #ifdef ALLOW_NEST_PARENT
382 IF (useNEST_PARENT) CALL NEST_PARENT_CHECK( myThid )
383 #else
384 IF (useNEST_PARENT) CALL PACKAGES_ERROR_MSG(
385 & 'NEST_PARENT',' ',myThid)
386 #endif
387
388 #ifdef ALLOW_OASIS
389 IF (useOASIS) CALL OASIS_CHECK( myThid )
390 #else
391 IF (useOASIS) CALL PACKAGES_ERROR_MSG('OASIS',' ',myThid)
392 #endif
393
394 #ifdef ALLOW_RUNCLOCK
395 IF (useRunClock) CALL RUNCLOCK_CHECK( myThid )
396 #else
397 IF (useRunClock) CALL PACKAGES_ERROR_MSG('RunClock',' ',myThid)
398 #endif
399
400 #ifndef ALLOW_EMBED_FILES
401 IF (useEMBED_FILES) CALL PACKAGES_ERROR_MSG(
402 & 'EMBED_FILES',' ',myThid)
403 #endif
404
405 #ifdef ALLOW_MYPACKAGE
406 IF (useMYPACKAGE) CALL MYPACKAGE_CHECK( myThid )
407 #else
408 IF (useMYPACKAGE) CALL PACKAGES_ERROR_MSG('MYPACKAGE',' ',myThid)
409 #endif
410
411 #ifdef ALLOW_GENERIC_ADVDIFF
412 C- Check generic AdvDiff setting and related overlap minimum size:
413 C for this reason, called after other ${pkg}_check S/R
414 IF (useGAD) CALL GAD_CHECK( myThid )
415 #endif
416
417 C--- Exclusive packages (which cannot be used together):
418 IF ( useEXF .AND. useBulkForce ) THEN
419 WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
420 & 'both useEXF and useBulkForce are set'
421 CALL PRINT_ERROR( msgBuf , myThid )
422 WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
423 & ' but cannot be used together => need to select only one.'
424 CALL PRINT_ERROR( msgBuf , myThid )
425 CALL ALL_PROC_DIE( myThid )
426 STOP 'ABNORMAL END: S/R PACKAGES_CHECK'
427 ENDIF
428
429 C--- Exclusive packages (which cannot be used together):
430 IF ( useDOWN_SLOPE .AND. useBBL ) THEN
431 WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
432 & 'both useDOWN_SLOPE and useBBL are set'
433 CALL PRINT_ERROR( msgBuf , myThid )
434 WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
435 & ' but cannot be used together => need to select only one.'
436 CALL PRINT_ERROR( msgBuf , myThid )
437 CALL ALL_PROC_DIE( myThid )
438 STOP 'ABNORMAL END: S/R PACKAGES_CHECK'
439 ENDIF
440
441 RETURN
442 END

  ViewVC Help
Powered by ViewVC 1.1.22