forked from darwinproject/darwin3
-
Notifications
You must be signed in to change notification settings - Fork 1
/
packages_check.F
532 lines (458 loc) · 13.8 KB
/
packages_check.F
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
#include "PACKAGES_CONFIG.h"
#include "CPP_OPTIONS.h"
CBOP
C !ROUTINE: PACKAGES_CHECK
C !INTERFACE:
SUBROUTINE PACKAGES_CHECK( myThid )
C !DESCRIPTION: \bv
C *==========================================================*
C | SUBROUTINE PACKAGES_CHECK
C | o Check runtime activated packages have been built in.
C *==========================================================*
C | All packages can be selected/deselected at build time
C | ( when code is compiled ) and activated/deactivated at
C | runtime. This routine does a quick check to trap packages
C | that were activated at runtime but that were not compiled
C | in at build time.
C *==========================================================*
C \ev
C !CALLING SEQUENCE:
C PACKAGES_CHECK
C |
C |-- OBCS_CHECK
C |
C |-- OPPS_CHECK
C |
C |-- PP81_CHECK
C |
C |-- KL10_CHECK
C |
C |-- MY82_CHECK
C |
C |-- GGL90_CHECK
C |
C |-- KPP_CHECK
C |
C |-- GMREDI_CHECK
C |
C |-- BBL_CHECK
C |
C |-- EXF_CHECK
C |
C |-- LONGSTEP_CHECK
C |
C |-- PTRACERS_CHECK
C |
C |-- GCHEM_CHECK
C |
C |-- OFFLINE_CHECK
C |
C |-- SEAICE_CHECK
C |
C |-- SHELFICE_CHECK
C |
C |-- SMOOTH_CHECK
C |
C |-- STREAMICE_CHECK
C |
C |-- ICEFRONT_CHECK
C |
C |-- THSICE_CHECK
C |
C |-- LAND_CHECK
C |
C |-- ATM_PHYS_CHECK
C |
C |-- AUTODIFF_CHECK
C |
C |-- CTRL_CHECK
C |
C |-- COST_CHECK
C |
C |-- GRDCHK_CHECK
C |
C |-- SBO_CHECK
C |
C |-- ECCO_CHECK
C |
C |-- DIAGNOSTICS_CHECK
C |
C |-- REGRID_CHECK
C |
C |-- LAYERS_CHECK
C |
C |-- NEST_CHILD_CHECK
C |
C |-- NEST_PARENT_CHECK
C |
C |-- OASIS_CHECK
C |
C |-- RUNCLOCK_CHECK
C |
C |-- MYPACKAGE_CHECK
C |
C |-- GAD_CHECK
C !USES:
IMPLICIT NONE
C === Global variables ===
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
C !INPUT/OUTPUT PARAMETERS:
C === Routine arguments ===
C myThid :: my Thread Id number
INTEGER myThid
C !LOCAL VARIABLES:
C === Local variables ===
C msgBuf :: Informational/error message buffer
CHARACTER*(MAX_LEN_MBUF) msgBuf
CEOP
_BEGIN_MASTER(myThid)
WRITE(msgBuf,'(A)')
&'== Packages configuration : Check & print summary =='
CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
& SQUEEZE_RIGHT, myThid )
WRITE(msgBuf,'(A)') ' '
CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
& SQUEEZE_RIGHT, myThid )
_END_MASTER(myThid)
C--- Start with non-standard packages (without or with non standard flag)
#ifndef ALLOW_MNC
IF (useMNC) THEN
_BEGIN_MASTER(myThid)
WRITE(msgBuf,'(2A)') '** WARNING **',
& ' PACKAGES_CHECK: useMNC is TRUE'
CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
& SQUEEZE_RIGHT, myThid )
WRITE(msgBuf,'(2A)') '** WARNING **',
& ' but pkg/mnc has not been compiled (#undef ALLOW_MNC)'
CALL PRINT_MESSAGE( msgBuf, errorMessageUnit,
& SQUEEZE_RIGHT, myThid )
_END_MASTER(myThid)
ENDIF
#endif
#ifndef ALLOW_MOM_VECINV
IF ( momStepping .AND. vectorInvariantMomentum ) THEN
WRITE(msgBuf,'(2A)')
& 'PACKAGES_CHECK: cannot step forward Momentum',
& ' without pkg/mom_vecinv'
CALL PRINT_ERROR( msgBuf , myThid )
WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
& 'Re-compile with pkg "mom_vecinv" in packages.conf'
CALL PRINT_ERROR( msgBuf , myThid )
CALL ALL_PROC_DIE( myThid )
STOP 'ABNORMAL END: S/R PACKAGES_CHECK'
ENDIF
#endif
#ifndef ALLOW_MOM_FLUXFORM
IF ( momStepping .AND. .NOT.vectorInvariantMomentum ) THEN
WRITE(msgBuf,'(2A)')
& 'PACKAGES_CHECK: cannot step forward Momentum',
& ' without pkg/mom_fluxform'
CALL PRINT_ERROR( msgBuf , myThid )
WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
& 'Re-compile with pkg "mom_fluxform" in packages.conf'
CALL PRINT_ERROR( msgBuf , myThid )
CALL ALL_PROC_DIE( myThid )
STOP 'ABNORMAL END: S/R PACKAGES_CHECK'
ENDIF
#endif
#ifndef ALLOW_GENERIC_ADVDIFF
IF ( tempStepping .OR. saltStepping ) THEN
WRITE(msgBuf,'(2A)')
& 'PACKAGES_CHECK: cannot step forward Temp or Salt',
& ' without pkg/generic_advdiff'
CALL PRINT_ERROR( msgBuf , myThid )
WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
& 'Re-compile with pkg "generic_advdiff" in packages.conf'
CALL PRINT_ERROR( msgBuf , myThid )
CALL ALL_PROC_DIE( myThid )
STOP 'ABNORMAL END: S/R PACKAGES_CHECK'
ENDIF
#endif
#ifndef ALLOW_MONITOR
C If monitorFreq is finite, make sure the pkg/monitor is being compiled
IF (monitorFreq.NE.0.) CALL PACKAGES_ERROR_MSG(
& 'MONITOR', 'monitorFreq <> 0', myThid )
#endif
#ifndef ALLOW_TIMEAVE
C If taveFreq is finite, make sure the pkg/timeave is being compiled
IF (taveFreq.NE.0.) CALL PACKAGES_ERROR_MSG(
& 'TIMEAVE', 'taveFreq <> 0', myThid )
#endif
#ifndef ALLOW_CD_CODE
IF (useCDscheme) CALL PACKAGES_ERROR_MSG(
& 'CD_CODE', 'useCDscheme=.T.', myThid )
#endif
C--- Continue with standard packages (with standard usePKG flag)
#ifdef ALLOW_OBCS
IF (useOBCS) CALL OBCS_CHECK( myThid )
#else
IF (useOBCS) CALL PACKAGES_ERROR_MSG('OBCS',' ',myThid)
#endif
#ifndef ALLOW_SHAP_FILT
IF (useSHAP_FILT)
& CALL PACKAGES_ERROR_MSG( 'SHAP_FILT', ' ', myThid )
#endif
#ifndef ALLOW_ZONAL_FILT
IF (useZONAL_FILT)
& CALL PACKAGES_ERROR_MSG( 'ZONAL_FILT', ' ', myThid )
#endif
#ifdef ALLOW_OPPS
IF (useOPPS) CALL OPPS_CHECK( myThid )
#else
IF (useOPPS) CALL PACKAGES_ERROR_MSG('OPPS',' ',myThid)
#endif
#ifdef ALLOW_PP81
IF (usePP81) CALL PP81_CHECK( myThid )
#else
IF (usePP81) CALL PACKAGES_ERROR_MSG('PP81',' ',myThid)
#endif
#ifdef ALLOW_KL10
IF (useKL10) CALL KL10_CHECK( myThid )
#else
IF (useKL10) CALL PACKAGES_ERROR_MSG('KL10',' ',myThid)
#endif
#ifdef ALLOW_MY82
IF (useMY82) CALL MY82_CHECK( myThid )
#else
IF (useMY82) CALL PACKAGES_ERROR_MSG('MY82',' ',myThid)
#endif
#ifdef ALLOW_GGL90
IF (useGGL90) CALL GGL90_CHECK( myThid )
#else
IF (useGGL90) CALL PACKAGES_ERROR_MSG('GGL90',' ',myThid)
#endif
#ifdef ALLOW_KPP
IF (useKPP) CALL KPP_CHECK( myThid )
#else
IF (useKPP) CALL PACKAGES_ERROR_MSG('KPP',' ',myThid)
#endif
#ifdef ALLOW_GMREDI
IF (useGMRedi) CALL GMREDI_CHECK( myThid )
#else
IF (useGMRedi) CALL PACKAGES_ERROR_MSG('GMRedi',' ',myThid)
#endif
#ifdef ALLOW_BBL
IF (useBBL) CALL BBL_CHECK( myThid )
#else
IF (useBBL) CALL PACKAGES_ERROR_MSG('BBL',' ',myThid)
#endif
#ifndef ALLOW_DOWN_SLOPE
IF (useDOWN_SLOPE)
& CALL PACKAGES_ERROR_MSG('DOWN_SLOPE',' ',myThid)
#endif
#ifndef ALLOW_CAL
IF (useCAL) CALL PACKAGES_ERROR_MSG('CAL',' ',myThid)
#endif
#ifdef ALLOW_EXF
IF (useEXF) CALL EXF_CHECK( myThid )
#else
IF (useEXF) CALL PACKAGES_ERROR_MSG('EXF',' ',myThid)
#endif
#ifndef ALLOW_BULK_FORCE
IF (useBulkForce) CALL PACKAGES_ERROR_MSG(
& 'BULK_FORCE', 'useBulkForce=.T.', myThid )
#endif
#ifndef ALLOW_EBM
IF (useEBM) CALL PACKAGES_ERROR_MSG('EBM',' ',myThid)
#endif
#ifndef ALLOW_CHEAPAML
IF (useCheapAML) CALL PACKAGES_ERROR_MSG('CheapAML',' ',myThid)
#endif
#ifndef ALLOW_FLT
IF (useFLT) CALL PACKAGES_ERROR_MSG('FLT',' ',myThid)
#endif
#ifdef ALLOW_RADTRANS
IF (useRADTRANS) CALL RADTRANS_CHECK( myThid )
#else
IF (useRADTRANS) CALL PACKAGES_ERROR_MSG('RADTRANS',' ',myThid)
#endif
#ifdef ALLOW_LONGSTEP
IF (usePTRACERS) CALL LONGSTEP_CHECK( myThid )
#endif
#ifdef ALLOW_PTRACERS
IF (usePTRACERS) CALL PTRACERS_CHECK( myThid )
#else
IF (usePTRACERS) CALL PACKAGES_ERROR_MSG('PTRACERS',' ',myThid)
#endif
#ifdef ALLOW_GCHEM
IF (useGCHEM) CALL GCHEM_CHECK( myThid )
#else
IF (useGCHEM) CALL PACKAGES_ERROR_MSG('GCHEM',' ',myThid)
#endif
#ifndef ALLOW_RBCS
IF (useRBCS) CALL PACKAGES_ERROR_MSG('RBCS',' ',myThid)
#endif
#ifdef ALLOW_OFFLINE
IF (useOffLine) CALL OFFLINE_CHECK( myThid )
#else
IF (useOffLine) CALL PACKAGES_ERROR_MSG('OffLine',' ',myThid)
#endif
#ifndef ALLOW_MATRIX
IF (useMATRIX) CALL PACKAGES_ERROR_MSG('MATRIX',' ',myThid)
#endif
#ifndef ALLOW_FRAZIL
IF (useFRAZIL) CALL PACKAGES_ERROR_MSG('FRAZIL',' ',myThid)
#endif
#ifdef ALLOW_SEAICE
IF (useSEAICE) CALL SEAICE_CHECK( myThid )
#else
IF (useSEAICE) CALL PACKAGES_ERROR_MSG('SEAICE',' ',myThid)
#endif
#ifdef ALLOW_SALT_PLUME
IF (useSALT_PLUME)CALL SALT_PLUME_CHECK( myThid )
#else
IF (useSALT_PLUME)CALL PACKAGES_ERROR_MSG('SALT_PLUME',' ',myThid)
#endif
#ifdef ALLOW_SHELFICE
IF (useShelfIce) CALL SHELFICE_CHECK( myThid )
#else
IF (useShelfIce) CALL PACKAGES_ERROR_MSG('ShelfIce',' ',myThid)
#endif
#ifdef ALLOW_SMOOTH
IF (useSmooth) CALL SMOOTH_CHECK( myThid )
#else
IF (useSmooth) CALL PACKAGES_ERROR_MSG('Smooth',' ',myThid)
#endif
#ifdef ALLOW_STREAMICE
IF (useStreamIce) CALL STREAMICE_CHECK( myThid )
#else
IF (useStreamIce) CALL PACKAGES_ERROR_MSG('StreamIce',' ',myThid)
#endif
#ifdef ALLOW_ICEFRONT
IF (useICEFRONT) CALL ICEFRONT_CHECK( myThid )
#else
IF (useICEFRONT) CALL PACKAGES_ERROR_MSG('ICEFRONT',' ',myThid)
#endif
#ifdef ALLOW_THSICE
IF (useThSIce) CALL THSICE_CHECK( myThid )
#else
IF (useThSIce) CALL PACKAGES_ERROR_MSG('ThSIce',' ',myThid)
#endif
#ifdef ALLOW_LAND
IF (useLand) CALL LAND_CHECK( myThid )
#else
IF (useLand) CALL PACKAGES_ERROR_MSG('Land',' ',myThid)
#endif
#ifndef ALLOW_ATM2D
IF (useATM2D) CALL PACKAGES_ERROR_MSG('ATM2D',' ',myThid)
#endif
#ifndef ALLOW_AIM
IF (useAIM) CALL PACKAGES_ERROR_MSG('AIM',' ',myThid)
#endif
#ifdef ALLOW_ATM_PHYS
IF (useAtm_Phys) CALL ATM_PHYS_CHECK( myThid )
#else
IF (useAtm_Phys) CALL PACKAGES_ERROR_MSG('Atm_Phys',' ',myThid)
#endif
#ifndef ALLOW_FIZHI
IF (useFizhi) CALL PACKAGES_ERROR_MSG('Fizhi',' ',myThid)
#endif
#ifndef ALLOW_GRIDALT
IF (useGridAlt) CALL PACKAGES_ERROR_MSG('GridAlt',' ',myThid)
#endif
#ifdef ALLOW_AUTODIFF
IF (useAUTODIFF) CALL AUTODIFF_CHECK( myThid )
#endif
#ifdef ALLOW_CTRL
IF (useCTRL) CALL CTRL_CHECK( myThid )
#endif
#ifdef ALLOW_COST
CALL COST_CHECK( myThid )
#endif
#ifdef ALLOW_GRDCHK
IF (useGrdChk) CALL GRDCHK_CHECK( myThid )
#else
IF (useGrdChk) CALL PACKAGES_ERROR_MSG('GrdChk',' ',myThid)
#endif
#ifndef ALLOW_SMOOTH
IF (useSMOOTH) CALL PACKAGES_ERROR_MSG('SMOOTH',' ',myThid)
#endif
#ifndef ALLOW_PROFILES
IF (usePROFILES) CALL PACKAGES_ERROR_MSG('PROFILES',' ',myThid)
#endif
#ifdef ALLOW_SBO
IF (useSBO) CALL SBO_CHECK( myThid )
#else
IF (useSBO) CALL PACKAGES_ERROR_MSG('SBO',' ',myThid)
#endif
#ifdef ALLOW_ECCO
IF (useECCO) CALL ECCO_CHECK( myThid )
#endif
#ifdef ALLOW_DIAGNOSTICS
IF (useDiagnostics) CALL DIAGNOSTICS_CHECK( myThid )
#else
IF (useDiagnostics)
& CALL PACKAGES_ERROR_MSG( 'Diagnostics', ' ', myThid )
#endif
#ifdef ALLOW_REGRID
IF (useREGRID) CALL REGRID_CHECK( myThid )
#else
IF (useREGRID) CALL PACKAGES_ERROR_MSG('REGRID',' ',myThid)
#endif
#ifdef ALLOW_LAYERS
IF ( useLayers ) CALL LAYERS_CHECK( myThid )
#else
IF ( useLayers ) CALL PACKAGES_ERROR_MSG('LAYERS',' ',myThid)
#endif /* ALLOW_LAYERS */
#ifdef ALLOW_NEST_CHILD
IF (useNEST_CHILD) CALL NEST_CHILD_CHECK( myThid )
#else
IF (useNEST_CHILD) CALL PACKAGES_ERROR_MSG(
& 'NEST_CHILD',' ',myThid)
#endif
#ifdef ALLOW_NEST_PARENT
IF (useNEST_PARENT) CALL NEST_PARENT_CHECK( myThid )
#else
IF (useNEST_PARENT) CALL PACKAGES_ERROR_MSG(
& 'NEST_PARENT',' ',myThid)
#endif
#ifdef ALLOW_OASIS
IF (useOASIS) CALL OASIS_CHECK( myThid )
#else
IF (useOASIS) CALL PACKAGES_ERROR_MSG('OASIS',' ',myThid)
#endif
#ifdef ALLOW_RUNCLOCK
IF (useRunClock) CALL RUNCLOCK_CHECK( myThid )
#else
IF (useRunClock) CALL PACKAGES_ERROR_MSG('RunClock',' ',myThid)
#endif
#ifndef ALLOW_EMBED_FILES
IF (useEMBED_FILES) CALL PACKAGES_ERROR_MSG(
& 'EMBED_FILES',' ',myThid)
#endif
#ifdef ALLOW_MYPACKAGE
IF (useMYPACKAGE) CALL MYPACKAGE_CHECK( myThid )
#else
IF (useMYPACKAGE) CALL PACKAGES_ERROR_MSG('MYPACKAGE',' ',myThid)
#endif
#ifdef ALLOW_GENERIC_ADVDIFF
C- Check generic AdvDiff setting and related overlap minimum size:
C for this reason, called after other ${pkg}_check S/R
IF (useGAD) CALL GAD_CHECK( myThid )
#endif
C--- Exclusive packages (which cannot be used together):
IF ( useEXF .AND. useBulkForce ) THEN
WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
& 'both useEXF and useBulkForce are set'
CALL PRINT_ERROR( msgBuf , myThid )
WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
& ' but cannot be used together => need to select only one.'
CALL PRINT_ERROR( msgBuf , myThid )
CALL ALL_PROC_DIE( myThid )
STOP 'ABNORMAL END: S/R PACKAGES_CHECK'
ENDIF
C--- Exclusive packages (which cannot be used together):
IF ( useDOWN_SLOPE .AND. useBBL ) THEN
WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
& 'both useDOWN_SLOPE and useBBL are set'
CALL PRINT_ERROR( msgBuf , myThid )
WRITE(msgBuf,'(2A)') 'PACKAGES_CHECK: ',
& ' but cannot be used together => need to select only one.'
CALL PRINT_ERROR( msgBuf , myThid )
CALL ALL_PROC_DIE( myThid )
STOP 'ABNORMAL END: S/R PACKAGES_CHECK'
ENDIF
RETURN
END