/[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.33 by jmc, Fri Mar 17 03:55:43 2006 UTC revision 1.48 by dimitri, Wed Jan 20 23:33:45 2010 UTC
# Line 10  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 35  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  c     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    #ifdef ALLOW_GENERIC_ADVDIFF
91          IF (useGAD) CALL GAD_CHECK( myThid )
92    #else
93          IF ( tempStepping .OR. saltStepping ) THEN
94            WRITE(msgBuf,'(2A)')
95         &  'PACKAGES_CHECK: cannot step forward Temp or Salt',
96         &  ' without pkg/generic_advdiff'
97            CALL PRINT_ERROR( msgBuf , myThid )
98            WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
99         &  'Re-compile with pkg "generic_advdiff" in packages.conf'
100            CALL PRINT_ERROR( msgBuf , myThid )
101            STOP 'ABNORMAL END: S/R PACKAGES_CHECK'
102          ENDIF
103    #endif
104    
105    #ifndef ALLOW_MONITOR
106    C     If monitorFreq is finite, make sure the pkg/monitor is being compiled
107          IF (monitorFreq.NE.0.) CALL PACKAGES_ERROR_MSG(
108         &                  'MONITOR', 'monitorFreq <> 0', myThid )
109    #endif
110    
111    #ifndef ALLOW_TIMEAVE
112    C     If taveFreq is finite, make sure the pkg/timeave is being compiled
113          IF (taveFreq.NE.0.) CALL PACKAGES_ERROR_MSG(
114         &                  'TIMEAVE', 'taveFreq <> 0', myThid )
115    #endif
116    
117    #ifndef ALLOW_CD_CODE
118          IF (useCDscheme) CALL PACKAGES_ERROR_MSG(
119         &                  'CD_CODE', 'useCDscheme=.T.', myThid )
120    #endif
121    
122    C---  Continue with standard packages (with standard usePKG flag)
123    
124  #ifdef ALLOW_RUNCLOCK  #ifdef ALLOW_RUNCLOCK
125        IF (useRunClock) CALL RUNCLOCK_CHECK( myThid )        IF (useRunClock) CALL RUNCLOCK_CHECK( myThid )
126  #else  #else
127        IF (useRunClock) CALL PACKAGES_CHECK_ERROR('RUNCLOCK', myThid)        IF (useRunClock) CALL PACKAGES_ERROR_MSG('RunClock',' ',myThid)
128  #endif  #endif
129    
130  #ifdef ALLOW_KPP  #ifdef ALLOW_KPP
131        IF (useKPP) CALL KPP_CHECK( myThid )        IF (useKPP) CALL KPP_CHECK( myThid )
132  #else  #else
133        IF (useKPP) CALL PACKAGES_CHECK_ERROR('KPP', myThid)        IF (useKPP) CALL PACKAGES_ERROR_MSG('KPP',' ',myThid)
134  #endif  #endif
135    
136  #ifdef ALLOW_PP81  #ifdef ALLOW_PP81
137        IF (usePP81) CALL PP81_CHECK( myThid )        IF (usePP81) CALL PP81_CHECK( myThid )
138  #else  #else
139        IF (usePP81) CALL PACKAGES_CHECK_ERROR('PP81', myThid)        IF (usePP81) CALL PACKAGES_ERROR_MSG('PP81',' ',myThid)
140  #endif  #endif
141    
142  #ifdef ALLOW_MY82  #ifdef ALLOW_MY82
143        IF (useMY82) CALL MY82_CHECK( myThid )        IF (useMY82) CALL MY82_CHECK( myThid )
144  #else  #else
145        IF (useMY82) CALL PACKAGES_CHECK_ERROR('MY82', myThid)        IF (useMY82) CALL PACKAGES_ERROR_MSG('MY82',' ',myThid)
146  #endif  #endif
147    
148  #ifdef ALLOW_GGL90  #ifdef ALLOW_GGL90
149        IF (useGGL90) CALL GGL90_CHECK( myThid )        IF (useGGL90) CALL GGL90_CHECK( myThid )
150  #else  #else
151        IF (useGGL90) CALL PACKAGES_CHECK_ERROR('GGL90', myThid)        IF (useGGL90) CALL PACKAGES_ERROR_MSG('GGL90',' ',myThid)
152  #endif  #endif
153    
154  #ifdef ALLOW_OPPS  #ifdef ALLOW_OPPS
155        IF (useOPPS) CALL OPPS_CHECK( myThid )        IF (useOPPS) CALL OPPS_CHECK( myThid )
156  #else  #else
157        IF (useOPPS) CALL PACKAGES_CHECK_ERROR('OPPS', myThid)        IF (useOPPS) CALL PACKAGES_ERROR_MSG('OPPS',' ',myThid)
158  #endif  #endif
159    
160  #ifdef ALLOW_GMREDI  #ifdef ALLOW_GMREDI
161        IF (useGMRedi) CALL GMREDI_CHECK( myThid )        IF (useGMRedi) CALL GMREDI_CHECK( myThid )
162  #else  #else
163        IF (useGMRedi) CALL PACKAGES_CHECK_ERROR('GMREDI', myThid)        IF (useGMRedi) CALL PACKAGES_ERROR_MSG('GMRedi',' ',myThid)
164    #endif
165    
166    #ifndef ALLOW_DOWN_SLOPE
167          IF (useDOWN_SLOPE)
168         &            CALL PACKAGES_ERROR_MSG('DOWN_SLOPE',' ',myThid)
169  #endif  #endif
170    
171  #ifdef ALLOW_OBCS  #ifdef ALLOW_OBCS
172        IF (useOBCS) CALL OBCS_CHECK( myThid )        IF (useOBCS) CALL OBCS_CHECK( myThid )
173  #else  #else
174        IF (useOBCS) CALL PACKAGES_CHECK_ERROR('OBCS', myThid)        IF (useOBCS) CALL PACKAGES_ERROR_MSG('OBCS',' ',myThid)
175    #endif
176    
177    #ifndef ALLOW_EXF
178          IF (useEXF) CALL PACKAGES_ERROR_MSG('EXF',' ',myThid)
179  #endif  #endif
180    
181  #ifndef ALLOW_BULK_FORCE  #ifndef ALLOW_BULK_FORCE
182        IF (useBulkForce) CALL PACKAGES_CHECK_ERROR('BULK?FORCE',myThid)        IF (useBulkForce) CALL PACKAGES_ERROR_MSG(
183         &                  'BULK_FORCE', 'useBulkForce=.T.', myThid )
184  #endif  #endif
185    
186  #ifndef ALLOW_THSICE  #ifdef ALLOW_THSICE
187        IF (useThSIce) CALL PACKAGES_CHECK_ERROR('THSICE', myThid)        IF (useThSIce) CALL THSICE_CHECK( myThid )
188    #else
189          IF (useThSIce) CALL PACKAGES_ERROR_MSG('ThSIce',' ',myThid)
190    #endif
191    
192    #ifndef ALLOW_ATM2D
193          IF (useATM2D) CALL PACKAGES_ERROR_MSG('ATM2D',' ',myThid)
194  #endif  #endif
195    
196  #ifndef ALLOW_AIM  #ifndef ALLOW_AIM
197        IF (useAIM) CALL PACKAGES_CHECK_ERROR('AIM', myThid)        IF (useAIM) CALL PACKAGES_ERROR_MSG('AIM',' ',myThid)
198  #endif  #endif
199    
200  #ifndef ALLOW_LAND  #ifndef ALLOW_LAND
201        IF (useLand) CALL PACKAGES_CHECK_ERROR('LAND', myThid)        IF (useLand) CALL PACKAGES_ERROR_MSG('LAND',' ',myThid)
202  #endif  #endif
203    
204  #ifndef ALLOW_PTRACERS  #ifndef ALLOW_PTRACERS
205        IF (usePTRACERS) CALL PACKAGES_CHECK_ERROR('PTRACERS', myThid)        IF (usePTRACERS) CALL PACKAGES_ERROR_MSG('PTRACERS',' ',myThid)
206  #endif  #endif
207    
208  #ifndef ALLOW_MATRIX  #ifndef ALLOW_MATRIX
209        IF (useMATRIX) CALL PACKAGES_CHECK_ERROR('MATRIX', myThid)        IF (useMATRIX) CALL PACKAGES_ERROR_MSG('MATRIX',' ',myThid)
210  #endif  #endif
211    
212  #ifdef ALLOW_GCHEM  #ifdef ALLOW_GCHEM
213        IF (useGCHEM) CALL GCHEM_CHECK( myThid )        IF (useGCHEM) CALL GCHEM_CHECK( myThid )
214  #else  #else
215        IF (useGCHEM) CALL PACKAGES_CHECK_ERROR('GCHEM', myThid)        IF (useGCHEM) CALL PACKAGES_ERROR_MSG('GCHEM',' ',myThid)
216  #endif  #endif
217    
218  #ifndef ALLOW_OFFLINE  #ifndef ALLOW_OFFLINE
219        IF (useOffLine) CALL PACKAGES_CHECK_ERROR('OFFLINE', myThid)        IF (useOffLine) CALL PACKAGES_ERROR_MSG('OffLine',' ',myThid)
220  #endif  #endif
221    
222  #ifndef ALLOW_SHAP_FILT  #ifndef ALLOW_SHAP_FILT
223        IF (useSHAP_FILT) CALL PACKAGES_CHECK_ERROR('SHAP_FILT', myThid)        IF (useSHAP_FILT)
224         &   CALL PACKAGES_ERROR_MSG( 'SHAP_FILT', ' ', myThid )
225  #endif  #endif
226    
227  #ifndef ALLOW_ZONAL_FILT  #ifndef ALLOW_ZONAL_FILT
228        IF (useZONAL_FILT) CALL PACKAGES_CHECK_ERROR('ZONAL_FILT',myThid)        IF (useZONAL_FILT)
229         &   CALL PACKAGES_ERROR_MSG( 'ZONAL_FILT', ' ', myThid )
230  #endif  #endif
231    
232  #ifndef ALLOW_FLT  #ifndef ALLOW_FLT
233        IF (useFLT) CALL PACKAGES_CHECK_ERROR('FLT', myThid)        IF (useFLT) CALL PACKAGES_ERROR_MSG('FLT',' ',myThid)
234  #endif  #endif
235    
236  #ifdef ALLOW_SBO  #ifdef ALLOW_SBO
237        IF (useSBO) CALL SBO_CHECK( myThid )        IF (useSBO) CALL SBO_CHECK( myThid )
238  #else  #else
239        IF (useSBO) CALL PACKAGES_CHECK_ERROR('SBO', myThid)        IF (useSBO) CALL PACKAGES_ERROR_MSG('SBO',' ',myThid)
240  #endif  #endif
241    
242  #ifdef ALLOW_SEAICE  #ifdef ALLOW_SEAICE
243        IF (useSEAICE) CALL SEAICE_CHECK( myThid )        IF (useSEAICE) CALL SEAICE_CHECK( myThid )
244  #else  #else
245        IF (useSEAICE) CALL PACKAGES_CHECK_ERROR('SEAICE', myThid)        IF (useSEAICE) CALL PACKAGES_ERROR_MSG('SEAICE',' ',myThid)
246  #endif  #endif
247    
248  #ifdef ALLOW_SHELFICE  #ifdef ALLOW_SHELFICE
249        IF (useShelfIce) CALL SHELFICE_CHECK( myThid )        IF (useShelfIce) CALL SHELFICE_CHECK( myThid )
250  #else  #else
251        IF (useShelfIce) CALL PACKAGES_CHECK_ERROR('SHELFICE', myThid)        IF (useShelfIce) CALL PACKAGES_ERROR_MSG('ShelfIce',' ',myThid)
252  #endif  #endif
253    
254  #ifndef ALLOW_CD_CODE  #ifdef ALLOW_ICEFRONT
255        IF (useCDscheme) CALL PACKAGES_CHECK_ERROR('CD_CODE', myThid)        IF (useICEFRONT) CALL ICEFRONT_CHECK( myThid )
256    #else
257          IF (useICEFRONT) CALL PACKAGES_ERROR_MSG('ICEFRONT',' ',myThid)
258  #endif  #endif
259    
260  #ifdef ALLOW_AUTODIFF  #ifdef ALLOW_AUTODIFF
# Line 168  CEOP Line 270  CEOP
270  #endif  #endif
271    
272  #ifdef ALLOW_GRDCHK  #ifdef ALLOW_GRDCHK
273        CALL GRDCHK_CHECK( myThid )        IF (useGRDCHK) CALL GRDCHK_CHECK( myThid )
274  #endif  #endif
275    
276  #ifdef ALLOW_DIAGNOSTICS  #ifdef ALLOW_DIAGNOSTICS
277        IF (useDiagnostics) CALL DIAGNOSTICS_CHECK( myThid )        IF (useDiagnostics) CALL DIAGNOSTICS_CHECK( myThid )
278  #else  #else
279        IF (useDiagnostics)        IF (useDiagnostics)
280       &   CALL PACKAGES_CHECK_ERROR('DIAGNOSTICS', myThid )       &   CALL PACKAGES_ERROR_MSG( 'Diagnostics', ' ', myThid )
281    #endif
282    
283    #ifdef ALLOW_REGRID
284          IF (useREGRID) CALL REGRID_CHECK( myThid )
285    #else
286          IF (useREGRID) CALL PACKAGES_ERROR_MSG('REGRID',' ',myThid)
287  #endif  #endif
288    
289    #ifdef ALLOW_LAYERS
290          IF ( useLayers ) CALL LAYERS_CHECK( myThid )
291    #else
292          IF ( useLayers ) CALL PACKAGES_ERROR_MSG('LAYERS',' ',myThid)
293    #endif /* ALLOW_LAYERS */
294    
295    #ifdef ALLOW_NEST_CHILD
296          IF (useNEST_CHILD) CALL NEST_CHILD_CHECK( myThid )
297    #else
298          IF (useNEST_CHILD) CALL PACKAGES_ERROR_MSG(
299         & 'NEST_CHILD',' ',myThid)
300    #endif
301    
302    #ifdef ALLOW_NEST_PARENT
303          IF (useNEST_PARENT) CALL NEST_PARENT_CHECK( myThid )
304    #else
305          IF (useNEST_PARENT) CALL PACKAGES_ERROR_MSG(
306         & 'NEST_PARENT',' ',myThid)
307    #endif
308    
309    #ifdef ALLOW_MYPACKAGE
310          IF (useMYPACKAGE) CALL MYPACKAGE_CHECK( myThid )
311    #else
312          IF (useMYPACKAGE) CALL PACKAGES_ERROR_MSG('MYPACKAGE',' ',myThid)
313    #endif
314    
315    #ifdef ALLOW_SALT_PLUME
316          IF (useSALT_PLUME)CALL SALT_PLUME_CHECK( myThid )
317    #else
318          IF (useSALT_PLUME)CALL PACKAGES_ERROR_MSG('SALT_PLUME',' ',myThid)
319    #endif
320    
321    #ifdef ALLOW_ECCO
322          CALL ECCO_CHECK( myThid )
323    #endif
324    
325    C---  Exclusive packages (which cannot be used together):
326          IF ( useEXF .AND. useBulkForce ) THEN
327            WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
328         &  'both useEXF and useBulkForce are set'
329            CALL PRINT_ERROR( msgBuf , myThid )
330            WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
331         &  ' but cannot be used together => need to select only one.'
332            CALL PRINT_ERROR( msgBuf , myThid )
333            STOP 'ABNORMAL END: S/R PACKAGES_CHECK'
334          ENDIF
335    
336        RETURN        RETURN
337        END        END
Legend:
Removed from v.1.33  
changed lines
  Added in v.1.48
  ViewVC Help
Powered by ViewVC 1.1.22