1 |
dimitri |
1.48 |
C $Header: /u/gcmpack/MITgcm/model/src/packages_check.F,v 1.47 2009/11/24 00:17:42 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.47 |
C msgBuf :: Informational/error message buffer |
39 |
jmc |
1.39 |
CHARACTER*(MAX_LEN_MBUF) msgBuf |
40 |
cnh |
1.9 |
CEOP |
41 |
adcroft |
1.1 |
|
42 |
jmc |
1.43 |
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 |
jmc |
1.39 |
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 |
jmc |
1.41 |
CALL PRINT_ERROR( msgBuf , myThid ) |
71 |
jmc |
1.39 |
WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ', |
72 |
|
|
& 'Re-compile with pkg "mom_vecinv" in packages.conf' |
73 |
jmc |
1.41 |
CALL PRINT_ERROR( msgBuf , myThid ) |
74 |
jmc |
1.39 |
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 |
jmc |
1.41 |
CALL PRINT_ERROR( msgBuf , myThid ) |
83 |
jmc |
1.39 |
WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ', |
84 |
|
|
& 'Re-compile with pkg "mom_fluxform" in packages.conf' |
85 |
jmc |
1.41 |
CALL PRINT_ERROR( msgBuf , myThid ) |
86 |
jmc |
1.39 |
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 |
jmc |
1.41 |
CALL PRINT_ERROR( msgBuf , myThid ) |
98 |
jmc |
1.39 |
WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ', |
99 |
|
|
& 'Re-compile with pkg "generic_advdiff" in packages.conf' |
100 |
jmc |
1.41 |
CALL PRINT_ERROR( msgBuf , myThid ) |
101 |
jmc |
1.39 |
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 |
jmc |
1.41 |
IF (monitorFreq.NE.0.) CALL PACKAGES_ERROR_MSG( |
108 |
|
|
& 'MONITOR', 'monitorFreq <> 0', myThid ) |
109 |
jmc |
1.39 |
#endif |
110 |
|
|
|
111 |
|
|
#ifndef ALLOW_TIMEAVE |
112 |
|
|
C If taveFreq is finite, make sure the pkg/timeave is being compiled |
113 |
jmc |
1.41 |
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 |
jmc |
1.39 |
#endif |
121 |
|
|
|
122 |
|
|
C--- Continue with standard packages (with standard usePKG flag) |
123 |
|
|
|
124 |
adcroft |
1.28 |
#ifdef ALLOW_RUNCLOCK |
125 |
|
|
IF (useRunClock) CALL RUNCLOCK_CHECK( myThid ) |
126 |
|
|
#else |
127 |
jmc |
1.41 |
IF (useRunClock) CALL PACKAGES_ERROR_MSG('RunClock',' ',myThid) |
128 |
adcroft |
1.28 |
#endif |
129 |
|
|
|
130 |
heimbach |
1.3 |
#ifdef ALLOW_KPP |
131 |
|
|
IF (useKPP) CALL KPP_CHECK( myThid ) |
132 |
adcroft |
1.1 |
#else |
133 |
jmc |
1.41 |
IF (useKPP) CALL PACKAGES_ERROR_MSG('KPP',' ',myThid) |
134 |
adcroft |
1.1 |
#endif |
135 |
|
|
|
136 |
mlosch |
1.22 |
#ifdef ALLOW_PP81 |
137 |
|
|
IF (usePP81) CALL PP81_CHECK( myThid ) |
138 |
|
|
#else |
139 |
jmc |
1.41 |
IF (usePP81) CALL PACKAGES_ERROR_MSG('PP81',' ',myThid) |
140 |
mlosch |
1.22 |
#endif |
141 |
|
|
|
142 |
|
|
#ifdef ALLOW_MY82 |
143 |
|
|
IF (useMY82) CALL MY82_CHECK( myThid ) |
144 |
|
|
#else |
145 |
jmc |
1.41 |
IF (useMY82) CALL PACKAGES_ERROR_MSG('MY82',' ',myThid) |
146 |
mlosch |
1.22 |
#endif |
147 |
|
|
|
148 |
mlosch |
1.23 |
#ifdef ALLOW_GGL90 |
149 |
|
|
IF (useGGL90) CALL GGL90_CHECK( myThid ) |
150 |
|
|
#else |
151 |
jmc |
1.41 |
IF (useGGL90) CALL PACKAGES_ERROR_MSG('GGL90',' ',myThid) |
152 |
mlosch |
1.23 |
#endif |
153 |
|
|
|
154 |
|
|
#ifdef ALLOW_OPPS |
155 |
|
|
IF (useOPPS) CALL OPPS_CHECK( myThid ) |
156 |
|
|
#else |
157 |
jmc |
1.41 |
IF (useOPPS) CALL PACKAGES_ERROR_MSG('OPPS',' ',myThid) |
158 |
mlosch |
1.23 |
#endif |
159 |
|
|
|
160 |
heimbach |
1.3 |
#ifdef ALLOW_GMREDI |
161 |
|
|
IF (useGMRedi) CALL GMREDI_CHECK( myThid ) |
162 |
|
|
#else |
163 |
jmc |
1.41 |
IF (useGMRedi) CALL PACKAGES_ERROR_MSG('GMRedi',' ',myThid) |
164 |
adcroft |
1.1 |
#endif |
165 |
|
|
|
166 |
jmc |
1.44 |
#ifndef ALLOW_DOWN_SLOPE |
167 |
|
|
IF (useDOWN_SLOPE) |
168 |
|
|
& CALL PACKAGES_ERROR_MSG('DOWN_SLOPE',' ',myThid) |
169 |
|
|
#endif |
170 |
|
|
|
171 |
adcroft |
1.6 |
#ifdef ALLOW_OBCS |
172 |
|
|
IF (useOBCS) CALL OBCS_CHECK( myThid ) |
173 |
|
|
#else |
174 |
jmc |
1.41 |
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 |
jmc |
1.17 |
#endif |
180 |
|
|
|
181 |
|
|
#ifndef ALLOW_BULK_FORCE |
182 |
jmc |
1.41 |
IF (useBulkForce) CALL PACKAGES_ERROR_MSG( |
183 |
|
|
& 'BULK_FORCE', 'useBulkForce=.T.', myThid ) |
184 |
jmc |
1.17 |
#endif |
185 |
|
|
|
186 |
heimbach |
1.40 |
#ifdef ALLOW_THSICE |
187 |
|
|
IF (useThSIce) CALL THSICE_CHECK( myThid ) |
188 |
|
|
#else |
189 |
jmc |
1.41 |
IF (useThSIce) CALL PACKAGES_ERROR_MSG('ThSIce',' ',myThid) |
190 |
jmc |
1.7 |
#endif |
191 |
|
|
|
192 |
jscott |
1.37 |
#ifndef ALLOW_ATM2D |
193 |
jmc |
1.41 |
IF (useATM2D) CALL PACKAGES_ERROR_MSG('ATM2D',' ',myThid) |
194 |
jscott |
1.37 |
#endif |
195 |
|
|
|
196 |
jmc |
1.7 |
#ifndef ALLOW_AIM |
197 |
jmc |
1.41 |
IF (useAIM) CALL PACKAGES_ERROR_MSG('AIM',' ',myThid) |
198 |
jmc |
1.14 |
#endif |
199 |
|
|
|
200 |
|
|
#ifndef ALLOW_LAND |
201 |
jmc |
1.41 |
IF (useLand) CALL PACKAGES_ERROR_MSG('LAND',' ',myThid) |
202 |
adcroft |
1.11 |
#endif |
203 |
|
|
|
204 |
|
|
#ifndef ALLOW_PTRACERS |
205 |
jmc |
1.41 |
IF (usePTRACERS) CALL PACKAGES_ERROR_MSG('PTRACERS',' ',myThid) |
206 |
jmc |
1.10 |
#endif |
207 |
|
|
|
208 |
jmc |
1.30 |
#ifndef ALLOW_MATRIX |
209 |
jmc |
1.41 |
IF (useMATRIX) CALL PACKAGES_ERROR_MSG('MATRIX',' ',myThid) |
210 |
jmc |
1.30 |
#endif |
211 |
|
|
|
212 |
mlosch |
1.25 |
#ifdef ALLOW_GCHEM |
213 |
|
|
IF (useGCHEM) CALL GCHEM_CHECK( myThid ) |
214 |
|
|
#else |
215 |
jmc |
1.41 |
IF (useGCHEM) CALL PACKAGES_ERROR_MSG('GCHEM',' ',myThid) |
216 |
mlosch |
1.25 |
#endif |
217 |
|
|
|
218 |
jmc |
1.33 |
#ifndef ALLOW_OFFLINE |
219 |
jmc |
1.41 |
IF (useOffLine) CALL PACKAGES_ERROR_MSG('OffLine',' ',myThid) |
220 |
jmc |
1.33 |
#endif |
221 |
|
|
|
222 |
jmc |
1.10 |
#ifndef ALLOW_SHAP_FILT |
223 |
jmc |
1.41 |
IF (useSHAP_FILT) |
224 |
|
|
& CALL PACKAGES_ERROR_MSG( 'SHAP_FILT', ' ', myThid ) |
225 |
jmc |
1.10 |
#endif |
226 |
|
|
|
227 |
|
|
#ifndef ALLOW_ZONAL_FILT |
228 |
jmc |
1.41 |
IF (useZONAL_FILT) |
229 |
|
|
& CALL PACKAGES_ERROR_MSG( 'ZONAL_FILT', ' ', myThid ) |
230 |
adcroft |
1.8 |
#endif |
231 |
|
|
|
232 |
|
|
#ifndef ALLOW_FLT |
233 |
jmc |
1.41 |
IF (useFLT) CALL PACKAGES_ERROR_MSG('FLT',' ',myThid) |
234 |
dimitri |
1.13 |
#endif |
235 |
|
|
|
236 |
|
|
#ifdef ALLOW_SBO |
237 |
|
|
IF (useSBO) CALL SBO_CHECK( myThid ) |
238 |
|
|
#else |
239 |
jmc |
1.41 |
IF (useSBO) CALL PACKAGES_ERROR_MSG('SBO',' ',myThid) |
240 |
heimbach |
1.12 |
#endif |
241 |
|
|
|
242 |
|
|
#ifdef ALLOW_SEAICE |
243 |
|
|
IF (useSEAICE) CALL SEAICE_CHECK( myThid ) |
244 |
|
|
#else |
245 |
jmc |
1.41 |
IF (useSEAICE) CALL PACKAGES_ERROR_MSG('SEAICE',' ',myThid) |
246 |
edhill |
1.20 |
#endif |
247 |
|
|
|
248 |
mlosch |
1.32 |
#ifdef ALLOW_SHELFICE |
249 |
|
|
IF (useShelfIce) CALL SHELFICE_CHECK( myThid ) |
250 |
|
|
#else |
251 |
jmc |
1.41 |
IF (useShelfIce) CALL PACKAGES_ERROR_MSG('ShelfIce',' ',myThid) |
252 |
mlosch |
1.32 |
#endif |
253 |
|
|
|
254 |
dimitri |
1.48 |
#ifdef ALLOW_ICEFRONT |
255 |
|
|
IF (useICEFRONT) CALL ICEFRONT_CHECK( myThid ) |
256 |
|
|
#else |
257 |
|
|
IF (useICEFRONT) CALL PACKAGES_ERROR_MSG('ICEFRONT',' ',myThid) |
258 |
|
|
#endif |
259 |
|
|
|
260 |
heimbach |
1.19 |
#ifdef ALLOW_AUTODIFF |
261 |
heimbach |
1.24 |
CALL AUTODIFF_CHECK( myThid ) |
262 |
heimbach |
1.26 |
#endif |
263 |
|
|
|
264 |
|
|
#ifdef ALLOW_CTRL |
265 |
heimbach |
1.15 |
CALL CTRL_CHECK( myThid ) |
266 |
heimbach |
1.26 |
#endif |
267 |
|
|
|
268 |
|
|
#ifdef ALLOW_COST |
269 |
heimbach |
1.15 |
CALL COST_CHECK( myThid ) |
270 |
adcroft |
1.6 |
#endif |
271 |
|
|
|
272 |
heimbach |
1.29 |
#ifdef ALLOW_GRDCHK |
273 |
heimbach |
1.34 |
IF (useGRDCHK) CALL GRDCHK_CHECK( myThid ) |
274 |
heimbach |
1.29 |
#endif |
275 |
|
|
|
276 |
jmc |
1.27 |
#ifdef ALLOW_DIAGNOSTICS |
277 |
|
|
IF (useDiagnostics) CALL DIAGNOSTICS_CHECK( myThid ) |
278 |
|
|
#else |
279 |
jmc |
1.33 |
IF (useDiagnostics) |
280 |
jmc |
1.41 |
& CALL PACKAGES_ERROR_MSG( 'Diagnostics', ' ', myThid ) |
281 |
jmc |
1.27 |
#endif |
282 |
|
|
|
283 |
edhill |
1.36 |
#ifdef ALLOW_REGRID |
284 |
|
|
IF (useREGRID) CALL REGRID_CHECK( myThid ) |
285 |
|
|
#else |
286 |
jmc |
1.41 |
IF (useREGRID) CALL PACKAGES_ERROR_MSG('REGRID',' ',myThid) |
287 |
edhill |
1.36 |
#endif |
288 |
|
|
|
289 |
rpa |
1.46 |
#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 |
jmc |
1.47 |
#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 |
heimbach |
1.35 |
#ifdef ALLOW_MYPACKAGE |
310 |
|
|
IF (useMYPACKAGE) CALL MYPACKAGE_CHECK( myThid ) |
311 |
|
|
#else |
312 |
jmc |
1.41 |
IF (useMYPACKAGE) CALL PACKAGES_ERROR_MSG('MYPACKAGE',' ',myThid) |
313 |
heimbach |
1.35 |
#endif |
314 |
|
|
|
315 |
dimitri |
1.42 |
#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 |
heimbach |
1.45 |
#ifdef ALLOW_ECCO |
322 |
|
|
CALL ECCO_CHECK( myThid ) |
323 |
rpa |
1.46 |
#endif |
324 |
heimbach |
1.45 |
|
325 |
jmc |
1.41 |
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 |
adcroft |
1.6 |
RETURN |
337 |
|
|
END |