1 |
C $Header: /u/gcmpack/MITgcm/pkg/ecco/ECCO_CPPOPTIONS.h,v 1.5 2003/11/01 04:50:02 edhill Exp $ |
2 |
C $Name: checkpoint56 $ |
3 |
|
4 |
#ifndef ECCO_CPPOPTIONS_H |
5 |
#define ECCO_CPPOPTIONS_H |
6 |
#include "AD_CONFIG.h" |
7 |
#include "PACKAGES_CONFIG.h" |
8 |
#ifdef ALLOW_ECCO |
9 |
|
10 |
#include "CPP_OPTIONS.h" |
11 |
|
12 |
C CPP flags controlling which code is included in the files that |
13 |
C will be compiled. |
14 |
C |
15 |
C ******************************************************************** |
16 |
C *** ECCO Package *** |
17 |
C ******************************************************************** |
18 |
C |
19 |
C o include dump of snap shots for checks |
20 |
#undef ALLOW_SNAPSHOTS |
21 |
|
22 |
#define ALLOW_ECCO_FORWARD_RUN |
23 |
#undef ALLOW_ECCO_DIAGNOSTICS_RUN |
24 |
#undef ALLOW_ECCO_ADJOINT_RUN |
25 |
#undef ALLOW_ECCO_GRADIENT_CHECK |
26 |
#undef ALLOW_ECCO_OPTIMIZATION |
27 |
|
28 |
C Flag to include (dirty adhoc) balancing of boudary fluxes |
29 |
#undef ALLOW_CTRL_OBCS_BALANCE |
30 |
|
31 |
C >>> Do a long protocol. |
32 |
#undef ECCO_VERBOSE |
33 |
|
34 |
C >>> Just do a "dry" run ( useful for testing ). |
35 |
#undef ALLOW_NO_DYNAMICS |
36 |
C >>> Use the Yearly-Monthly-Daily-Stepping call tree. |
37 |
#undef ALLOW_YMDS_TREE |
38 |
C >>> Do not call stepping |
39 |
#define ALLOW_STEPPING_CALL |
40 |
|
41 |
C ******************************************************************** |
42 |
C *** Adjoint Support Package *** |
43 |
C ******************************************************************** |
44 |
|
45 |
C o Include/exclude code in order to be able to automatically |
46 |
C differentiate the MITgcmUV by using the Tangent Linear and |
47 |
C Adjoint Model Compiler (TAMC). |
48 |
#undef INCLUDE_AUTODIFF_PACKAGE |
49 |
C |
50 |
#undef ALLOW_AUTODIFF_TAMC |
51 |
C >>> Checkpointing as handled by TAMC |
52 |
#undef ALLOW_TAMC_CHECKPOINTING |
53 |
|
54 |
C o use divided adjoint to split adjoint computations |
55 |
#undef ALLOW_DIVIDED_ADJOINT |
56 |
|
57 |
C ******************************************************************** |
58 |
C *** Calendar Package *** |
59 |
C ******************************************************************** |
60 |
C |
61 |
C CPP flags controlling which code is included in the files that |
62 |
C will be compiled. |
63 |
C |
64 |
|
65 |
C o Include the calendar tool. |
66 |
#define ALLOW_CALENDAR |
67 |
|
68 |
C ******************************************************************** |
69 |
C *** Cost function Package *** |
70 |
C ******************************************************************** |
71 |
C |
72 |
C >>> Use the EGM-96 geoid error covariance. |
73 |
#undef ALLOW_EGM96_ERROR_COV |
74 |
#undef ALLOW_READ_EGM_DATA |
75 |
C >>> Use NSCAT data. |
76 |
#undef ALLOW_NSCAT_DATA |
77 |
C >>> Cost function contributions |
78 |
#undef ALLOW_HFLUX_COST_CONTRIBUTION |
79 |
#undef ALLOW_SFLUX_COST_CONTRIBUTION |
80 |
#undef ALLOW_USTRESS_COST_CONTRIBUTION |
81 |
#undef ALLOW_VSTRESS_COST_CONTRIBUTION |
82 |
#undef ALLOW_THETA_COST_CONTRIBUTION |
83 |
#undef ALLOW_SALT_COST_CONTRIBUTION |
84 |
#undef ALLOW_SST_COST_CONTRIBUTION |
85 |
#undef ALLOW_SSH_COST_CONTRIBUTION |
86 |
#undef ALLOW_CTDT_COST_CONTRIBUTION |
87 |
#undef ALLOW_CTDS_COST_CONTRIBUTION |
88 |
#undef ALLOW_COST_ATLANTIC |
89 |
C >>> Projection onto Spherical Harmonics |
90 |
#undef ALLOW_SPH_PROJECTION |
91 |
|
92 |
C ******************************************************************** |
93 |
C *** Control vector Package *** |
94 |
C ******************************************************************** |
95 |
C |
96 |
#undef ALLOW_NONDIMENSIONAL_CONTROL_IO |
97 |
C >>> Replace hooks for the control variables. |
98 |
#ifdef INCLUDE_ECCO_PACKAGE |
99 |
#define _GET_HFLUX_CONTROL(a,b,c) call ctrl_getheatflux(a,b,c) |
100 |
#define _GET_SFLUX_CONTROL(a,b,c) call ctrl_getsaltflux(a,b,c) |
101 |
#define _GET_USTRESS_CONTROL(a,b,c) call ctrl_getzonstress(a,b,c) |
102 |
#define _GET_VSTRESS_CONTROL(a,b,c) call ctrl_getmerstress(a,b,c) |
103 |
#define _GET_SWFLUX_CONTROL(a,b,c) |
104 |
#define _GET_LWFLUX_CONTROL(a,b,c) |
105 |
#else |
106 |
#define _GET_HFLUX_CONTROL(a,b,c) |
107 |
#define _GET_SFLUX_CONTROL(a,b,c) |
108 |
#define _GET_USTRESS_CONTROL(a,b,c) |
109 |
#define _GET_VSTRESS_CONTROL(a,b,c) |
110 |
#define _GET_SWFLUX_CONTROL(a,b,c) |
111 |
#define _GET_LWFLUX_CONTROL(a,b,c) |
112 |
#endif |
113 |
|
114 |
C >>> Initial values. |
115 |
#undef ALLOW_THETA0_CONTROL |
116 |
#undef ALLOW_SALT0_CONTROL |
117 |
|
118 |
C >>> Surface fluxes. |
119 |
#undef ALLOW_HFLUX_CONTROL |
120 |
#undef ALLOW_SFLUX_CONTROL |
121 |
#undef ALLOW_USTRESS_CONTROL |
122 |
#undef ALLOW_VSTRESS_CONTROL |
123 |
#undef ALLOW_SWFLUX_CONTROL |
124 |
#undef ALLOW_LWFLUX_CONTROL |
125 |
|
126 |
C >>> Atmospheric state. |
127 |
#undef ALLOW_ATEMP_CONTROL |
128 |
#undef ALLOW_AQH_CONTROL |
129 |
#undef ALLOW_UWIND_CONTROL |
130 |
#undef ALLOW_VWIND_CONTROL |
131 |
#undef ALLOW_PRECIP_CONTROL |
132 |
|
133 |
C ******************************************************************** |
134 |
C *** External forcing Package *** |
135 |
C ******************************************************************** |
136 |
C |
137 |
C o Include/exclude the external forcing package. To use this package, |
138 |
C you have to include the calendar tool as well. KPP can be switched |
139 |
C on or off. The implementation automatically takes care of this. |
140 |
#define ALLOW_EXF |
141 |
|
142 |
C Do more printout for the protocol file than usual. |
143 |
#define EXF_VERBOSE |
144 |
|
145 |
C Bulk formulae related flags. |
146 |
#undef ALLOW_BULKFORMULAE |
147 |
#undef ALLOW_ATM_TEMP |
148 |
#undef ALLOW_ATM_WIND |
149 |
|
150 |
C Relaxation to monthly climatologies. |
151 |
#undef ALLOW_CLIMTEMP_RELAXATION |
152 |
#undef ALLOW_CLIMSALT_RELAXATION |
153 |
#undef ALLOW_CLIMSST_RELAXATION |
154 |
#undef ALLOW_CLIMSSS_RELAXATION |
155 |
|
156 |
C Relaxation to constant surface fields. |
157 |
#undef ALLOW_CONST_SST_RELAXATION |
158 |
#undef ALLOW_CONST_SSS_RELAXATION |
159 |
|
160 |
|
161 |
#endif /* ALLOW_ECCO */ |
162 |
#endif /* ECCO_CPPOPTIONS_H */ |