/[MITgcm]/MITgcm_contrib/LCML/cpl_aim+ocn/aim/CPP_OPTIONS.xml
ViewVC logotype

Annotation of /MITgcm_contrib/LCML/cpl_aim+ocn/aim/CPP_OPTIONS.xml

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.1 - (hide annotations) (download) (as text)
Sun Oct 21 18:16:08 2007 UTC (17 years, 9 months ago) by ce107
Branch: MAIN
CVS Tags: HEAD
File MIME type: text/xml
AIM pkg checkin tested on batsi.mit.edu

1 ce107 1.1 <!-- $Header: $ -->
2     <!-- $Name: $ -->
3    
4    
5    
6     <description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
7     xsi:noNamespaceSchemaLocation="http://deslab.mit.edu/LCML/lcml.xsd"
8     xmlns:dc="http://purl.org/dc/elements/1.1/">
9    
10     <descriptionName>Atmosphere Model options</descriptionName>
11    
12     <descriptionInfo>Use to create the CPP_OPTIONS.h file that is used when building MITgcm.</descriptionInfo>
13    
14     <descriptionMetadata>
15     <dc:creator>Constantinos Evangelinos</dc:creator>
16     <dc:date>2006-06-06</dc:date>
17     </descriptionMetadata>
18    
19     <descriptionTarget>
20     <file>CPP_OPTIONS.h</file>
21     </descriptionTarget>
22    
23     <descriptionContent>
24     <startText>
25    
26     #ifndef _CPP_OPTIONS_H_
27     #define _CPP_OPTIONS_H_
28    
29     #include "PACKAGES_CONFIG.h"
30     &#x000A;</startText>
31     <separator>&#x000A;</separator>
32     <endText>
33    
34     C o Execution environment support options
35     #include "CPP_EEOPTIONS.h"
36    
37     C o Include/exclude code specific to the ECCO/SEALION version.
38     C AUTODIFF or EXF package.
39     C Currently controled by a single header file
40     C For this to work, PACKAGES_CONFIG.h needs to be included!
41     #if (defined (ALLOW_AUTODIFF) || \
42     defined (ALLOW_ECCO) || \
43     defined (ALLOW_EXF))
44     # include "ECCO_CPPOPTIONS.h"
45    
46     #endif
47    
48     #endif /* CPP_OPTIONS_H */&#x000A;</endText>
49     <set>
50     <setName>CPP_OPTIONS Includes</setName>
51     <setInfo>Compile Time includes.</setInfo>
52     <separator>&#x000A;</separator>
53     <var>
54     <name>Adjoint setup</name>
55     <info>Include the adjoint package options</info>
56     <type>string</type>
57     <use>false</use>
58     <hidden>false</hidden>
59     <value>#include "AD_CONFIG.h"</value>
60     <uneditable>value</uneditable>
61     </var>
62     </set>
63     <set>
64     <setName>CPP_OPTIONS Parameters</setName>
65     <setInfo>Compile Time model parameters.</setInfo>
66     <separator>&#x000A;</separator>
67     <var>
68     <name>SHORTWAVE_HEATING</name>
69     <info>Shortwave heating as extra term in external_forcing.F</info>
70     <type>string</type>
71     <use>true</use>
72     <hidden>false</hidden>
73     <enumeration>#undef;#define</enumeration>
74     <header>#ifdef ALLOW_KPP&#x000A;</header>
75     <value>#undef</value>
76     <trailer> SHORTWAVE_HEATING
77     #endif
78     </trailer>
79     </var>
80     <var>
81     <name>ALLOW_SALT_PLUME</name>
82     <info>Include/exclude Duffy et al. (GRL 1999) salt plume scheme</info>
83     <type>string</type>
84     <use>false</use>
85     <hidden>false</hidden>
86     <enumeration>#undef;#define</enumeration>
87     <value>#undef</value>
88     <trailer> ALLOW_SALT_PLUME</trailer>
89     </var>
90     <var>
91     <name>INCLUDE_PHIHYD_CALCULATION_CODE</name>
92     <info>Include/exclude phi_hyd calculation code</info>
93     <type>string</type>
94     <use>true</use>
95     <hidden>false</hidden>
96     <enumeration>#undef;#define</enumeration>
97     <value>#define</value>
98     <trailer> INCLUDE_PHIHYD_CALCULATION_CODE</trailer>
99     </var>
100     <var>
101     <name>INCLUDE_CONVECT_CALL</name>
102     <info>Include/exclude call to S/R CONVECT</info>
103     <type>string</type>
104     <use>true</use>
105     <hidden>false</hidden>
106     <enumeration>#undef;#define</enumeration>
107     <value>#define</value>
108     <trailer> INCLUDE_CONVECT_CALL</trailer>
109     </var>
110     <var>
111     <name>INCLUDE_CALC_DIFFUSIVITY_CALL</name>
112     <info>Include/exclude call to S/R CALC_DIFFUSIVITY</info>
113     <type>string</type>
114     <use>true</use>
115     <hidden>false</hidden>
116     <enumeration>#undef;#define</enumeration>
117     <value>#define</value>
118     <trailer> INCLUDE_CALC_DIFFUSIVITY_CALL</trailer>
119     </var>
120     <var>
121     <name>ALLOW_BL79_LAT_VARY</name>
122     <info>Allow latitudinally varying BryanLewis79 vertical diffusivity</info>
123     <type>string</type>
124     <use>false</use>
125     <hidden>false</hidden>
126     <enumeration>#undef;#define</enumeration>
127     <value>#undef</value>
128     <trailer> ALLOW_BL79_LAT_VARY</trailer>
129     </var>
130     <var>
131     <name>ALLOW_3D_DIFFKR</name>
132     <info>Allow full 3D specification of vertical diffusivity</info>
133     <type>string</type>
134     <use>false</use>
135     <hidden>false</hidden>
136     <enumeration>#undef;#define</enumeration>
137     <value>#undef</value>
138     <trailer> ALLOW_3D_DIFFKR</trailer>
139     </var>
140     <var>
141     <name>INCLUDE_IMPLVERTADV_CODE</name>
142     <info>Include/exclude Implicit vertical advection code</info>
143     <type>string</type>
144     <use>true</use>
145     <hidden>false</hidden>
146     <enumeration>#undef;#define</enumeration>
147     <value>#define</value>
148     <trailer> INCLUDE_IMPLVERTADV_CODE</trailer>
149     </var>
150     <var>
151     <name>ALLOW_ADAMSBASHFORTH_3</name>
152     <info>Include/exclude AdamsBashforth-3rd-Order code</info>
153     <type>string</type>
154     <use>false</use>
155     <hidden>false</hidden>
156     <enumeration>#undef;#define</enumeration>
157     <value>#undef</value>
158     <trailer> ALLOW_ADAMSBASHFORTH_3</trailer>
159     </var>
160     <var>
161     <name>ALLOW_NONHYDROSTATIC</name>
162     <info>Include/exclude nonHydrostatic code</info>
163     <type>string</type>
164     <use>true</use>
165     <hidden>false</hidden>
166     <enumeration>#undef;#define</enumeration>
167     <value>#undef</value>
168     <trailer> ALLOW_NONHYDROSTATIC</trailer>
169     </var>
170     <var>
171     <name>ATMOSPHERIC_LOADING</name>
172     <info>Include pressure loading code</info>
173     <type>string</type>
174     <use>true</use>
175     <hidden>false</hidden>
176     <enumeration>#undef;#define</enumeration>
177     <value>#define</value>
178     <trailer> ATMOSPHERIC_LOADING</trailer>
179     </var>
180     <var>
181     <name>EXCLUDE_FFIELDS_LOAD</name>
182     <info>Exclude/allow external forcing-fields load. This allows to read and do simple linear time interpolation of oceanic forcing fields, if no specific pkg (e.g., EXF) is used to compute them.</info>
183     <type>string</type>
184     <use>false</use>
185     <hidden>false</hidden>
186     <enumeration>#undef;#define</enumeration>
187     <value>#undef</value>
188     <trailer> EXCLUDE_FFIELDS_LOAD</trailer>
189     </var>
190     <var>
191     <name>EXACT_CONSERV</name>
192     <info>Use "Exact Convervation" of fluid in Free-Surface formulation so that d/dt(eta) is exactly equal to - Div.Transport</info>
193     <type>string</type>
194     <use>true</use>
195     <hidden>false</hidden>
196     <enumeration>#undef;#define</enumeration>
197     <value>#define</value>
198     <trailer> EXACT_CONSERV</trailer>
199     </var>
200     <var>
201     <name>NONLIN_FRSURF</name>
202     <info>Allow the use of Non-Linear Free-Surface formulation: this implies that surface thickness (hFactors) vary with time</info>
203     <type>string</type>
204     <use>true</use>
205     <hidden>false</hidden>
206     <enumeration>#undef;#define</enumeration>
207     <value>#define</value>
208     <trailer> NONLIN_FRSURF</trailer>
209     </var>
210     <var>
211     <name>OLD_ADV_BCS</name>
212     <info>Use "OLD" UV discretisation near boundaries (*not* recommended). Note - only works with #undef NO_SLIP_LATERAL in calc_mom_rhs.F because the old code did not have no-slip BCs</info>
213     <type>string</type>
214     <use>true</use>
215     <hidden>false</hidden>
216     <enumeration>#undef;#define</enumeration>
217     <value>#undef</value>
218     <trailer> OLD_ADV_BCS</trailer>
219     </var>
220     <var>
221     <name>OLD_GRID_IO</name>
222     <info>Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F. Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO is still useful with, e.g., single-domain curvilinear configurations.</info>
223     <type>string</type>
224     <use>false</use>
225     <hidden>false</hidden>
226     <enumeration>#undef;#define</enumeration>
227     <value>#undef</value>
228     <trailer> OLD_GRID_IO</trailer>
229     </var>
230     <var>
231     <name>MINIMAL_TAVE_OUTPUT</name>
232     <info>Minimal time-averaged output: S, T, U, V, W, ETA, and phiHydLow</info>
233     <type>string</type>
234     <use>false</use>
235     <hidden>false</hidden>
236     <enumeration>#undef;#define</enumeration>
237     <value>#undef</value>
238     <trailer> MINIMAL_TAVE_OUTPUT</trailer>
239     </var>
240     <var>
241     <name>OLD_STYLE_WITH_MANY_FILES</name>
242     <info>Read/write of checkpoint files for restarting.</info>
243     <type>string</type>
244     <use>false</use>
245     <hidden>false</hidden>
246     <enumeration>#undef;#define</enumeration>
247     <value>#undef</value>
248     <trailer> OLD_STYLE_WITH_MANY_FILES</trailer>
249     </var>
250     <var>
251     <name>USE_NATURAL_BCS</name>
252     <info>Use "natural" boundary conditions for salinity instead of the "virtual salt flux"</info>
253     <type>string</type>
254     <use>false</use>
255     <hidden>false</hidden>
256     <enumeration>#undef;#define</enumeration>
257     <value>#undef</value>
258     <trailer> USE_NATURAL_BCS</trailer>
259     </var>
260     <var>
261     <name>ALLOW_PASSIVE_TRACER</name>
262     <info>Add passive tracer advection routines</info>
263     <type>string</type>
264     <use>false</use>
265     <hidden>false</hidden>
266     <enumeration>#undef;#define</enumeration>
267     <value>#undef</value>
268     <trailer> ALLOW_PASSIVE_TRACER</trailer>
269     </var>
270     <var>
271     <name>ALLOW_TAU_EDDY</name>
272     <info>Add eddy stress to momentum eqn.</info>
273     <type>string</type>
274     <use>false</use>
275     <hidden>false</hidden>
276     <enumeration>#undef;#define</enumeration>
277     <value>#undef</value>
278     <trailer> ALLOW_TAU_EDDY</trailer>
279     </var>
280     <var>
281     <name>DISABLE_RSTAR_CODE</name>
282     <info>Disable rStar (z*) code</info>
283     <type>string</type>
284     <use>false</use>
285     <hidden>false</hidden>
286     <enumeration>#undef;#define</enumeration>
287     <value>#undef</value>
288     <trailer> DISABLE_RSTAR_CODE</trailer>
289     </var>
290     <var>
291     <name>INCLUDE_CALC_ISOSLOPES_CALL</name>
292     <info>Include/exclude call to S/R CALC_ISOSLOPES</info>
293     <type>string</type>
294     <use>false</use>
295     <hidden>false</hidden>
296     <enumeration>#undef;#define</enumeration>
297     <value>#undef</value>
298     <trailer> INCLUDE_CALC_ISOSLOPES_CALL</trailer>
299     </var>
300     <var>
301     <name>INCLUDE_FIND_RHO_CALL</name>
302     <info>Include/exclude call to S/R FIND_RHO</info>
303     <type>string</type>
304     <use>false</use>
305     <hidden>false</hidden>
306     <enumeration>#undef;#define</enumeration>
307     <value>#undef</value>
308     <trailer> INCLUDE_FIND_RHO_CALL</trailer>
309     </var>
310     <var>
311     <name>SINGLE_LAYER_MODE</name>
312     <info>Run as shallow water model</info>
313     <type>string</type>
314     <use>false</use>
315     <hidden>false</hidden>
316     <enumeration>#undef;#define</enumeration>
317     <value>#undef</value>
318     <trailer> SINGLE_LAYER_MODE</trailer>
319     </var>
320     </set>
321     </descriptionContent>
322     </description>

  ViewVC Help
Powered by ViewVC 1.1.22