/[MITgcm]/MITgcm/model/inc/CPP_OPTIONS.h
ViewVC logotype

Diff of /MITgcm/model/inc/CPP_OPTIONS.h

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

revision 1.5 by adcroft, Wed Jul 1 19:49:36 1998 UTC revision 1.50 by jmc, Tue Aug 14 02:58:00 2012 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2  C  C $Name$
3    
4  C This enables the C-D grid method of integrating the Coriolis terms  #ifndef CPP_OPTIONS_H
5  #define ALLOW_CD  #define CPP_OPTIONS_H
6    
7  C This enables use of the diagnostics packages  CBOP
8  #define ALLOW_DIAGNOSTICS  C !ROUTINE: CPP_OPTIONS.h
9    C !INTERFACE:
10    C #include "CPP_OPTIONS.h"
11    
12    C !DESCRIPTION:
13    C *==================================================================*
14    C | main CPP options file for the model:
15    C | Control which optional features to compile in model/src code.
16    C *==================================================================*
17    CEOP
18    
19    C CPP flags controlling particular source code features
20    
21    C o Shortwave heating as extra term in external_forcing.F
22    C Note: this should be a run-time option
23    #undef SHORTWAVE_HEATING
24    
25    C o Include/exclude phi_hyd calculation code
26    #define INCLUDE_PHIHYD_CALCULATION_CODE
27    
28    C o Include/exclude call to S/R CONVECT
29    #define INCLUDE_CONVECT_CALL
30    
31    C o Include/exclude call to S/R CALC_DIFFUSIVITY
32    #define INCLUDE_CALC_DIFFUSIVITY_CALL
33    
34    C o Allow full 3D specification of vertical diffusivity
35    #undef ALLOW_3D_DIFFKR
36    
37    C o Allow latitudinally varying BryanLewis79 vertical diffusivity
38    #undef ALLOW_BL79_LAT_VARY
39    
40    C o Include/exclude Implicit vertical advection code
41    #define INCLUDE_IMPLVERTADV_CODE
42    
43    C o Include/exclude AdamsBashforth-3rd-Order code
44    #undef ALLOW_ADAMSBASHFORTH_3
45    
46    C o Include/exclude nonHydrostatic code
47    #undef ALLOW_NONHYDROSTATIC
48    
49    C o Allow mass source or sink of Fluid in the interior
50    C   (3-D generalisation of oceanic real-fresh water flux)
51    #undef ALLOW_ADDFLUID
52    
53    C o Include pressure loading code
54    #define ATMOSPHERIC_LOADING
55    
56    C o exclude/allow external forcing-fields load
57    C   this allows to read & do simple linear time interpolation of oceanic
58    C   forcing fields, if no specific pkg (e.g., EXF) is used to compute them.
59    #undef EXCLUDE_FFIELDS_LOAD
60    
61    C o Include/exclude balancing surface forcing fluxes code
62    #undef ALLOW_BALANCE_FLUXES
63    
64    C o Include/exclude balancing surface forcing relaxation code
65    #undef ALLOW_BALANCE_RELAX
66    
67    C o Include/exclude GM-like eddy stress in momentum code
68    #undef ALLOW_EDDYPSI
69    
70    C o Use "Exact Convervation" of fluid in Free-Surface formulation
71    C   so that d/dt(eta) is exactly equal to - Div.Transport
72    #define EXACT_CONSERV
73    
74    C o Allow the use of Non-Linear Free-Surface formulation
75    C   this implies that surface thickness (hFactors) vary with time
76    #undef NONLIN_FRSURF
77    
78    C o Include/exclude code for single reduction Conjugate-Gradient solver
79    #define ALLOW_SRCG
80    
81    C o Choices for implicit solver routines solve_*diagonal.F
82    C   The following has low memory footprint, but not suitable for AD
83    #undef SOLVE_DIAGONAL_LOWMEMORY
84    C   The following one suitable for AD but does not vectorize
85    #undef SOLVE_DIAGONAL_KINNER
86    
87    C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when
88    C   using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi))
89    C *only for use on a lat-lon grid*
90    C   Setting this flag here affects both momentum and tracer equation unless
91    C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
92    C   The definition of the flag is commented to avoid interference with
93    C   such other header files.
94    C   The preferred method is specifying a value for viscAhGrid or viscA4Grid
95    C   in data which is then automatically scaled by the grid size;
96    C   the old method of specifying viscAh/viscA4 and this flag is provided
97    C   for completeness only (and for use with the adjoint).
98    C#define ISOTROPIC_COS_SCALING
99    
100    C o This flag selects the form of COSINE(lat) scaling of bi-harmonic term.
101    C *only for use on a lat-lon grid*
102    C   Has no effect if ISOTROPIC_COS_SCALING is undefined.
103    C   Has no effect on vector invariant momentum equations.
104    C   Setting this flag here affects both momentum and tracer equation unless
105    C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
106    C   The definition of the flag is commented to avoid interference with
107    C   such other header files.
108    C#define COSINEMETH_III
109    
110    C o Use "OLD" UV discretisation near boundaries (*not* recommended)
111    C   Note - only works with  #undef NO_SLIP_LATERAL  in calc_mom_rhs.F
112    C          because the old code did not have no-slip BCs
113    #undef  OLD_ADV_BCS
114    
115    C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F
116    C   Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO
117    C   is still useful with, e.g., single-domain curvilinear configurations.
118    #undef OLD_GRID_IO
119    
120    C o Execution environment support options
121  #include "CPP_EEOPTIONS.h"  #include "CPP_EEOPTIONS.h"
122    
123    C o Include/exclude single header file containing multiple packages options
124    C   (AUTODIFF, COST, CTRL, ECCO, EXF ...) instead of the standard way where
125    C   each of the above pkg get its own options from its specific option file.
126    C   Although this method, inherited from ECCO setup, has been traditionally
127    C   used for all adjoint built, work is in progress to allow to use the
128    C   standard method also for adjoint built.
129    c#ifdef PACKAGES_CONFIG_H
130    c# include "ECCO_CPPOPTIONS.h"
131    c#endif
132    
133    #endif /* CPP_OPTIONS_H */

Legend:
Removed from v.1.5  
changed lines
  Added in v.1.50

  ViewVC Help
Powered by ViewVC 1.1.22