1 |
C $Header: /u/gcmpack/MITgcm/verification/1D_ocean_ice_column/code_ad/ECCO_CPPOPTIONS.h,v 1.3 2014/10/01 16:05:47 gforget Exp $ |
2 |
C $Name: $ |
3 |
|
4 |
#ifndef ECCO_CPPOPTIONS_H |
5 |
#define ECCO_CPPOPTIONS_H |
6 |
|
7 |
C-- Collect here, in a single option-file, options to control which optional |
8 |
C features to compile in packages AUTODIFF, COST, CTRL, ECCO, CAL and EXF. |
9 |
C If used, this option-file needs to be directly included in CPP_OPTIONS.h |
10 |
C Although this method, inherited from ECCO setup, has been traditionally |
11 |
C used for all adjoint built, work is in progess to allow to use the |
12 |
C standard metod (each of the above pkg get its own options from its |
13 |
C specific option-file) also for adjoint built. |
14 |
|
15 |
C ******************************************************************** |
16 |
C *** ECCO Package *** |
17 |
C ******************************************************************** |
18 |
|
19 |
C allow use of legacy ecco/ctrl codes |
20 |
#define ECCO_CTRL_DEPRECATED |
21 |
|
22 |
cph >>>>>> !!!!!! SPECIAL SEAICE FLAG FOR TESTING !!!!!! <<<<<< |
23 |
#define SEAICE_EXCLUDE_FOR_EXACT_AD_TESTING |
24 |
cph >>>>>> !!!!!! SPECIAL SEAICE FLAG FOR TESTING !!!!!! <<<<<< |
25 |
|
26 |
#define ALLOW_ECCO_FORWARD_RUN |
27 |
c#define ALLOW_ECCO_OPTIMIZATION |
28 |
|
29 |
C >>> Do a long protocol. |
30 |
#undef ECCO_VERBOSE |
31 |
|
32 |
C ******************************************************************** |
33 |
C *** Adjoint Support Package *** |
34 |
C ******************************************************************** |
35 |
|
36 |
C o Include/exclude code in order to be able to automatically |
37 |
|
38 |
#define ALLOW_AUTODIFF_TAMC |
39 |
|
40 |
C >>> Checkpointing as handled by TAMC |
41 |
#define ALLOW_TAMC_CHECKPOINTING |
42 |
|
43 |
C extend to 4-level checkpointing |
44 |
#undef AUTODIFF_4_LEVEL_CHECKPOINT |
45 |
|
46 |
C >>> Extract adjoint state |
47 |
#define ALLOW_AUTODIFF_MONITOR |
48 |
|
49 |
C o use divided adjoint to split adjoint computations |
50 |
#undef ALLOW_DIVIDED_ADJOINT |
51 |
|
52 |
C o TAMC compatible subroutine parameter list |
53 |
#undef AUTODIFF_TAMC_COMPATIBILITY |
54 |
|
55 |
C ******************************************************************** |
56 |
C *** Calendar Package *** |
57 |
C ******************************************************************** |
58 |
|
59 |
C CPP flags controlling which code is included in the files that |
60 |
C will be compiled. |
61 |
|
62 |
CPH >>>>>> THERE ARE NO MORE CAL OPTIONS TO BE SET <<<<<< |
63 |
|
64 |
C ******************************************************************** |
65 |
C *** Cost function Package *** |
66 |
C ******************************************************************** |
67 |
|
68 |
C >>> Use the EGM-96 geoid error covariance. |
69 |
# undef ALLOW_EGM96_ERROR_COV |
70 |
# undef ALLOW_READ_EGM_DATA |
71 |
C >>> Use NSCAT data. |
72 |
# undef ALLOW_NSCAT_DATA |
73 |
C >>> Cost function contributions |
74 |
|
75 |
# undef ALLOW_HFLUX_COST_CONTRIBUTION |
76 |
# undef ALLOW_SFLUX_COST_CONTRIBUTION |
77 |
# undef ALLOW_USTRESS_COST_CONTRIBUTION |
78 |
# undef ALLOW_VSTRESS_COST_CONTRIBUTION |
79 |
|
80 |
# define ALLOW_ATEMP_COST_CONTRIBUTION |
81 |
# define ALLOW_AQH_COST_CONTRIBUTION |
82 |
# define ALLOW_UWIND_COST_CONTRIBUTION |
83 |
# define ALLOW_VWIND_COST_CONTRIBUTION |
84 |
# define ALLOW_PRECIP_COST_CONTRIBUTION |
85 |
# define ALLOW_SNOWPRECIP_COST_CONTRIBUTION |
86 |
# define ALLOW_SWDOWN_COST_CONTRIBUTION |
87 |
# define ALLOW_LWDOWN_COST_CONTRIBUTION |
88 |
# undef ALLOW_EVAP_COST_CONTRIBUTION |
89 |
# define ALLOW_APRESSURE_COST_CONTRIBUTION |
90 |
# undef ALLOW_RUNOFF_COST_CONTRIBUTION |
91 |
|
92 |
# define ALLOW_THETA0_COST_CONTRIBUTION |
93 |
# define ALLOW_SALT0_COST_CONTRIBUTION |
94 |
# define ALLOW_THETA_COST_CONTRIBUTION |
95 |
# define ALLOW_SALT_COST_CONTRIBUTION |
96 |
# undef ALLOW_SST_COST_CONTRIBUTION |
97 |
# undef ALLOW_SSS_COST_CONTRIBUTION |
98 |
|
99 |
# undef ALLOW_SSH_MEAN_COST_CONTRIBUTION |
100 |
# undef ALLOW_SSH_TPANOM_COST_CONTRIBUTION |
101 |
# undef ALLOW_SSH_ERSANOM_COST_CONTRIBUTION |
102 |
# undef ALLOW_SPH_PROJECTION |
103 |
# if (defined (ALLOW_SSH_MEAN_COST_CONTRIBUTION) || \ |
104 |
defined (ALLOW_SSH_TPANOM_COST_CONTRIBUTION) || \ |
105 |
defined (ALLOW_SSH_ERSANOM_COST_CONTRIBUTION)) |
106 |
# define ALLOW_SSH_COST_CONTRIBUTION |
107 |
# endif |
108 |
|
109 |
# undef ALLOW_CTDT_COST_CONTRIBUTION |
110 |
# undef ALLOW_CTDS_COST_CONTRIBUTION |
111 |
# undef ALLOW_XBT_COST_CONTRIBUTION |
112 |
# undef ALLOW_COST_ATLANTIC |
113 |
|
114 |
c >>> Open boundaries |
115 |
c >>> Make sure that ALLOW_OBCS is defined |
116 |
# undef ALLOW_OBCSN_COST_CONTRIBUTION |
117 |
# undef ALLOW_OBCSS_COST_CONTRIBUTION |
118 |
# undef ALLOW_OBCSW_COST_CONTRIBUTION |
119 |
# undef ALLOW_OBCSE_COST_CONTRIBUTION |
120 |
# if (defined (ALLOW_OBCSN_COST_CONTRIBUTION) || \ |
121 |
defined (ALLOW_OBCSS_COST_CONTRIBUTION) || \ |
122 |
defined (ALLOW_OBCSW_COST_CONTRIBUTION) || \ |
123 |
defined (ALLOW_OBCSE_COST_CONTRIBUTION)) |
124 |
# define ALLOW_OBCS_COST_CONTRIBUTION |
125 |
# endif |
126 |
|
127 |
C ******************************************************************** |
128 |
C *** Control vector Package *** |
129 |
C ******************************************************************** |
130 |
|
131 |
#define ALLOW_NONDIMENSIONAL_CONTROL_IO |
132 |
#undef ALLOW_TAMC_SINGLEPREC_COMLEV |
133 |
|
134 |
C >>> Initial values. |
135 |
#define ALLOW_THETA0_CONTROL |
136 |
#define ALLOW_SALT0_CONTROL |
137 |
|
138 |
C >>> Initial seaice |
139 |
#undef ALLOW_SIAREA_CONTROL |
140 |
#undef ALLOW_SIHEFF_CONTROL |
141 |
|
142 |
C >>> Surface fluxes. |
143 |
#undef ALLOW_HFLUX_CONTROL |
144 |
#undef ALLOW_SFLUX_CONTROL |
145 |
#undef ALLOW_USTRESS_CONTROL |
146 |
#undef ALLOW_VSTRESS_CONTROL |
147 |
|
148 |
C >>> Atmospheric state. |
149 |
#define ALLOW_ATEMP_CONTROL |
150 |
#define ALLOW_AQH_CONTROL |
151 |
#define ALLOW_PRECIP_CONTROL |
152 |
#define ALLOW_SNOWPRECIP_CONTROL |
153 |
#define ALLOW_SWDOWN_CONTROL |
154 |
#define ALLOW_LWDOWN_CONTROL |
155 |
#define ALLOW_UWIND_CONTROL |
156 |
#define ALLOW_VWIND_CONTROL |
157 |
#undef ALLOW_EVAP_CONTROL |
158 |
#define ALLOW_APRESSURE_CONTROL |
159 |
#undef ALLOW_RUNOFF_CONTROL |
160 |
|
161 |
C >>> Radiation |
162 |
#undef ALLOW_SWFLUX_CONTROL |
163 |
#undef ALLOW_LWFLUX_CONTROL |
164 |
|
165 |
C >>> seaice init. conditions |
166 |
#undef ALLOW_SIHSNOW_CONTROL |
167 |
|
168 |
C >>> Open boundaries |
169 |
c >>> Make sure that ALLOW_OBCS is defined |
170 |
#undef ALLOW_OBCSN_CONTROL |
171 |
#undef ALLOW_OBCSS_CONTROL |
172 |
#undef ALLOW_OBCSW_CONTROL |
173 |
#undef ALLOW_OBCSE_CONTROL |
174 |
#if (defined (ALLOW_OBCSN_CONTROL) || \ |
175 |
defined (ALLOW_OBCSS_CONTROL) || \ |
176 |
defined (ALLOW_OBCSW_CONTROL) || \ |
177 |
defined (ALLOW_OBCSE_CONTROL)) |
178 |
# define ALLOW_OBCS_CONTROL |
179 |
#endif |
180 |
|
181 |
C ******************************************************************** |
182 |
C *** External forcing Package *** |
183 |
C ******************************************************************** |
184 |
|
185 |
C Do more printout for the protocol file than usual. |
186 |
#undef EXF_VERBOSE |
187 |
|
188 |
C Bulk formulae related flags. |
189 |
#undef ALLOW_BULK_LARGYEAG04 |
190 |
#define ALLOW_ATM_TEMP |
191 |
#define ALLOW_ATM_WIND |
192 |
#define ALLOW_BULKFORMULAE |
193 |
#define ALLOW_DOWNWARD_RADIATION |
194 |
#define ALLOW_RUNOFF |
195 |
#undef EXF_READ_EVAP |
196 |
|
197 |
C Relaxation to monthly climatologies. |
198 |
#define ALLOW_CLIMSST_RELAXATION |
199 |
#define ALLOW_CLIMSSS_RELAXATION |
200 |
|
201 |
C ******************************************************************** |
202 |
#endif /* ECCO_CPPOPTIONS_H */ |