/[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.3 by heimbach, Wed Sep 13 17:11:34 2000 UTC revision 1.61 by gforget, Fri Jun 22 02:03:03 2012 UTC
# Line 1  Line 1 
1   $Header$  C $Header$
2    C $Name$
3    
4    #include "PACKAGES_CONFIG.h"
5  #include "CPP_OPTIONS.h"  #include "CPP_OPTIONS.h"
6    
7    CBOP
8    C     !ROUTINE: PACKAGES_CHECK
9    C     !INTERFACE:
10        SUBROUTINE PACKAGES_CHECK( myThid )        SUBROUTINE PACKAGES_CHECK( myThid )
11  C     /==========================================================\  C     !DESCRIPTION: \bv
12  C     | SUBROUTINE PACKAGES_CHECK                                |  C     *==========================================================*
13  C     | o Check dependances between selected packages            |  C     | SUBROUTINE PACKAGES_CHECK
14  C     |==========================================================|  C     | o Check runtime activated packages have been built in.
15  C     \==========================================================/  C     *==========================================================*
16        IMPLICIT NONE  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 ===  C     === Global variables ===
27  #include "SIZE.h"  #include "SIZE.h"
28  #include "EEPARAMS.h"  #include "EEPARAMS.h"
29  #include "PARAMS.h"  #include "PARAMS.h"
30    
31    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:
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
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_RUNCLOCK
130          IF (useRunClock) CALL RUNCLOCK_CHECK( myThid )
131    #else
132          IF (useRunClock) CALL PACKAGES_ERROR_MSG('RunClock',' ',myThid)
133    #endif
134    
135  #ifdef ALLOW_KPP  #ifdef ALLOW_KPP
136        IF (useKPP) CALL KPP_CHECK( myThid )        IF (useKPP) CALL KPP_CHECK( myThid )
137  #else  #else
138        IF (useKPP) CALL PACKAGES_CHECK_ERROR('KPP')        IF (useKPP) CALL PACKAGES_ERROR_MSG('KPP',' ',myThid)
139    #endif
140    
141    #ifdef ALLOW_PP81
142          IF (usePP81) CALL PP81_CHECK( myThid )
143    #else
144          IF (usePP81) CALL PACKAGES_ERROR_MSG('PP81',' ',myThid)
145    #endif
146    
147    #ifdef ALLOW_MY82
148          IF (useMY82) CALL MY82_CHECK( myThid )
149    #else
150          IF (useMY82) CALL PACKAGES_ERROR_MSG('MY82',' ',myThid)
151    #endif
152    
153    #ifdef ALLOW_GGL90
154          IF (useGGL90) CALL GGL90_CHECK( myThid )
155    #else
156          IF (useGGL90) CALL PACKAGES_ERROR_MSG('GGL90',' ',myThid)
157    #endif
158    
159    #ifdef ALLOW_OPPS
160          IF (useOPPS) CALL OPPS_CHECK( myThid )
161    #else
162          IF (useOPPS) CALL PACKAGES_ERROR_MSG('OPPS',' ',myThid)
163  #endif  #endif
164    
165  #ifdef ALLOW_GMREDI  #ifdef ALLOW_GMREDI
166        IF (useGMRedi) CALL GMREDI_CHECK( myThid )        IF (useGMRedi) CALL GMREDI_CHECK( myThid )
167  #else  #else
168        IF (useGMRedi) CALL PACKAGES_CHECK_ERROR('GMREDI')        IF (useGMRedi) CALL PACKAGES_ERROR_MSG('GMRedi',' ',myThid)
169    #endif
170    
171    #ifndef ALLOW_DOWN_SLOPE
172          IF (useDOWN_SLOPE)
173         &            CALL PACKAGES_ERROR_MSG('DOWN_SLOPE',' ',myThid)
174    #endif
175    
176    #ifdef ALLOW_BBL
177          IF (useBBL) CALL BBL_CHECK( myThid )
178    #else
179          IF (useBBL) CALL PACKAGES_ERROR_MSG('BBL',' ',myThid)
180    #endif
181    
182    #ifdef ALLOW_OBCS
183          IF (useOBCS) CALL OBCS_CHECK( myThid )
184    #else
185          IF (useOBCS) CALL PACKAGES_ERROR_MSG('OBCS',' ',myThid)
186    #endif
187    
188    #ifndef ALLOW_CAL
189          IF (useCAL) CALL PACKAGES_ERROR_MSG('CAL',' ',myThid)
190    #endif
191    
192    #ifdef ALLOW_EXF
193          IF (useEXF) CALL EXF_CHECK( myThid )
194    #else
195          IF (useEXF) CALL PACKAGES_ERROR_MSG('EXF',' ',myThid)
196    #endif
197    
198    #ifndef ALLOW_BULK_FORCE
199          IF (useBulkForce) CALL PACKAGES_ERROR_MSG(
200         &                  'BULK_FORCE', 'useBulkForce=.T.', myThid )
201    #endif
202    
203    #ifndef ALLOW_EBM
204          IF (useEBM) CALL PACKAGES_ERROR_MSG('EBM',' ',myThid)
205    #endif
206    
207    #ifndef ALLOW_CHEAPAML
208          IF (useCheapAML) CALL PACKAGES_ERROR_MSG('CheapAML',' ',myThid)
209    #endif
210    
211    #ifndef ALLOW_FRAZIL
212          IF (useFRAZIL) CALL PACKAGES_ERROR_MSG('FRAZIL',' ',myThid)
213    #endif
214    
215    #ifdef ALLOW_THSICE
216          IF (useThSIce) CALL THSICE_CHECK( myThid )
217    #else
218          IF (useThSIce) CALL PACKAGES_ERROR_MSG('ThSIce',' ',myThid)
219    #endif
220    
221    #ifndef ALLOW_ATM2D
222          IF (useATM2D) CALL PACKAGES_ERROR_MSG('ATM2D',' ',myThid)
223    #endif
224    
225    #ifndef ALLOW_AIM
226          IF (useAIM) CALL PACKAGES_ERROR_MSG('AIM',' ',myThid)
227    #endif
228    
229    #ifndef ALLOW_LAND
230          IF (useLand) CALL PACKAGES_ERROR_MSG('Land',' ',myThid)
231    #endif
232    
233    #ifndef ALLOW_FIZHI
234          IF (useFizhi) CALL PACKAGES_ERROR_MSG('Fizhi',' ',myThid)
235    #endif
236    
237    #ifndef ALLOW_GRIDALT
238          IF (useGridAlt) CALL PACKAGES_ERROR_MSG('GridAlt',' ',myThid)
239    #endif
240    
241    #ifdef ALLOW_PTRACERS
242          IF (usePTRACERS) CALL PTRACERS_CHECK( myThid )
243    #else
244          IF (usePTRACERS) CALL PACKAGES_ERROR_MSG('PTRACERS',' ',myThid)
245  #endif  #endif
246    
247        return  #ifdef ALLOW_GCHEM
248        end        IF (useGCHEM) CALL GCHEM_CHECK( myThid )
249    #else
250          IF (useGCHEM) CALL PACKAGES_ERROR_MSG('GCHEM',' ',myThid)
251    #endif
252    
253    #ifndef ALLOW_RBCS
254          IF (useRBCS) CALL PACKAGES_ERROR_MSG('RBCS',' ',myThid)
255    #endif
256    
257    #ifndef ALLOW_OFFLINE
258          IF (useOffLine) CALL PACKAGES_ERROR_MSG('OffLine',' ',myThid)
259    #endif
260    
261    #ifndef ALLOW_MATRIX
262          IF (useMATRIX) CALL PACKAGES_ERROR_MSG('MATRIX',' ',myThid)
263    #endif
264    
265    #ifndef ALLOW_SHAP_FILT
266          IF (useSHAP_FILT)
267         &   CALL PACKAGES_ERROR_MSG( 'SHAP_FILT', ' ', myThid )
268    #endif
269    
270    #ifndef ALLOW_ZONAL_FILT
271          IF (useZONAL_FILT)
272         &   CALL PACKAGES_ERROR_MSG( 'ZONAL_FILT', ' ', myThid )
273    #endif
274    
275    #ifndef ALLOW_FLT
276          IF (useFLT) CALL PACKAGES_ERROR_MSG('FLT',' ',myThid)
277    #endif
278    
279    #ifdef ALLOW_SBO
280          IF (useSBO) CALL SBO_CHECK( myThid )
281    #else
282          IF (useSBO) CALL PACKAGES_ERROR_MSG('SBO',' ',myThid)
283    #endif
284    
285    #ifdef ALLOW_SEAICE
286          IF (useSEAICE) CALL SEAICE_CHECK( myThid )
287    #else
288          IF (useSEAICE) CALL PACKAGES_ERROR_MSG('SEAICE',' ',myThid)
289    #endif
290    
291    #ifdef ALLOW_SALT_PLUME
292          IF (useSALT_PLUME)CALL SALT_PLUME_CHECK( myThid )
293    #else
294          IF (useSALT_PLUME)CALL PACKAGES_ERROR_MSG('SALT_PLUME',' ',myThid)
295    #endif
296    
297    #ifdef ALLOW_SHELFICE
298          IF (useShelfIce) CALL SHELFICE_CHECK( myThid )
299    #else
300          IF (useShelfIce) CALL PACKAGES_ERROR_MSG('ShelfIce',' ',myThid)
301    #endif
302    
303    #ifdef ALLOW_STREAMICE
304          IF (useStreamIce) CALL STREAMICE_CHECK( myThid )
305    #else
306          IF (useStreamIce) CALL PACKAGES_ERROR_MSG('StreamIce',' ',myThid)
307    #endif
308    
309    #ifdef ALLOW_ICEFRONT
310          IF (useICEFRONT) CALL ICEFRONT_CHECK( myThid )
311    #else
312          IF (useICEFRONT) CALL PACKAGES_ERROR_MSG('ICEFRONT',' ',myThid)
313    #endif
314    
315    #ifdef ALLOW_AUTODIFF
316          CALL AUTODIFF_CHECK( myThid )
317    #endif
318    
319    #ifdef ALLOW_CTRL
320          CALL CTRL_CHECK( myThid )
321    #endif
322    
323    #ifdef ALLOW_COST
324          CALL COST_CHECK( myThid )
325    #endif
326    
327    #ifdef ALLOW_GRDCHK
328          IF (useGRDCHK) CALL GRDCHK_CHECK( 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_DIAGNOSTICS
340          IF (useDiagnostics) CALL DIAGNOSTICS_CHECK( myThid )
341    #else
342          IF (useDiagnostics)
343         &   CALL PACKAGES_ERROR_MSG( 'Diagnostics', ' ', myThid )
344    #endif
345    
346    #ifdef ALLOW_REGRID
347          IF (useREGRID) CALL REGRID_CHECK( myThid )
348    #else
349          IF (useREGRID) CALL PACKAGES_ERROR_MSG('REGRID',' ',myThid)
350    #endif
351    
352    #ifdef ALLOW_LAYERS
353          IF ( useLayers ) CALL LAYERS_CHECK( myThid )
354    #else
355          IF ( useLayers ) CALL PACKAGES_ERROR_MSG('LAYERS',' ',myThid)
356    #endif /* ALLOW_LAYERS */
357    
358    #ifdef ALLOW_NEST_CHILD
359          IF (useNEST_CHILD) CALL NEST_CHILD_CHECK( myThid )
360    #else
361          IF (useNEST_CHILD) CALL PACKAGES_ERROR_MSG(
362         & 'NEST_CHILD',' ',myThid)
363    #endif
364    
365    #ifdef ALLOW_NEST_PARENT
366          IF (useNEST_PARENT) CALL NEST_PARENT_CHECK( myThid )
367    #else
368          IF (useNEST_PARENT) CALL PACKAGES_ERROR_MSG(
369         & 'NEST_PARENT',' ',myThid)
370    #endif
371    
372    #ifdef ALLOW_OASIS
373          IF (useOASIS) CALL OASIS_CHECK( myThid )
374    #else
375          IF (useOASIS) CALL PACKAGES_ERROR_MSG('OASIS',' ',myThid)
376    #endif
377    
378    #ifdef ALLOW_ECCO
379          CALL ECCO_CHECK( myThid )
380    #endif
381    
382    #ifndef ALLOW_EMBED_FILES
383          IF (useEMBED_FILES) CALL PACKAGES_ERROR_MSG(
384         &                                  'EMBED_FILES',' ',myThid)
385    #endif
386    
387    #ifdef ALLOW_MYPACKAGE
388          IF (useMYPACKAGE) CALL MYPACKAGE_CHECK( myThid )
389    #else
390          IF (useMYPACKAGE) CALL PACKAGES_ERROR_MSG('MYPACKAGE',' ',myThid)
391    #endif
392    
393    #ifdef ALLOW_GENERIC_ADVDIFF
394    C-    Check generic AdvDiff setting and related overlap minimum size:
395    C     for this reason, called after other ${pkg}_check S/R
396          IF (useGAD) CALL GAD_CHECK( myThid )
397    #endif
398    
399    C---  Exclusive packages (which cannot be used together):
400          IF ( useEXF .AND. useBulkForce ) THEN
401            WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
402         &  'both useEXF and useBulkForce are set'
403            CALL PRINT_ERROR( msgBuf , myThid )
404            WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
405         &  ' but cannot be used together => need to select only one.'
406            CALL PRINT_ERROR( msgBuf , myThid )
407            CALL ALL_PROC_DIE( myThid )
408            STOP 'ABNORMAL END: S/R PACKAGES_CHECK'
409          ENDIF
410    
411    C---  Exclusive packages (which cannot be used together):
412          IF ( useDOWN_SLOPE .AND. useBBL ) THEN
413            WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
414         &  'both useDOWN_SLOPE and useBBL 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          RETURN
424          END
Legend:
Removed from v.1.3  
changed lines
  Added in v.1.61
  ViewVC Help
Powered by ViewVC 1.1.22