/[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.55 by dimitri, Sun Aug 7 07:08:15 2011 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 34  C     myThid ::  Number of this instance Line 35  C     myThid ::  Number of this instance
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          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    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            CALL PRINT_ERROR( msgBuf , myThid )
71            WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
72         &   'Re-compile with pkg "mom_vecinv" in packages.conf'
73            CALL PRINT_ERROR( msgBuf , myThid )
74            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            CALL PRINT_ERROR( msgBuf , myThid )
83            WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
84         &   'Re-compile with pkg "mom_fluxform" in packages.conf'
85            CALL PRINT_ERROR( msgBuf , myThid )
86            STOP 'ABNORMAL END: S/R PACKAGES_CHECK'
87          ENDIF
88    #endif
89    
90    #ifndef ALLOW_GENERIC_ADVDIFF
91          IF ( tempStepping .OR. saltStepping ) THEN
92            WRITE(msgBuf,'(2A)')
93         &  'PACKAGES_CHECK: cannot step forward Temp or Salt',
94         &  ' without pkg/generic_advdiff'
95            CALL PRINT_ERROR( msgBuf , myThid )
96            WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
97         &  'Re-compile with pkg "generic_advdiff" in packages.conf'
98            CALL PRINT_ERROR( msgBuf , myThid )
99            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          IF (monitorFreq.NE.0.) CALL PACKAGES_ERROR_MSG(
106         &                  'MONITOR', 'monitorFreq <> 0', myThid )
107    #endif
108    
109    #ifndef ALLOW_TIMEAVE
110    C     If taveFreq is finite, make sure the pkg/timeave is being compiled
111          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    #endif
119    
120    C---  Continue with standard packages (with standard usePKG flag)
121    
122    #ifdef ALLOW_RUNCLOCK
123          IF (useRunClock) CALL RUNCLOCK_CHECK( myThid )
124    #else
125          IF (useRunClock) CALL PACKAGES_ERROR_MSG('RunClock',' ',myThid)
126    #endif
127    
128  #ifdef ALLOW_KPP  #ifdef ALLOW_KPP
129        IF (useKPP) CALL KPP_CHECK( myThid )        IF (useKPP) CALL KPP_CHECK( myThid )
130  #else  #else
131        IF (useKPP) CALL PACKAGES_CHECK_ERROR('KPP', myThid)        IF (useKPP) CALL PACKAGES_ERROR_MSG('KPP',' ',myThid)
132    #endif
133    
134    #ifdef ALLOW_PP81
135          IF (usePP81) CALL PP81_CHECK( myThid )
136    #else
137          IF (usePP81) CALL PACKAGES_ERROR_MSG('PP81',' ',myThid)
138    #endif
139    
140    #ifdef ALLOW_MY82
141          IF (useMY82) CALL MY82_CHECK( myThid )
142    #else
143          IF (useMY82) CALL PACKAGES_ERROR_MSG('MY82',' ',myThid)
144    #endif
145    
146    #ifdef ALLOW_GGL90
147          IF (useGGL90) CALL GGL90_CHECK( myThid )
148    #else
149          IF (useGGL90) CALL PACKAGES_ERROR_MSG('GGL90',' ',myThid)
150    #endif
151    
152    #ifdef ALLOW_OPPS
153          IF (useOPPS) CALL OPPS_CHECK( myThid )
154    #else
155          IF (useOPPS) CALL PACKAGES_ERROR_MSG('OPPS',' ',myThid)
156  #endif  #endif
157    
158  #ifdef ALLOW_GMREDI  #ifdef ALLOW_GMREDI
159        IF (useGMRedi) CALL GMREDI_CHECK( myThid )        IF (useGMRedi) CALL GMREDI_CHECK( myThid )
160  #else  #else
161        IF (useGMRedi) CALL PACKAGES_CHECK_ERROR('GMREDI', myThid)        IF (useGMRedi) CALL PACKAGES_ERROR_MSG('GMRedi',' ',myThid)
162    #endif
163    
164    #ifndef ALLOW_DOWN_SLOPE
165          IF (useDOWN_SLOPE)
166         &            CALL PACKAGES_ERROR_MSG('DOWN_SLOPE',' ',myThid)
167    #endif
168    
169    #ifdef ALLOW_BBL
170          IF (useBBL) CALL BBL_CHECK( myThid )
171    #else
172          IF (useBBL) CALL PACKAGES_ERROR_MSG('BBL',' ',myThid)
173  #endif  #endif
174    
175  #ifdef ALLOW_OBCS  #ifdef ALLOW_OBCS
176        IF (useOBCS) CALL OBCS_CHECK( myThid )        IF (useOBCS) CALL OBCS_CHECK( myThid )
177  #else  #else
178        IF (useOBCS) CALL PACKAGES_CHECK_ERROR('OBCS', myThid)        IF (useOBCS) CALL PACKAGES_ERROR_MSG('OBCS',' ',myThid)
179    #endif
180    
181    #ifdef ALLOW_EXF
182          IF (useEXF) CALL EXF_CHECK( myThid )
183    #else
184          IF (useEXF) CALL PACKAGES_ERROR_MSG('EXF',' ',myThid)
185    #endif
186    
187    #ifndef ALLOW_BULK_FORCE
188          IF (useBulkForce) CALL PACKAGES_ERROR_MSG(
189         &                  'BULK_FORCE', 'useBulkForce=.T.', myThid )
190    #endif
191    
192    #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    #ifdef ALLOW_THSICE
201          IF (useThSIce) CALL THSICE_CHECK( myThid )
202    #else
203          IF (useThSIce) CALL PACKAGES_ERROR_MSG('ThSIce',' ',myThid)
204    #endif
205    
206    #ifndef ALLOW_ATM2D
207          IF (useATM2D) CALL PACKAGES_ERROR_MSG('ATM2D',' ',myThid)
208  #endif  #endif
209    
210  #ifndef ALLOW_AIM  #ifndef ALLOW_AIM
211        IF (useAIM) CALL PACKAGES_CHECK_ERROR('AIM', myThid)        IF (useAIM) CALL PACKAGES_ERROR_MSG('AIM',' ',myThid)
212    #endif
213    
214    #ifndef ALLOW_LAND
215          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  #endif  #endif
225    
226  #ifndef ALLOW_PTRACERS  #ifndef ALLOW_PTRACERS
227        IF (usePTRACERS) CALL PACKAGES_CHECK_ERROR('PTRACERS', myThid)        IF (usePTRACERS) CALL PACKAGES_ERROR_MSG('PTRACERS',' ',myThid)
228    #endif
229    
230    #ifdef ALLOW_GCHEM
231          IF (useGCHEM) CALL GCHEM_CHECK( myThid )
232    #else
233          IF (useGCHEM) CALL PACKAGES_ERROR_MSG('GCHEM',' ',myThid)
234    #endif
235    
236    #ifndef ALLOW_RBCS
237          IF (useRBCS) CALL PACKAGES_ERROR_MSG('RBCS',' ',myThid)
238    #endif
239    
240    #ifndef ALLOW_OFFLINE
241          IF (useOffLine) CALL PACKAGES_ERROR_MSG('OffLine',' ',myThid)
242    #endif
243    
244    #ifndef ALLOW_MATRIX
245          IF (useMATRIX) CALL PACKAGES_ERROR_MSG('MATRIX',' ',myThid)
246  #endif  #endif
247    
248  #ifndef ALLOW_SHAP_FILT  #ifndef ALLOW_SHAP_FILT
249        IF (useSHAP_FILT) CALL PACKAGES_CHECK_ERROR('SHAP_FILT', myThid)        IF (useSHAP_FILT)
250         &   CALL PACKAGES_ERROR_MSG( 'SHAP_FILT', ' ', myThid )
251  #endif  #endif
252    
253  #ifndef ALLOW_ZONAL_FILT  #ifndef ALLOW_ZONAL_FILT
254        IF (useZONAL_FILT) CALL PACKAGES_CHECK_ERROR('ZONAL_FILT',myThid)        IF (useZONAL_FILT)
255         &   CALL PACKAGES_ERROR_MSG( 'ZONAL_FILT', ' ', myThid )
256  #endif  #endif
257    
258  #ifndef ALLOW_FLT  #ifndef ALLOW_FLT
259        IF (useFLT) CALL PACKAGES_CHECK_ERROR('FLT', myThid)        IF (useFLT) CALL PACKAGES_ERROR_MSG('FLT',' ',myThid)
260    #endif
261    
262    #ifdef ALLOW_SBO
263          IF (useSBO) CALL SBO_CHECK( myThid )
264    #else
265          IF (useSBO) CALL PACKAGES_ERROR_MSG('SBO',' ',myThid)
266  #endif  #endif
267    
268  #ifdef ALLOW_SEAICE  #ifdef ALLOW_SEAICE
269        IF (useSEAICE) CALL SEAICE_CHECK( myThid )        IF (useSEAICE) CALL SEAICE_CHECK( myThid )
270  #else  #else
271        IF (useSEAICE) CALL PACKAGES_CHECK_ERROR('SEAICE', myThid)        IF (useSEAICE) CALL PACKAGES_ERROR_MSG('SEAICE',' ',myThid)
272    #endif
273    
274    #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    #ifdef ALLOW_SHELFICE
281          IF (useShelfIce) CALL SHELFICE_CHECK( myThid )
282    #else
283          IF (useShelfIce) CALL PACKAGES_ERROR_MSG('ShelfIce',' ',myThid)
284    #endif
285    
286    #ifdef ALLOW_ICEFRONT
287          IF (useICEFRONT) CALL ICEFRONT_CHECK( myThid )
288    #else
289          IF (useICEFRONT) CALL PACKAGES_ERROR_MSG('ICEFRONT',' ',myThid)
290    #endif
291    
292    #ifdef ALLOW_AUTODIFF
293          CALL AUTODIFF_CHECK( myThid )
294    #endif
295    
296    #ifdef ALLOW_CTRL
297          CALL CTRL_CHECK( myThid )
298    #endif
299    
300    #ifdef ALLOW_COST
301          CALL COST_CHECK( myThid )
302    #endif
303    
304    #ifdef ALLOW_GRDCHK
305          IF (useGRDCHK) CALL GRDCHK_CHECK( myThid )
306    #endif
307    
308    #ifndef ALLOW_SMOOTH
309          IF (useSMOOTH) CALL PACKAGES_ERROR_MSG('SMOOTH',' ',myThid)
310    #endif
311    
312    #ifdef ALLOW_DIAGNOSTICS
313          IF (useDiagnostics) CALL DIAGNOSTICS_CHECK( myThid )
314    #else
315          IF (useDiagnostics)
316         &   CALL PACKAGES_ERROR_MSG( 'Diagnostics', ' ', myThid )
317    #endif
318    
319    #ifdef ALLOW_REGRID
320          IF (useREGRID) CALL REGRID_CHECK( myThid )
321    #else
322          IF (useREGRID) CALL PACKAGES_ERROR_MSG('REGRID',' ',myThid)
323    #endif
324    
325    #ifdef ALLOW_LAYERS
326          IF ( useLayers ) CALL LAYERS_CHECK( myThid )
327    #else
328          IF ( useLayers ) CALL PACKAGES_ERROR_MSG('LAYERS',' ',myThid)
329    #endif /* ALLOW_LAYERS */
330    
331    #ifdef ALLOW_NEST_CHILD
332          IF (useNEST_CHILD) CALL NEST_CHILD_CHECK( myThid )
333    #else
334          IF (useNEST_CHILD) CALL PACKAGES_ERROR_MSG(
335         & 'NEST_CHILD',' ',myThid)
336    #endif
337    
338    #ifdef ALLOW_NEST_PARENT
339          IF (useNEST_PARENT) CALL NEST_PARENT_CHECK( myThid )
340    #else
341          IF (useNEST_PARENT) CALL PACKAGES_ERROR_MSG(
342         & 'NEST_PARENT',' ',myThid)
343    #endif
344    
345    #ifdef ALLOW_OASIS
346          IF (useOASIS) CALL OASIS_CHECK( myThid )
347    #else
348          IF (useOASIS) CALL PACKAGES_ERROR_MSG('OASIS',' ',myThid)
349    #endif
350    
351    #ifdef ALLOW_ECCO
352          CALL ECCO_CHECK( myThid )
353    #endif
354    
355    #ifndef ALLOW_EMBED_FILES
356          IF (useEMBED_FILES) CALL PACKAGES_ERROR_MSG(
357         &                                  'EMBED_FILES',' ',myThid)
358    #endif
359    
360    #ifdef ALLOW_MYPACKAGE
361          IF (useMYPACKAGE) CALL MYPACKAGE_CHECK( myThid )
362    #else
363          IF (useMYPACKAGE) CALL PACKAGES_ERROR_MSG('MYPACKAGE',' ',myThid)
364  #endif  #endif
365    
366    #ifdef ALLOW_GENERIC_ADVDIFF
367    C-    Check generic AdvDiff setting and related overlap minimum size:
368    C     for this reason, called after other ${pkg}_check S/R
369          IF (useGAD) CALL GAD_CHECK( myThid )
370    #endif
371    
372    C---  Exclusive packages (which cannot be used together):
373          IF ( useEXF .AND. useBulkForce ) THEN
374            WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
375         &  'both useEXF and useBulkForce are set'
376            CALL PRINT_ERROR( msgBuf , myThid )
377            WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
378         &  ' but cannot be used together => need to select only one.'
379            CALL PRINT_ERROR( msgBuf , myThid )
380            STOP 'ABNORMAL END: S/R PACKAGES_CHECK'
381          ENDIF
382    
383    C---  Exclusive packages (which cannot be used together):
384          IF ( useDOWN_SLOPE .AND. useBBL ) THEN
385            WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
386         &  'both useDOWN_SLOPE and useBBL are set'
387            CALL PRINT_ERROR( msgBuf , myThid )
388            WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
389         &  ' but cannot be used together => need to select only one.'
390            CALL PRINT_ERROR( msgBuf , myThid )
391            STOP 'ABNORMAL END: S/R PACKAGES_CHECK'
392          ENDIF
393    
394        RETURN        RETURN
395        END        END
Legend:
Removed from v.1.12  
changed lines
  Added in v.1.55
  ViewVC Help
Powered by ViewVC 1.1.22