1 |
C $Header$ |
C $Header$ |
2 |
C $Name$ |
C $Name$ |
3 |
|
|
4 |
C |
#ifndef ECCO_CPPOPTIONS_H |
5 |
C CPP flags controlling which code is included in the files that |
#define ECCO_CPPOPTIONS_H |
6 |
C will be compiled. |
|
7 |
C |
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 ******************************************************************** |
C ******************************************************************** |
16 |
C *** ECCO Package *** |
C *** ECCO Package *** |
17 |
C ******************************************************************** |
C ******************************************************************** |
18 |
C |
|
19 |
|
C allow use of legacy ecco/ctrl codes |
20 |
|
#define ECCO_CTRL_DEPRECATED |
21 |
|
|
22 |
cph >>>>>> !!!!!! SPECIAL SEAICE FLAG FOR TESTING !!!!!! <<<<<< |
cph >>>>>> !!!!!! SPECIAL SEAICE FLAG FOR TESTING !!!!!! <<<<<< |
23 |
#define SEAICE_EXCLUDE_FOR_EXACT_AD_TESTING |
cph#define SEAICE_EXCLUDE_FOR_EXACT_AD_TESTING |
24 |
cph >>>>>> !!!!!! SPECIAL SEAICE FLAG FOR TESTING !!!!!! <<<<<< |
cph >>>>>> !!!!!! SPECIAL SEAICE FLAG FOR TESTING !!!!!! <<<<<< |
25 |
|
|
26 |
cph#define ALLOW_ECCO_FORWARD_RUN |
cph#define ALLOW_ECCO_FORWARD_RUN |
29 |
C >>> Do a long protocol. |
C >>> Do a long protocol. |
30 |
#undef ECCO_VERBOSE |
#undef ECCO_VERBOSE |
31 |
|
|
32 |
|
#define ALLOW_ECCO_EVOLUTION |
33 |
|
|
34 |
C ******************************************************************** |
C ******************************************************************** |
35 |
C *** Adjoint Support Package *** |
C *** Adjoint Support Package *** |
36 |
C ******************************************************************** |
C ******************************************************************** |
37 |
|
|
38 |
C o Include/exclude code in order to be able to automatically |
C o Include/exclude code in order to be able to automatically |
39 |
C |
|
40 |
#define ALLOW_AUTODIFF_TAMC |
#define ALLOW_AUTODIFF_TAMC |
41 |
C |
|
42 |
C >>> Checkpointing as handled by TAMC |
C >>> Checkpointing as handled by TAMC |
43 |
#define ALLOW_TAMC_CHECKPOINTING |
#define ALLOW_TAMC_CHECKPOINTING |
44 |
C |
|
45 |
C extend to 4-level checkpointing |
C extend to 4-level checkpointing |
46 |
#undef AUTODIFF_4_LEVEL_CHECKPOINT |
#undef AUTODIFF_4_LEVEL_CHECKPOINT |
47 |
C |
|
48 |
C >>> Extract adjoint state |
C >>> Extract adjoint state |
49 |
#define ALLOW_AUTODIFF_MONITOR |
#define ALLOW_AUTODIFF_MONITOR |
50 |
C |
|
51 |
C o use divided adjoint to split adjoint computations |
C o use divided adjoint to split adjoint computations |
52 |
#undef ALLOW_DIVIDED_ADJOINT |
#define ALLOW_DIVIDED_ADJOINT |
53 |
|
|
54 |
|
C o TAMC compatible subroutine parameter list |
55 |
|
#undef AUTODIFF_TAMC_COMPATIBILITY |
56 |
|
|
57 |
C ******************************************************************** |
C ******************************************************************** |
58 |
C *** Calendar Package *** |
C *** Calendar Package *** |
59 |
C ******************************************************************** |
C ******************************************************************** |
60 |
C |
|
61 |
C CPP flags controlling which code is included in the files that |
C CPP flags controlling which code is included in the files that |
62 |
C will be compiled. |
C will be compiled. |
63 |
|
|
66 |
C ******************************************************************** |
C ******************************************************************** |
67 |
C *** Cost function Package *** |
C *** Cost function Package *** |
68 |
C ******************************************************************** |
C ******************************************************************** |
69 |
C |
|
|
#define ALLOW_COST |
|
|
#ifdef ALLOW_COST |
|
70 |
C >>> Use the EGM-96 geoid error covariance. |
C >>> Use the EGM-96 geoid error covariance. |
71 |
# undef ALLOW_EGM96_ERROR_COV |
# undef ALLOW_EGM96_ERROR_COV |
72 |
# undef ALLOW_READ_EGM_DATA |
# undef ALLOW_READ_EGM_DATA |
96 |
# define ALLOW_THETA_COST_CONTRIBUTION |
# define ALLOW_THETA_COST_CONTRIBUTION |
97 |
# define ALLOW_SALT_COST_CONTRIBUTION |
# define ALLOW_SALT_COST_CONTRIBUTION |
98 |
# define ALLOW_SST_COST_CONTRIBUTION |
# define ALLOW_SST_COST_CONTRIBUTION |
99 |
# undef ALLOW_SSS_COST_CONTRIBUTION |
# define ALLOW_SSS_COST_CONTRIBUTION |
100 |
|
|
101 |
# define ALLOW_SSH_MEAN_COST_CONTRIBUTION |
# define ALLOW_SSH_MEAN_COST_CONTRIBUTION |
102 |
# define ALLOW_SSH_TPANOM_COST_CONTRIBUTION |
# define ALLOW_SSH_TPANOM_COST_CONTRIBUTION |
126 |
# define ALLOW_OBCS_COST_CONTRIBUTION |
# define ALLOW_OBCS_COST_CONTRIBUTION |
127 |
# endif |
# endif |
128 |
|
|
|
c >>> Sea-ice volume |
|
|
# undef ALLOW_COST_ICE |
|
|
|
|
|
c >>> Sea-ice misfit to obs |
|
|
# define ALLOW_SEAICE_COST_SMR_AREA |
|
|
|
|
|
#endif /* ALLOW_COST */ |
|
|
|
|
129 |
C ******************************************************************** |
C ******************************************************************** |
130 |
C *** Control vector Package *** |
C *** Control vector Package *** |
131 |
C ******************************************************************** |
C ******************************************************************** |
132 |
C |
|
133 |
#define ALLOW_NONDIMENSIONAL_CONTROL_IO |
#define ALLOW_NONDIMENSIONAL_CONTROL_IO |
134 |
|
#undef ALLOW_TAMC_SINGLEPREC_COMLEV |
135 |
|
|
136 |
C >>> Initial values. |
C >>> Initial values. |
137 |
#define ALLOW_THETA0_CONTROL |
#define ALLOW_THETA0_CONTROL |
169 |
#define ALLOW_SIHEFF_CONTROL |
#define ALLOW_SIHEFF_CONTROL |
170 |
#undef ALLOW_SIHSNOW_CONTROL |
#undef ALLOW_SIHSNOW_CONTROL |
171 |
|
|
172 |
|
C >>> relaxation terms |
173 |
|
#define ALLOW_SST_CONTROL |
174 |
|
#define ALLOW_SSS_CONTROL |
175 |
|
|
176 |
C >>> Open boundaries |
C >>> Open boundaries |
177 |
c >>> Make sure that ALLOW_OBCS is defined |
c >>> Make sure that ALLOW_OBCS is defined |
178 |
#undef ALLOW_OBCSN_CONTROL |
#undef ALLOW_OBCSN_CONTROL |
189 |
C ******************************************************************** |
C ******************************************************************** |
190 |
C *** External forcing Package *** |
C *** External forcing Package *** |
191 |
C ******************************************************************** |
C ******************************************************************** |
|
C |
|
|
C o Include/exclude the external forcing package. To use this package, |
|
|
C you have to include the calendar tool as well. KPP can be switched |
|
|
C on or off. The implementation automatically takes care of this. |
|
|
#define INCLUDE_EXTERNAL_FORCING_PACKAGE |
|
|
|
|
|
C Do more printout for the protocol file than usual. |
|
|
#undef EXF_VERBOSE |
|
192 |
|
|
193 |
C Bulk formulae related flags. |
C Bulk formulae related flags. |
194 |
#undef ALLOW_BULK_LARGYEAG04 |
#undef ALLOW_BULK_LARGYEAG04 |
199 |
#define ALLOW_RUNOFF |
#define ALLOW_RUNOFF |
200 |
#undef EXF_READ_EVAP |
#undef EXF_READ_EVAP |
201 |
|
|
202 |
|
C Use ocean_emissivity*lwdwon in lwFlux. This flag should be define |
203 |
|
C unless to reproduce old results (obtained with inconsistent old code) |
204 |
|
#ifdef ALLOW_DOWNWARD_RADIATION |
205 |
|
# define EXF_LWDOWN_WITH_EMISSIVITY |
206 |
|
#endif |
207 |
|
|
208 |
C Relaxation to monthly climatologies. |
C Relaxation to monthly climatologies. |
209 |
#define ALLOW_CLIMSST_RELAXATION |
#define ALLOW_CLIMSST_RELAXATION |
210 |
#define ALLOW_CLIMSSS_RELAXATION |
#define ALLOW_CLIMSSS_RELAXATION |
211 |
|
|
212 |
|
C Seaice area relaxation code |
213 |
|
#define EXF_SEAICE_FRACTION |
214 |
|
|
215 |
|
C ******************************************************************** |
216 |
|
#endif /* ECCO_CPPOPTIONS_H */ |