/[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.20 by edhill, Thu Oct 30 12:00:41 2003 UTC revision 1.65 by jmc, Wed May 28 22:01:57 2014 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 30  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_BULK_FORCE  #ifndef ALLOW_DOWN_SLOPE
188        IF (useBulkforce) CALL PACKAGES_CHECK_ERROR('BULK?FORCE',myThid)        IF (useDOWN_SLOPE)
189         &            CALL PACKAGES_ERROR_MSG('DOWN_SLOPE',' ',myThid)
190  #endif  #endif
191    
192  #ifndef ALLOW_THERM_SEAICE  #ifndef ALLOW_CAL
193        IF (useThermSeaIce)        IF (useCAL) CALL PACKAGES_ERROR_MSG('CAL',' ',myThid)
      &   CALL PACKAGES_CHECK_ERROR('THERM?SEAICE', myThid)  
194  #endif  #endif
195    
196  #ifndef ALLOW_AIM  #ifdef ALLOW_EXF
197        IF (useAIM) CALL PACKAGES_CHECK_ERROR('AIM', 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_LAND  #ifndef ALLOW_BULK_FORCE
203        IF (useLand) CALL PACKAGES_CHECK_ERROR('LAND', myThid)        IF (useBulkForce) CALL PACKAGES_ERROR_MSG(
204         &                  'BULK_FORCE', 'useBulkForce=.T.', myThid )
205  #endif  #endif
206    
207  #ifndef ALLOW_PTRACERS  #ifndef ALLOW_EBM
208        IF (usePTRACERS) CALL PACKAGES_CHECK_ERROR('PTRACERS', myThid)        IF (useEBM) CALL PACKAGES_ERROR_MSG('EBM',' ',myThid)
209  #endif  #endif
210    
211  #ifndef ALLOW_SHAP_FILT  #ifndef ALLOW_CHEAPAML
212        IF (useSHAP_FILT) CALL PACKAGES_CHECK_ERROR('SHAP_FILT', myThid)        IF (useCheapAML) CALL PACKAGES_ERROR_MSG('CheapAML',' ',myThid)
213  #endif  #endif
214    
215  #ifndef ALLOW_ZONAL_FILT  #ifndef ALLOW_FLT
216        IF (useZONAL_FILT) CALL PACKAGES_CHECK_ERROR('ZONAL_FILT',myThid)        IF (useFLT) CALL PACKAGES_ERROR_MSG('FLT',' ',myThid)
217  #endif  #endif
218    
219  #ifndef ALLOW_FLT  #ifdef ALLOW_PTRACERS
220        IF (useFLT) CALL PACKAGES_CHECK_ERROR('FLT', myThid)        IF (usePTRACERS) CALL PTRACERS_CHECK( myThid )
221    #else
222          IF (usePTRACERS) CALL PACKAGES_ERROR_MSG('PTRACERS',' ',myThid)
223  #endif  #endif
224    
225  #ifdef ALLOW_SBO  #ifdef ALLOW_GCHEM
226        IF (useSBO) CALL SBO_CHECK( myThid )        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    #ifdef ALLOW_OFFLINE
236          IF (useOffLine) CALL OFFLINE_CHECK( myThid )
237  #else  #else
238        IF (useSBO) CALL PACKAGES_CHECK_ERROR('SBO', myThid)        IF (useOffLine) CALL PACKAGES_ERROR_MSG('OffLine',' ',myThid)
239    #endif
240    
241    #ifndef ALLOW_MATRIX
242          IF (useMATRIX) CALL PACKAGES_ERROR_MSG('MATRIX',' ',myThid)
243    #endif
244    
245    #ifndef ALLOW_FRAZIL
246          IF (useFRAZIL) CALL PACKAGES_ERROR_MSG('FRAZIL',' ',myThid)
247  #endif  #endif
248    
249  #ifdef ALLOW_SEAICE  #ifdef ALLOW_SEAICE
250        IF (useSEAICE) CALL SEAICE_CHECK( myThid )        IF (useSEAICE) CALL SEAICE_CHECK( myThid )
251  #else  #else
252        IF (useSEAICE) CALL PACKAGES_CHECK_ERROR('SEAICE', myThid)        IF (useSEAICE) CALL PACKAGES_ERROR_MSG('SEAICE',' ',myThid)
253  #endif  #endif
254    
255  #ifndef ALLOW_CD_CODE  #ifdef ALLOW_SALT_PLUME
256        IF (useCDscheme) CALL PACKAGES_CHECK_ERROR('CD_CODE', myThid)        IF (useSALT_PLUME)CALL SALT_PLUME_CHECK( myThid )
257    #else
258          IF (useSALT_PLUME)CALL PACKAGES_ERROR_MSG('SALT_PLUME',' ',myThid)
259    #endif
260    
261    #ifdef ALLOW_SHELFICE
262          IF (useShelfIce) CALL SHELFICE_CHECK( myThid )
263    #else
264          IF (useShelfIce) CALL PACKAGES_ERROR_MSG('ShelfIce',' ',myThid)
265    #endif
266    
267    #ifdef ALLOW_STREAMICE
268          IF (useStreamIce) CALL STREAMICE_CHECK( myThid )
269    #else
270          IF (useStreamIce) CALL PACKAGES_ERROR_MSG('StreamIce',' ',myThid)
271    #endif
272    
273    #ifdef ALLOW_ICEFRONT
274          IF (useICEFRONT) CALL ICEFRONT_CHECK( myThid )
275    #else
276          IF (useICEFRONT) CALL PACKAGES_ERROR_MSG('ICEFRONT',' ',myThid)
277    #endif
278    
279    #ifdef ALLOW_THSICE
280          IF (useThSIce) CALL THSICE_CHECK( myThid )
281    #else
282          IF (useThSIce) CALL PACKAGES_ERROR_MSG('ThSIce',' ',myThid)
283    #endif
284    
285    #ifdef ALLOW_LAND
286          IF (useLand) CALL LAND_CHECK( myThid )
287    #else
288          IF (useLand) CALL PACKAGES_ERROR_MSG('Land',' ',myThid)
289    #endif
290    
291    #ifndef ALLOW_ATM2D
292          IF (useATM2D) CALL PACKAGES_ERROR_MSG('ATM2D',' ',myThid)
293    #endif
294    
295    #ifndef ALLOW_AIM
296          IF (useAIM) CALL PACKAGES_ERROR_MSG('AIM',' ',myThid)
297    #endif
298    
299    #ifdef ALLOW_ATM_PHYS
300          IF (useAtm_Phys) CALL ATM_PHYS_CHECK( myThid )
301    #else
302          IF (useAtm_Phys) CALL PACKAGES_ERROR_MSG('Atm_Phys',' ',myThid)
303    #endif
304    
305    #ifndef ALLOW_FIZHI
306          IF (useFizhi) CALL PACKAGES_ERROR_MSG('Fizhi',' ',myThid)
307    #endif
308    
309    #ifndef ALLOW_GRIDALT
310          IF (useGridAlt) CALL PACKAGES_ERROR_MSG('GridAlt',' ',myThid)
311  #endif  #endif
312    
313  #ifdef ALLOW_AUTODIFF  #ifdef ALLOW_AUTODIFF
314          CALL AUTODIFF_CHECK( myThid )
315    #endif
316    
317    #ifdef ALLOW_CTRL
318        CALL CTRL_CHECK( myThid )        CALL CTRL_CHECK( myThid )
319    #endif
320    
321    #ifdef ALLOW_COST
322        CALL COST_CHECK( myThid )        CALL COST_CHECK( myThid )
323  #endif  #endif
324    
325    #ifdef ALLOW_GRDCHK
326          IF (useGrdChk) CALL GRDCHK_CHECK( myThid )
327    #else
328          IF (useGrdChk) CALL PACKAGES_ERROR_MSG('GrdChk',' ',myThid)
329    #endif
330    
331    #ifndef ALLOW_SMOOTH
332          IF (useSMOOTH) CALL PACKAGES_ERROR_MSG('SMOOTH',' ',myThid)
333    #endif
334    
335    #ifndef ALLOW_PROFILES
336          IF (usePROFILES) CALL PACKAGES_ERROR_MSG('PROFILES',' ',myThid)
337    #endif
338    
339    #ifdef ALLOW_SBO
340          IF (useSBO) CALL SBO_CHECK( myThid )
341    #else
342          IF (useSBO) CALL PACKAGES_ERROR_MSG('SBO',' ',myThid)
343    #endif
344    
345    #ifdef ALLOW_ECCO
346          CALL ECCO_CHECK( myThid )
347    #endif
348    
349    #ifdef ALLOW_DIAGNOSTICS
350          IF (useDiagnostics) CALL DIAGNOSTICS_CHECK( myThid )
351    #else
352          IF (useDiagnostics)
353         &   CALL PACKAGES_ERROR_MSG( 'Diagnostics', ' ', myThid )
354    #endif
355    
356    #ifdef ALLOW_REGRID
357          IF (useREGRID) CALL REGRID_CHECK( myThid )
358    #else
359          IF (useREGRID) CALL PACKAGES_ERROR_MSG('REGRID',' ',myThid)
360    #endif
361    
362    #ifdef ALLOW_LAYERS
363          IF ( useLayers ) CALL LAYERS_CHECK( myThid )
364    #else
365          IF ( useLayers ) CALL PACKAGES_ERROR_MSG('LAYERS',' ',myThid)
366    #endif /* ALLOW_LAYERS */
367    
368    #ifdef ALLOW_NEST_CHILD
369          IF (useNEST_CHILD) CALL NEST_CHILD_CHECK( myThid )
370    #else
371          IF (useNEST_CHILD) CALL PACKAGES_ERROR_MSG(
372         & 'NEST_CHILD',' ',myThid)
373    #endif
374    
375    #ifdef ALLOW_NEST_PARENT
376          IF (useNEST_PARENT) CALL NEST_PARENT_CHECK( myThid )
377    #else
378          IF (useNEST_PARENT) CALL PACKAGES_ERROR_MSG(
379         & 'NEST_PARENT',' ',myThid)
380    #endif
381    
382    #ifdef ALLOW_OASIS
383          IF (useOASIS) CALL OASIS_CHECK( myThid )
384    #else
385          IF (useOASIS) CALL PACKAGES_ERROR_MSG('OASIS',' ',myThid)
386    #endif
387    
388    #ifdef ALLOW_RUNCLOCK
389          IF (useRunClock) CALL RUNCLOCK_CHECK( myThid )
390    #else
391          IF (useRunClock) CALL PACKAGES_ERROR_MSG('RunClock',' ',myThid)
392    #endif
393    
394    #ifndef ALLOW_EMBED_FILES
395          IF (useEMBED_FILES) CALL PACKAGES_ERROR_MSG(
396         &                                  'EMBED_FILES',' ',myThid)
397    #endif
398    
399    #ifdef ALLOW_MYPACKAGE
400          IF (useMYPACKAGE) CALL MYPACKAGE_CHECK( myThid )
401    #else
402          IF (useMYPACKAGE) CALL PACKAGES_ERROR_MSG('MYPACKAGE',' ',myThid)
403    #endif
404    
405    #ifdef ALLOW_GENERIC_ADVDIFF
406    C-    Check generic AdvDiff setting and related overlap minimum size:
407    C     for this reason, called after other ${pkg}_check S/R
408          IF (useGAD) CALL GAD_CHECK( myThid )
409    #endif
410    
411    C---  Exclusive packages (which cannot be used together):
412          IF ( useEXF .AND. useBulkForce ) THEN
413            WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
414         &  'both useEXF and useBulkForce are set'
415            CALL PRINT_ERROR( msgBuf , myThid )
416            WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
417         &  ' but cannot be used together => need to select only one.'
418            CALL PRINT_ERROR( msgBuf , myThid )
419            CALL ALL_PROC_DIE( myThid )
420            STOP 'ABNORMAL END: S/R PACKAGES_CHECK'
421          ENDIF
422    
423    C---  Exclusive packages (which cannot be used together):
424          IF ( useDOWN_SLOPE .AND. useBBL ) THEN
425            WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
426         &  'both useDOWN_SLOPE and useBBL are set'
427            CALL PRINT_ERROR( msgBuf , myThid )
428            WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
429         &  ' but cannot be used together => need to select only one.'
430            CALL PRINT_ERROR( msgBuf , myThid )
431            CALL ALL_PROC_DIE( myThid )
432            STOP 'ABNORMAL END: S/R PACKAGES_CHECK'
433          ENDIF
434    
435        RETURN        RETURN
436        END        END
Legend:
Removed from v.1.20  
changed lines
  Added in v.1.65
  ViewVC Help
Powered by ViewVC 1.1.22