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

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

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


Revision 1.42 - (hide annotations) (download)
Wed Nov 28 09:26:16 2007 UTC (16 years, 5 months ago) by dimitri
Branch: MAIN
CVS Tags: checkpoint59m, checkpoint59l, checkpoint59o, checkpoint59n, checkpoint59k
Changes since 1.41: +7 -1 lines
added check, readparms, and more diagnostice to pkg/salt_plume
also changed package flag from useSaltPlume to useSALT_PLUME

1 dimitri 1.42 C $Header: /u/gcmpack/MITgcm/model/src/packages_check.F,v 1.41 2007/04/28 00:15:11 jmc Exp $
2 adcroft 1.6 C $Name: $
3 adcroft 1.1
4 edhill 1.16 #include "PACKAGES_CONFIG.h"
5 adcroft 1.1 #include "CPP_OPTIONS.h"
6    
7 cnh 1.9 CBOP
8     C !ROUTINE: PACKAGES_CHECK
9     C !INTERFACE:
10 heimbach 1.2 SUBROUTINE PACKAGES_CHECK( myThid )
11 cnh 1.9 C !DESCRIPTION: \bv
12     C *==========================================================*
13 jmc 1.39 C | SUBROUTINE PACKAGES_CHECK
14     C | o Check runtime activated packages have been built in.
15 cnh 1.9 C *==========================================================*
16 jmc 1.39 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 cnh 1.9 C *==========================================================*
22     C \ev
23    
24     C !USES:
25 adcroft 1.1 IMPLICIT NONE
26     C === Global variables ===
27     #include "SIZE.h"
28     #include "EEPARAMS.h"
29     #include "PARAMS.h"
30    
31 cnh 1.9 C !INPUT/OUTPUT PARAMETERS:
32 adcroft 1.1 C === Routine arguments ===
33 cnh 1.9 C myThid :: Number of this instances
34 adcroft 1.1 INTEGER myThid
35    
36 cnh 1.9 C !LOCAL VARIABLES:
37 adcroft 1.1 C === Local variables ===
38 jmc 1.39 C msgBuf :: Informational/error meesage buffer
39     CHARACTER*(MAX_LEN_MBUF) msgBuf
40 cnh 1.9 CEOP
41 adcroft 1.1
42 jmc 1.39 C--- Start with non-standard packages (without or with non standard flag)
43    
44     #ifndef ALLOW_MNC
45     IF (useMNC) THEN
46     WRITE(msgBuf,'(2A)') '***WARNING***',
47     & ' PACKAGES_CHECK: useMNC is TRUE'
48     CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
49     & SQUEEZE_RIGHT , myThid)
50     WRITE(msgBuf,'(2A)') '***WARNING***',
51     & ' but pkg/mnc has not been compiled (#undef ALLOW_MNC)'
52     CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
53     & SQUEEZE_RIGHT , myThid)
54     ENDIF
55     #endif
56    
57     #ifndef ALLOW_MOM_VECINV
58     IF ( momStepping .AND. vectorInvariantMomentum ) THEN
59     WRITE(msgBuf,'(2A)')
60     & 'PACKAGES_CHECK: cannot step forward Momentum',
61     & ' without pkg/mom_vecinv'
62 jmc 1.41 CALL PRINT_ERROR( msgBuf , myThid )
63 jmc 1.39 WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
64     & 'Re-compile with pkg "mom_vecinv" in packages.conf'
65 jmc 1.41 CALL PRINT_ERROR( msgBuf , myThid )
66 jmc 1.39 STOP 'ABNORMAL END: S/R PACKAGES_CHECK'
67     ENDIF
68     #endif
69     #ifndef ALLOW_MOM_FLUXFORM
70     IF ( momStepping .AND. .NOT.vectorInvariantMomentum ) THEN
71     WRITE(msgBuf,'(2A)')
72     & 'PACKAGES_CHECK: cannot step forward Momentum',
73     & ' without pkg/mom_fluxform'
74 jmc 1.41 CALL PRINT_ERROR( msgBuf , myThid )
75 jmc 1.39 WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
76     & 'Re-compile with pkg "mom_fluxform" in packages.conf'
77 jmc 1.41 CALL PRINT_ERROR( msgBuf , myThid )
78 jmc 1.39 STOP 'ABNORMAL END: S/R PACKAGES_CHECK'
79     ENDIF
80     #endif
81    
82     #ifdef ALLOW_GENERIC_ADVDIFF
83     IF (useGAD) CALL GAD_CHECK( myThid )
84     #else
85     IF ( tempStepping .OR. saltStepping ) THEN
86     WRITE(msgBuf,'(2A)')
87     & 'PACKAGES_CHECK: cannot step forward Temp or Salt',
88     & ' without pkg/generic_advdiff'
89 jmc 1.41 CALL PRINT_ERROR( msgBuf , myThid )
90 jmc 1.39 WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
91     & 'Re-compile with pkg "generic_advdiff" in packages.conf'
92 jmc 1.41 CALL PRINT_ERROR( msgBuf , myThid )
93 jmc 1.39 STOP 'ABNORMAL END: S/R PACKAGES_CHECK'
94     ENDIF
95     #endif
96    
97     #ifndef ALLOW_MONITOR
98     C If monitorFreq is finite, make sure the pkg/monitor is being compiled
99 jmc 1.41 IF (monitorFreq.NE.0.) CALL PACKAGES_ERROR_MSG(
100     & 'MONITOR', 'monitorFreq <> 0', myThid )
101 jmc 1.39 #endif
102    
103     #ifndef ALLOW_TIMEAVE
104     C If taveFreq is finite, make sure the pkg/timeave is being compiled
105 jmc 1.41 IF (taveFreq.NE.0.) CALL PACKAGES_ERROR_MSG(
106     & 'TIMEAVE', 'taveFreq <> 0', myThid )
107     #endif
108    
109     #ifndef ALLOW_CD_CODE
110     IF (useCDscheme) CALL PACKAGES_ERROR_MSG(
111     & 'CD_CODE', 'useCDscheme=.T.', myThid )
112 jmc 1.39 #endif
113    
114     C--- Continue with standard packages (with standard usePKG flag)
115    
116 adcroft 1.28 #ifdef ALLOW_RUNCLOCK
117     IF (useRunClock) CALL RUNCLOCK_CHECK( myThid )
118     #else
119 jmc 1.41 IF (useRunClock) CALL PACKAGES_ERROR_MSG('RunClock',' ',myThid)
120 adcroft 1.28 #endif
121    
122 heimbach 1.3 #ifdef ALLOW_KPP
123     IF (useKPP) CALL KPP_CHECK( myThid )
124 adcroft 1.1 #else
125 jmc 1.41 IF (useKPP) CALL PACKAGES_ERROR_MSG('KPP',' ',myThid)
126 adcroft 1.1 #endif
127    
128 mlosch 1.22 #ifdef ALLOW_PP81
129     IF (usePP81) CALL PP81_CHECK( myThid )
130     #else
131 jmc 1.41 IF (usePP81) CALL PACKAGES_ERROR_MSG('PP81',' ',myThid)
132 mlosch 1.22 #endif
133    
134     #ifdef ALLOW_MY82
135     IF (useMY82) CALL MY82_CHECK( myThid )
136     #else
137 jmc 1.41 IF (useMY82) CALL PACKAGES_ERROR_MSG('MY82',' ',myThid)
138 mlosch 1.22 #endif
139    
140 mlosch 1.23 #ifdef ALLOW_GGL90
141     IF (useGGL90) CALL GGL90_CHECK( myThid )
142     #else
143 jmc 1.41 IF (useGGL90) CALL PACKAGES_ERROR_MSG('GGL90',' ',myThid)
144 mlosch 1.23 #endif
145    
146     #ifdef ALLOW_OPPS
147     IF (useOPPS) CALL OPPS_CHECK( myThid )
148     #else
149 jmc 1.41 IF (useOPPS) CALL PACKAGES_ERROR_MSG('OPPS',' ',myThid)
150 mlosch 1.23 #endif
151    
152 heimbach 1.3 #ifdef ALLOW_GMREDI
153     IF (useGMRedi) CALL GMREDI_CHECK( myThid )
154     #else
155 jmc 1.41 IF (useGMRedi) CALL PACKAGES_ERROR_MSG('GMRedi',' ',myThid)
156 adcroft 1.1 #endif
157    
158 adcroft 1.6 #ifdef ALLOW_OBCS
159     IF (useOBCS) CALL OBCS_CHECK( myThid )
160     #else
161 jmc 1.41 IF (useOBCS) CALL PACKAGES_ERROR_MSG('OBCS',' ',myThid)
162     #endif
163    
164     #ifndef ALLOW_EXF
165     IF (useEXF) CALL PACKAGES_ERROR_MSG('EXF',' ',myThid)
166 jmc 1.17 #endif
167    
168     #ifndef ALLOW_BULK_FORCE
169 jmc 1.41 IF (useBulkForce) CALL PACKAGES_ERROR_MSG(
170     & 'BULK_FORCE', 'useBulkForce=.T.', myThid )
171 jmc 1.17 #endif
172    
173 heimbach 1.40 #ifdef ALLOW_THSICE
174     IF (useThSIce) CALL THSICE_CHECK( myThid )
175     #else
176 jmc 1.41 IF (useThSIce) CALL PACKAGES_ERROR_MSG('ThSIce',' ',myThid)
177 jmc 1.7 #endif
178    
179 jscott 1.37 #ifndef ALLOW_ATM2D
180 jmc 1.41 IF (useATM2D) CALL PACKAGES_ERROR_MSG('ATM2D',' ',myThid)
181 jscott 1.37 #endif
182    
183 jmc 1.7 #ifndef ALLOW_AIM
184 jmc 1.41 IF (useAIM) CALL PACKAGES_ERROR_MSG('AIM',' ',myThid)
185 jmc 1.14 #endif
186    
187     #ifndef ALLOW_LAND
188 jmc 1.41 IF (useLand) CALL PACKAGES_ERROR_MSG('LAND',' ',myThid)
189 adcroft 1.11 #endif
190    
191     #ifndef ALLOW_PTRACERS
192 jmc 1.41 IF (usePTRACERS) CALL PACKAGES_ERROR_MSG('PTRACERS',' ',myThid)
193 jmc 1.10 #endif
194    
195 jmc 1.30 #ifndef ALLOW_MATRIX
196 jmc 1.41 IF (useMATRIX) CALL PACKAGES_ERROR_MSG('MATRIX',' ',myThid)
197 jmc 1.30 #endif
198    
199 mlosch 1.25 #ifdef ALLOW_GCHEM
200     IF (useGCHEM) CALL GCHEM_CHECK( myThid )
201     #else
202 jmc 1.41 IF (useGCHEM) CALL PACKAGES_ERROR_MSG('GCHEM',' ',myThid)
203 mlosch 1.25 #endif
204    
205 jmc 1.33 #ifndef ALLOW_OFFLINE
206 jmc 1.41 IF (useOffLine) CALL PACKAGES_ERROR_MSG('OffLine',' ',myThid)
207 jmc 1.33 #endif
208    
209 jmc 1.10 #ifndef ALLOW_SHAP_FILT
210 jmc 1.41 IF (useSHAP_FILT)
211     & CALL PACKAGES_ERROR_MSG( 'SHAP_FILT', ' ', myThid )
212 jmc 1.10 #endif
213    
214     #ifndef ALLOW_ZONAL_FILT
215 jmc 1.41 IF (useZONAL_FILT)
216     & CALL PACKAGES_ERROR_MSG( 'ZONAL_FILT', ' ', myThid )
217 adcroft 1.8 #endif
218    
219     #ifndef ALLOW_FLT
220 jmc 1.41 IF (useFLT) CALL PACKAGES_ERROR_MSG('FLT',' ',myThid)
221 dimitri 1.13 #endif
222    
223     #ifdef ALLOW_SBO
224     IF (useSBO) CALL SBO_CHECK( myThid )
225     #else
226 jmc 1.41 IF (useSBO) CALL PACKAGES_ERROR_MSG('SBO',' ',myThid)
227 heimbach 1.12 #endif
228    
229     #ifdef ALLOW_SEAICE
230     IF (useSEAICE) CALL SEAICE_CHECK( myThid )
231     #else
232 jmc 1.41 IF (useSEAICE) CALL PACKAGES_ERROR_MSG('SEAICE',' ',myThid)
233 edhill 1.20 #endif
234    
235 mlosch 1.32 #ifdef ALLOW_SHELFICE
236     IF (useShelfIce) CALL SHELFICE_CHECK( myThid )
237     #else
238 jmc 1.41 IF (useShelfIce) CALL PACKAGES_ERROR_MSG('ShelfIce',' ',myThid)
239 mlosch 1.32 #endif
240    
241 heimbach 1.19 #ifdef ALLOW_AUTODIFF
242 heimbach 1.24 CALL AUTODIFF_CHECK( myThid )
243 heimbach 1.26 #endif
244    
245     #ifdef ALLOW_CTRL
246 heimbach 1.15 CALL CTRL_CHECK( myThid )
247 heimbach 1.26 #endif
248    
249     #ifdef ALLOW_COST
250 heimbach 1.15 CALL COST_CHECK( myThid )
251 adcroft 1.6 #endif
252    
253 heimbach 1.29 #ifdef ALLOW_GRDCHK
254 heimbach 1.34 IF (useGRDCHK) CALL GRDCHK_CHECK( myThid )
255 heimbach 1.29 #endif
256    
257 jmc 1.27 #ifdef ALLOW_DIAGNOSTICS
258     IF (useDiagnostics) CALL DIAGNOSTICS_CHECK( myThid )
259     #else
260 jmc 1.33 IF (useDiagnostics)
261 jmc 1.41 & CALL PACKAGES_ERROR_MSG( 'Diagnostics', ' ', myThid )
262 jmc 1.27 #endif
263    
264 edhill 1.36 #ifdef ALLOW_REGRID
265     IF (useREGRID) CALL REGRID_CHECK( myThid )
266     #else
267 jmc 1.41 IF (useREGRID) CALL PACKAGES_ERROR_MSG('REGRID',' ',myThid)
268 edhill 1.36 #endif
269    
270 heimbach 1.35 #ifdef ALLOW_MYPACKAGE
271     IF (useMYPACKAGE) CALL MYPACKAGE_CHECK( myThid )
272     #else
273 jmc 1.41 IF (useMYPACKAGE) CALL PACKAGES_ERROR_MSG('MYPACKAGE',' ',myThid)
274 heimbach 1.35 #endif
275    
276 dimitri 1.42 #ifdef ALLOW_SALT_PLUME
277     IF (useSALT_PLUME)CALL SALT_PLUME_CHECK( myThid )
278     #else
279     IF (useSALT_PLUME)CALL PACKAGES_ERROR_MSG('SALT_PLUME',' ',myThid)
280     #endif
281    
282 jmc 1.41 C--- Exclusive packages (which cannot be used together):
283     IF ( useEXF .AND. useBulkForce ) THEN
284     WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
285     & 'both useEXF and useBulkForce are set'
286     CALL PRINT_ERROR( msgBuf , myThid )
287     WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
288     & ' but cannot be used together => need to select only one.'
289     CALL PRINT_ERROR( msgBuf , myThid )
290     STOP 'ABNORMAL END: S/R PACKAGES_CHECK'
291     ENDIF
292    
293 adcroft 1.6 RETURN
294     END

  ViewVC Help
Powered by ViewVC 1.1.22