1 |
C $Header: /u/gcmpack/MITgcm/pkg/cost/COST_OPTIONS.h,v 1.2 2014/04/05 21:52:51 jmc Exp $ |
2 |
C $Name: $ |
3 |
|
4 |
CBOP |
5 |
C !ROUTINE: COST_OPTIONS.h |
6 |
C !INTERFACE: |
7 |
C #include "COST_OPTIONS.h" |
8 |
|
9 |
C !DESCRIPTION: |
10 |
C *==================================================================* |
11 |
C | CPP options file for Cost-Function (cost) package: |
12 |
C | Control which optional features to compile in this package code. |
13 |
C *==================================================================* |
14 |
CEOP |
15 |
|
16 |
#ifndef COST_OPTIONS_H |
17 |
#define COST_OPTIONS_H |
18 |
#include "PACKAGES_CONFIG.h" |
19 |
#include "CPP_OPTIONS.h" |
20 |
|
21 |
#ifdef ALLOW_COST |
22 |
#ifdef ECCO_CPPOPTIONS_H |
23 |
|
24 |
C-- When multi-package option-file ECCO_CPPOPTIONS.h is used (directly included |
25 |
C in CPP_OPTIONS.h), this option file is left empty since all options that |
26 |
C are specific to this package are assumed to be set in ECCO_CPPOPTIONS.h |
27 |
|
28 |
#else /* ndef ECCO_CPPOPTIONS_H */ |
29 |
C ================================================================== |
30 |
C-- Package-specific Options & Macros go here |
31 |
|
32 |
C >>> Use the EGM-96 geoid error covariance. |
33 |
#undef ALLOW_EGM96_ERROR_COV |
34 |
#undef ALLOW_READ_EGM_DATA |
35 |
C >>> Cost function contributions |
36 |
#undef ALLOW_HFLUX_COST_CONTRIBUTION |
37 |
#undef ALLOW_SFLUX_COST_CONTRIBUTION |
38 |
#undef ALLOW_USTRESS_COST_CONTRIBUTION |
39 |
#undef ALLOW_VSTRESS_COST_CONTRIBUTION |
40 |
#undef ALLOW_THETA_COST_CONTRIBUTION |
41 |
#undef ALLOW_SALT_COST_CONTRIBUTION |
42 |
#undef ALLOW_SST_COST_CONTRIBUTION |
43 |
#undef ALLOW_SSS_COST_CONTRIBUTION |
44 |
#undef ALLOW_SSH_COST_CONTRIBUTION |
45 |
#undef ALLOW_CTDT_COST_CONTRIBUTION |
46 |
#undef ALLOW_CTDS_COST_CONTRIBUTION |
47 |
#undef ALLOW_COST_ATLANTIC |
48 |
#undef ALLOW_COST_ATLANTIC_HEAT |
49 |
|
50 |
#undef ALLOW_COST_TEST |
51 |
#undef ALLOW_COST_TSQUARED |
52 |
#define ALLOW_COST_TRACER |
53 |
|
54 |
C >>> ALLOW_GENCOST_CONTRIBUTION: interactive way to add basic 2D cost |
55 |
C function terms. |
56 |
C > In data.ecco, this requires the specification of data file (name, |
57 |
C frequency, etc.), bar file name for corresp. model average, standard |
58 |
C error file name, etc. |
59 |
C > In addition, adding such cost terms requires editing ecco_cost.h to |
60 |
C increase NGENCOST, and editing cost_gencost_customize.F to implement |
61 |
C the actual model average (i.e. the bar file content). |
62 |
#undef ALLOW_GENCOST_CONTRIBUTION |
63 |
C >>> free form version of GENCOST: allows one to use otherwise defined |
64 |
C elements (e.g. psbar and and topex data) while taking advantage of the |
65 |
C cost function/namelist slots that can be made available using |
66 |
C ALLOW_GENCOST_CONTRIBUTION. To this end ALLOW_GENCOST_CONTRIBUTION |
67 |
C simply switches off tests that check whether all of the gencost |
68 |
C elements (e.g. gencost_barfile and gencost_datafile) are specified |
69 |
C in data.ecco. |
70 |
C > While this option increases flexibility within the gencost framework, |
71 |
C it implies more room for error, so it should be used cautiously, and |
72 |
C with good knowledge of the rest of pkg/ecco. |
73 |
C > It requires providing a specific cost function routine, and editing |
74 |
C cost_gencost_all.F accordingly. |
75 |
#undef ALLOW_GENCOST_FREEFORM |
76 |
|
77 |
C ================================================================== |
78 |
#endif /* ndef ECCO_CPPOPTIONS_H */ |
79 |
#endif /* ALLOW_COST */ |
80 |
#endif /* COST_OPTIONS_H */ |