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

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

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

revision 1.12 by heimbach, Tue Nov 12 20:45:41 2002 UTC revision 1.62 by jmc, Wed May 8 00:06:32 2013 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2  C $Name$  C $Name$
3    
4    #include "PACKAGES_CONFIG.h"
5  #include "CPP_OPTIONS.h"  #include "CPP_OPTIONS.h"
6    
7  CBOP  CBOP
# Line 9  C     !INTERFACE: Line 10  C     !INTERFACE:
10        SUBROUTINE PACKAGES_CHECK( myThid )        SUBROUTINE PACKAGES_CHECK( myThid )
11  C     !DESCRIPTION: \bv  C     !DESCRIPTION: \bv
12  C     *==========================================================*  C     *==========================================================*
13  C     | SUBROUTINE PACKAGES_CHECK                                  C     | SUBROUTINE PACKAGES_CHECK
14  C     | o Check runtime activated packages have been built in.      C     | o Check runtime activated packages have been built in.
15  C     *==========================================================*  C     *==========================================================*
16  C     | All packages can be selected/deselected at build time      C     | All packages can be selected/deselected at build time
17  C     | ( when code is compiled ) and activated/deactivated at      C     | ( when code is compiled ) and activated/deactivated at
18  C     | runtime. This routine does a quick check to trap packages  C     | runtime. This routine does a quick check to trap packages
19  C     | that were activated at runtime but that were not compiled  C     | that were activated at runtime but that were not compiled
20  C     | in at build time.                                          C     | in at build time.
21  C     *==========================================================*  C     *==========================================================*
22  C     \ev  C     \ev
23    
# Line 29  C     === Global variables === Line 30  C     === Global variables ===
30    
31  C     !INPUT/OUTPUT PARAMETERS:  C     !INPUT/OUTPUT PARAMETERS:
32  C     === Routine arguments ===  C     === Routine arguments ===
33  C     myThid ::  Number of this instances  C     myThid :: my Thread Id number
34        INTEGER myThid        INTEGER myThid
35    
36  C     !LOCAL VARIABLES:  C     !LOCAL VARIABLES:
37  C     === Local variables ===  C     === Local variables ===
38  C     msgBuf      :: Informational/error meesage buffer  C     msgBuf :: Informational/error message buffer
39        CHARACTER*(MAX_LEN_MBUF) msgBuf        CHARACTER*(MAX_LEN_MBUF) msgBuf
40  CEOP  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_MY82
158          IF (useMY82) CALL MY82_CHECK( myThid )
159    #else
160          IF (useMY82) CALL PACKAGES_ERROR_MSG('MY82',' ',myThid)
161    #endif
162    
163    #ifdef ALLOW_GGL90
164          IF (useGGL90) CALL GGL90_CHECK( myThid )
165    #else
166          IF (useGGL90) CALL PACKAGES_ERROR_MSG('GGL90',' ',myThid)
167    #endif
168    
169  #ifdef ALLOW_KPP  #ifdef ALLOW_KPP
170        IF (useKPP) CALL KPP_CHECK( myThid )        IF (useKPP) CALL KPP_CHECK( myThid )
171  #else  #else
172        IF (useKPP) CALL PACKAGES_CHECK_ERROR('KPP', myThid)        IF (useKPP) CALL PACKAGES_ERROR_MSG('KPP',' ',myThid)
173  #endif  #endif
174    
175  #ifdef ALLOW_GMREDI  #ifdef ALLOW_GMREDI
176        IF (useGMRedi) CALL GMREDI_CHECK( myThid )        IF (useGMRedi) CALL GMREDI_CHECK( myThid )
177  #else  #else
178        IF (useGMRedi) CALL PACKAGES_CHECK_ERROR('GMREDI', myThid)        IF (useGMRedi) CALL PACKAGES_ERROR_MSG('GMRedi',' ',myThid)
179  #endif  #endif
180    
181  #ifdef ALLOW_OBCS  #ifdef ALLOW_BBL
182        IF (useOBCS) CALL OBCS_CHECK( myThid )        IF (useBBL) CALL BBL_CHECK( myThid )
183  #else  #else
184        IF (useOBCS) CALL PACKAGES_CHECK_ERROR('OBCS', myThid)        IF (useBBL) CALL PACKAGES_ERROR_MSG('BBL',' ',myThid)
185  #endif  #endif
186    
187  #ifndef ALLOW_AIM  #ifndef ALLOW_DOWN_SLOPE
188        IF (useAIM) CALL PACKAGES_CHECK_ERROR('AIM', myThid)        IF (useDOWN_SLOPE)
189         &            CALL PACKAGES_ERROR_MSG('DOWN_SLOPE',' ',myThid)
190  #endif  #endif
191    
192  #ifndef ALLOW_PTRACERS  #ifndef ALLOW_CAL
193        IF (usePTRACERS) CALL PACKAGES_CHECK_ERROR('PTRACERS', myThid)        IF (useCAL) CALL PACKAGES_ERROR_MSG('CAL',' ',myThid)
194  #endif  #endif
195    
196  #ifndef ALLOW_SHAP_FILT  #ifdef ALLOW_EXF
197        IF (useSHAP_FILT) CALL PACKAGES_CHECK_ERROR('SHAP_FILT', myThid)        IF (useEXF) CALL EXF_CHECK( myThid )
198    #else
199          IF (useEXF) CALL PACKAGES_ERROR_MSG('EXF',' ',myThid)
200  #endif  #endif
201    
202  #ifndef ALLOW_ZONAL_FILT  #ifndef ALLOW_BULK_FORCE
203        IF (useZONAL_FILT) CALL PACKAGES_CHECK_ERROR('ZONAL_FILT',myThid)        IF (useBulkForce) CALL PACKAGES_ERROR_MSG(
204         &                  'BULK_FORCE', 'useBulkForce=.T.', myThid )
205    #endif
206    
207    #ifndef ALLOW_EBM
208          IF (useEBM) CALL PACKAGES_ERROR_MSG('EBM',' ',myThid)
209    #endif
210    
211    #ifndef ALLOW_CHEAPAML
212          IF (useCheapAML) CALL PACKAGES_ERROR_MSG('CheapAML',' ',myThid)
213  #endif  #endif
214    
215  #ifndef ALLOW_FLT  #ifndef ALLOW_FLT
216        IF (useFLT) CALL PACKAGES_CHECK_ERROR('FLT', myThid)        IF (useFLT) CALL PACKAGES_ERROR_MSG('FLT',' ',myThid)
217    #endif
218    
219    #ifdef ALLOW_PTRACERS
220          IF (usePTRACERS) CALL PTRACERS_CHECK( myThid )
221    #else
222          IF (usePTRACERS) CALL PACKAGES_ERROR_MSG('PTRACERS',' ',myThid)
223    #endif
224    
225    #ifdef ALLOW_GCHEM
226          IF (useGCHEM) CALL GCHEM_CHECK( myThid )
227    #else
228          IF (useGCHEM) CALL PACKAGES_ERROR_MSG('GCHEM',' ',myThid)
229    #endif
230    
231    #ifndef ALLOW_RBCS
232          IF (useRBCS) CALL PACKAGES_ERROR_MSG('RBCS',' ',myThid)
233    #endif
234    
235    #ifndef ALLOW_OFFLINE
236          IF (useOffLine) CALL PACKAGES_ERROR_MSG('OffLine',' ',myThid)
237    #endif
238    
239    #ifndef ALLOW_MATRIX
240          IF (useMATRIX) CALL PACKAGES_ERROR_MSG('MATRIX',' ',myThid)
241    #endif
242    
243    #ifndef ALLOW_FRAZIL
244          IF (useFRAZIL) CALL PACKAGES_ERROR_MSG('FRAZIL',' ',myThid)
245  #endif  #endif
246    
247  #ifdef ALLOW_SEAICE  #ifdef ALLOW_SEAICE
248        IF (useSEAICE) CALL SEAICE_CHECK( myThid )        IF (useSEAICE) CALL SEAICE_CHECK( myThid )
249  #else  #else
250        IF (useSEAICE) CALL PACKAGES_CHECK_ERROR('SEAICE', myThid)        IF (useSEAICE) CALL PACKAGES_ERROR_MSG('SEAICE',' ',myThid)
251    #endif
252    
253    #ifdef ALLOW_SALT_PLUME
254          IF (useSALT_PLUME)CALL SALT_PLUME_CHECK( myThid )
255    #else
256          IF (useSALT_PLUME)CALL PACKAGES_ERROR_MSG('SALT_PLUME',' ',myThid)
257    #endif
258    
259    #ifdef ALLOW_SHELFICE
260          IF (useShelfIce) CALL SHELFICE_CHECK( myThid )
261    #else
262          IF (useShelfIce) CALL PACKAGES_ERROR_MSG('ShelfIce',' ',myThid)
263  #endif  #endif
264    
265    #ifdef ALLOW_STREAMICE
266          IF (useStreamIce) CALL STREAMICE_CHECK( myThid )
267    #else
268          IF (useStreamIce) CALL PACKAGES_ERROR_MSG('StreamIce',' ',myThid)
269    #endif
270    
271    #ifdef ALLOW_ICEFRONT
272          IF (useICEFRONT) CALL ICEFRONT_CHECK( myThid )
273    #else
274          IF (useICEFRONT) CALL PACKAGES_ERROR_MSG('ICEFRONT',' ',myThid)
275    #endif
276    
277    #ifdef ALLOW_THSICE
278          IF (useThSIce) CALL THSICE_CHECK( myThid )
279    #else
280          IF (useThSIce) CALL PACKAGES_ERROR_MSG('ThSIce',' ',myThid)
281    #endif
282    
283    #ifndef ALLOW_LAND
284          IF (useLand) CALL PACKAGES_ERROR_MSG('Land',' ',myThid)
285    #endif
286    
287    #ifndef ALLOW_ATM2D
288          IF (useATM2D) CALL PACKAGES_ERROR_MSG('ATM2D',' ',myThid)
289    #endif
290    
291    #ifndef ALLOW_AIM
292          IF (useAIM) CALL PACKAGES_ERROR_MSG('AIM',' ',myThid)
293    #endif
294    
295    #ifndef ALLOW_ATM_PHYS
296          IF (useAtm_Phys) CALL PACKAGES_ERROR_MSG('Atm_Phys',' ',myThid)
297    #endif
298    
299    #ifndef ALLOW_FIZHI
300          IF (useFizhi) CALL PACKAGES_ERROR_MSG('Fizhi',' ',myThid)
301    #endif
302    
303    #ifndef ALLOW_GRIDALT
304          IF (useGridAlt) CALL PACKAGES_ERROR_MSG('GridAlt',' ',myThid)
305    #endif
306    
307    #ifdef ALLOW_AUTODIFF
308          CALL AUTODIFF_CHECK( myThid )
309    #endif
310    
311    #ifdef ALLOW_CTRL
312          CALL CTRL_CHECK( myThid )
313    #endif
314    
315    #ifdef ALLOW_COST
316          CALL COST_CHECK( myThid )
317    #endif
318    
319    #ifdef ALLOW_GRDCHK
320          IF (useGRDCHK) CALL GRDCHK_CHECK( myThid )
321    #endif
322    
323    #ifndef ALLOW_SMOOTH
324          IF (useSMOOTH) CALL PACKAGES_ERROR_MSG('SMOOTH',' ',myThid)
325    #endif
326    
327    #ifndef ALLOW_PROFILES
328          IF (usePROFILES) CALL PACKAGES_ERROR_MSG('PROFILES',' ',myThid)
329    #endif
330    
331    #ifdef ALLOW_SBO
332          IF (useSBO) CALL SBO_CHECK( myThid )
333    #else
334          IF (useSBO) CALL PACKAGES_ERROR_MSG('SBO',' ',myThid)
335    #endif
336    
337    #ifdef ALLOW_ECCO
338          CALL ECCO_CHECK( myThid )
339    #endif
340    
341    #ifdef ALLOW_DIAGNOSTICS
342          IF (useDiagnostics) CALL DIAGNOSTICS_CHECK( myThid )
343    #else
344          IF (useDiagnostics)
345         &   CALL PACKAGES_ERROR_MSG( 'Diagnostics', ' ', myThid )
346    #endif
347    
348    #ifdef ALLOW_REGRID
349          IF (useREGRID) CALL REGRID_CHECK( myThid )
350    #else
351          IF (useREGRID) CALL PACKAGES_ERROR_MSG('REGRID',' ',myThid)
352    #endif
353    
354    #ifdef ALLOW_LAYERS
355          IF ( useLayers ) CALL LAYERS_CHECK( myThid )
356    #else
357          IF ( useLayers ) CALL PACKAGES_ERROR_MSG('LAYERS',' ',myThid)
358    #endif /* ALLOW_LAYERS */
359    
360    #ifdef ALLOW_NEST_CHILD
361          IF (useNEST_CHILD) CALL NEST_CHILD_CHECK( myThid )
362    #else
363          IF (useNEST_CHILD) CALL PACKAGES_ERROR_MSG(
364         & 'NEST_CHILD',' ',myThid)
365    #endif
366    
367    #ifdef ALLOW_NEST_PARENT
368          IF (useNEST_PARENT) CALL NEST_PARENT_CHECK( myThid )
369    #else
370          IF (useNEST_PARENT) CALL PACKAGES_ERROR_MSG(
371         & 'NEST_PARENT',' ',myThid)
372    #endif
373    
374    #ifdef ALLOW_OASIS
375          IF (useOASIS) CALL OASIS_CHECK( myThid )
376    #else
377          IF (useOASIS) CALL PACKAGES_ERROR_MSG('OASIS',' ',myThid)
378    #endif
379    
380    #ifdef ALLOW_RUNCLOCK
381          IF (useRunClock) CALL RUNCLOCK_CHECK( myThid )
382    #else
383          IF (useRunClock) CALL PACKAGES_ERROR_MSG('RunClock',' ',myThid)
384    #endif
385    
386    #ifndef ALLOW_EMBED_FILES
387          IF (useEMBED_FILES) CALL PACKAGES_ERROR_MSG(
388         &                                  'EMBED_FILES',' ',myThid)
389    #endif
390    
391    #ifdef ALLOW_MYPACKAGE
392          IF (useMYPACKAGE) CALL MYPACKAGE_CHECK( myThid )
393    #else
394          IF (useMYPACKAGE) CALL PACKAGES_ERROR_MSG('MYPACKAGE',' ',myThid)
395    #endif
396    
397    #ifdef ALLOW_GENERIC_ADVDIFF
398    C-    Check generic AdvDiff setting and related overlap minimum size:
399    C     for this reason, called after other ${pkg}_check S/R
400          IF (useGAD) CALL GAD_CHECK( myThid )
401    #endif
402    
403    C---  Exclusive packages (which cannot be used together):
404          IF ( useEXF .AND. useBulkForce ) THEN
405            WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
406         &  'both useEXF and useBulkForce 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            CALL ALL_PROC_DIE( myThid )
412            STOP 'ABNORMAL END: S/R PACKAGES_CHECK'
413          ENDIF
414    
415    C---  Exclusive packages (which cannot be used together):
416          IF ( useDOWN_SLOPE .AND. useBBL ) THEN
417            WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
418         &  'both useDOWN_SLOPE and useBBL are set'
419            CALL PRINT_ERROR( msgBuf , myThid )
420            WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
421         &  ' but cannot be used together => need to select only one.'
422            CALL PRINT_ERROR( msgBuf , myThid )
423            CALL ALL_PROC_DIE( myThid )
424            STOP 'ABNORMAL END: S/R PACKAGES_CHECK'
425          ENDIF
426    
427        RETURN        RETURN
428        END        END
Legend:
Removed from v.1.12  
changed lines
  Added in v.1.62
  ViewVC Help
Powered by ViewVC 1.1.22