1 |
C $Header$ |
C $Header$ |
2 |
C $Name$ |
C $Name$ |
3 |
|
|
4 |
|
#include "PACKAGES_CONFIG.h" |
5 |
#include "CPP_OPTIONS.h" |
#include "CPP_OPTIONS.h" |
6 |
|
|
7 |
CBOP |
CBOP |
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 |
|
|
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 meesage buffer |
39 |
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 |
125 |
|
IF (useRunClock) CALL RUNCLOCK_CHECK( myThid ) |
126 |
|
#else |
127 |
|
IF (useRunClock) CALL PACKAGES_ERROR_MSG('RunClock',' ',myThid) |
128 |
|
#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 |
135 |
|
|
136 |
|
#ifdef ALLOW_PP81 |
137 |
|
IF (usePP81) CALL PP81_CHECK( myThid ) |
138 |
|
#else |
139 |
|
IF (usePP81) CALL PACKAGES_ERROR_MSG('PP81',' ',myThid) |
140 |
|
#endif |
141 |
|
|
142 |
|
#ifdef ALLOW_MY82 |
143 |
|
IF (useMY82) CALL MY82_CHECK( myThid ) |
144 |
|
#else |
145 |
|
IF (useMY82) CALL PACKAGES_ERROR_MSG('MY82',' ',myThid) |
146 |
|
#endif |
147 |
|
|
148 |
|
#ifdef ALLOW_GGL90 |
149 |
|
IF (useGGL90) CALL GGL90_CHECK( myThid ) |
150 |
|
#else |
151 |
|
IF (useGGL90) CALL PACKAGES_ERROR_MSG('GGL90',' ',myThid) |
152 |
|
#endif |
153 |
|
|
154 |
|
#ifdef ALLOW_OPPS |
155 |
|
IF (useOPPS) CALL OPPS_CHECK( myThid ) |
156 |
|
#else |
157 |
|
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 |
180 |
|
|
181 |
|
#ifndef ALLOW_BULK_FORCE |
182 |
|
IF (useBulkForce) CALL PACKAGES_ERROR_MSG( |
183 |
|
& 'BULK_FORCE', 'useBulkForce=.T.', myThid ) |
184 |
|
#endif |
185 |
|
|
186 |
|
#ifdef ALLOW_THSICE |
187 |
|
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 |
207 |
|
|
208 |
|
#ifndef ALLOW_MATRIX |
209 |
|
IF (useMATRIX) CALL PACKAGES_ERROR_MSG('MATRIX',' ',myThid) |
210 |
|
#endif |
211 |
|
|
212 |
|
#ifdef ALLOW_GCHEM |
213 |
|
IF (useGCHEM) CALL GCHEM_CHECK( myThid ) |
214 |
|
#else |
215 |
|
IF (useGCHEM) CALL PACKAGES_ERROR_MSG('GCHEM',' ',myThid) |
216 |
|
#endif |
217 |
|
|
218 |
|
#ifndef ALLOW_OFFLINE |
219 |
|
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 |
247 |
|
|
248 |
|
#ifdef ALLOW_SHELFICE |
249 |
|
IF (useShelfIce) CALL SHELFICE_CHECK( myThid ) |
250 |
|
#else |
251 |
|
IF (useShelfIce) CALL PACKAGES_ERROR_MSG('ShelfIce',' ',myThid) |
252 |
|
#endif |
253 |
|
|
254 |
|
#ifdef ALLOW_AUTODIFF |
255 |
|
CALL AUTODIFF_CHECK( myThid ) |
256 |
#endif |
#endif |
257 |
|
|
258 |
#if ( defined (ALLOW_ADJOINT_RUN) || \ |
#ifdef ALLOW_CTRL |
|
defined (ALLOW_TANGENTLINEAR_RUN) || \ |
|
|
defined (ALLOW_GRADIENT_CHECK) || \ |
|
|
defined (ALLOW_ECCO_OPTIMIZATION) ) |
|
259 |
CALL CTRL_CHECK( myThid ) |
CALL CTRL_CHECK( myThid ) |
260 |
|
#endif |
261 |
|
|
262 |
|
#ifdef ALLOW_COST |
263 |
CALL COST_CHECK( myThid ) |
CALL COST_CHECK( myThid ) |
264 |
#endif |
#endif |
265 |
|
|
266 |
|
#ifdef ALLOW_GRDCHK |
267 |
|
IF (useGRDCHK) CALL GRDCHK_CHECK( myThid ) |
268 |
|
#endif |
269 |
|
|
270 |
|
#ifdef ALLOW_DIAGNOSTICS |
271 |
|
IF (useDiagnostics) CALL DIAGNOSTICS_CHECK( myThid ) |
272 |
|
#else |
273 |
|
IF (useDiagnostics) |
274 |
|
& CALL PACKAGES_ERROR_MSG( 'Diagnostics', ' ', myThid ) |
275 |
|
#endif |
276 |
|
|
277 |
|
#ifdef ALLOW_REGRID |
278 |
|
IF (useREGRID) CALL REGRID_CHECK( myThid ) |
279 |
|
#else |
280 |
|
IF (useREGRID) CALL PACKAGES_ERROR_MSG('REGRID',' ',myThid) |
281 |
|
#endif |
282 |
|
|
283 |
|
#ifdef ALLOW_MYPACKAGE |
284 |
|
IF (useMYPACKAGE) CALL MYPACKAGE_CHECK( myThid ) |
285 |
|
#else |
286 |
|
IF (useMYPACKAGE) CALL PACKAGES_ERROR_MSG('MYPACKAGE',' ',myThid) |
287 |
|
#endif |
288 |
|
|
289 |
|
#ifdef ALLOW_SALT_PLUME |
290 |
|
IF (useSALT_PLUME)CALL SALT_PLUME_CHECK( myThid ) |
291 |
|
#else |
292 |
|
IF (useSALT_PLUME)CALL PACKAGES_ERROR_MSG('SALT_PLUME',' ',myThid) |
293 |
|
#endif |
294 |
|
|
295 |
|
C--- Exclusive packages (which cannot be used together): |
296 |
|
IF ( useEXF .AND. useBulkForce ) THEN |
297 |
|
WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ', |
298 |
|
& 'both useEXF and useBulkForce are set' |
299 |
|
CALL PRINT_ERROR( msgBuf , myThid ) |
300 |
|
WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ', |
301 |
|
& ' but cannot be used together => need to select only one.' |
302 |
|
CALL PRINT_ERROR( msgBuf , myThid ) |
303 |
|
STOP 'ABNORMAL END: S/R PACKAGES_CHECK' |
304 |
|
ENDIF |
305 |
|
|
306 |
RETURN |
RETURN |
307 |
END |
END |