/[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.3 by adcroft, Tue Jun 9 15:58:35 1998 UTC revision 1.44 by mlosch, Mon Nov 23 16:13:57 2009 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2  C  C $Name$
3    
4  #undef ALLOW_CD  #ifndef CPP_OPTIONS_H
5    #define CPP_OPTIONS_H
6    
7    C CPP flags controlling particular source code features
8    
9    C o Shortwave heating as extra term in external_forcing.F
10    C Note: this should be a run-time option
11    #undef SHORTWAVE_HEATING
12    
13    C o Include/exclude phi_hyd calculation code
14    #define INCLUDE_PHIHYD_CALCULATION_CODE
15    
16    C o Include/exclude call to S/R CONVECT
17    #define INCLUDE_CONVECT_CALL
18    
19    C o Include/exclude call to S/R CALC_DIFFUSIVITY
20    #define INCLUDE_CALC_DIFFUSIVITY_CALL
21    
22    C o Allow latitudinally varying BryanLewis79 vertical diffusivity
23    #undef ALLOW_BL79_LAT_VARY
24    
25    C o Include/exclude Implicit vertical advection code
26    #define INCLUDE_IMPLVERTADV_CODE
27    
28    C o Include/exclude AdamsBashforth-3rd-Order code
29    #undef ALLOW_ADAMSBASHFORTH_3
30    
31    C o Include/exclude code for single reduction cg-solver
32    #undef ALLOW_SRCG
33    
34    C o Include/exclude nonHydrostatic code
35    #undef ALLOW_NONHYDROSTATIC
36    
37    C o Include pressure loading code
38    #define ATMOSPHERIC_LOADING
39    
40    C o exclude/allow external forcing-fields load
41    C   this allows to read & do simple linear time interpolation of oceanic
42    C   forcing fields, if no specific pkg (e.g., EXF) is used to compute them.
43    #undef EXCLUDE_FFIELDS_LOAD
44    
45    C o Include/exclude GM-like eddy stress in momentum code
46    #undef ALLOW_EDDYPSI
47    
48    C o Use "Exact Convervation" of fluid in Free-Surface formulation
49    C   so that d/dt(eta) is exactly equal to - Div.Transport
50    #define EXACT_CONSERV
51    
52    C o Allow the use of Non-Linear Free-Surface formulation
53    C   this implies that surface thickness (hFactors) vary with time
54    #undef NONLIN_FRSURF
55    
56    C o Allow mass source or sink of Fluid in the interior
57    C   (3-D generalisation of oceanic real-fresh water flux)
58    #undef ALLOW_ADDFLUID
59    
60    C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when
61    C   using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi))
62    C *only for use on a lat-lon grid*
63    C   Setting this flag here affects both momentum and tracer equation unless
64    C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
65    C   The definition of the flag is commented to avoid interference with
66    C   such other header files.
67    C   The preferred method is specifying a value for viscAhGrid or viscA4Grid
68    C   in data which is then automatically scaled by the grid size;
69    C   the old method of specifying viscAh/viscA4 and this flag is provided
70    C   for completeness only (and for use with the adjoint).
71    C#define ISOTROPIC_COS_SCALING
72    
73    C o This flag selects the form of COSINE(lat) scaling of bi-harmonic term.
74    C *only for use on a lat-lon grid*
75    C   Has no effect if ISOTROPIC_COS_SCALING is undefined.
76    C   Has no effect on vector invariant momentum equations.
77    C   Setting this flag here affects both momentum and tracer equation unless
78    C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
79    C   The definition of the flag is commented to avoid interference with
80    C   such other header files.
81    C#define COSINEMETH_III
82    
83    C o Use "OLD" UV discretisation near boundaries (*not* recommended)
84    C   Note - only works with  #undef NO_SLIP_LATERAL  in calc_mom_rhs.F
85    C          because the old code did not have no-slip BCs
86    #undef  OLD_ADV_BCS
87    
88    C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F
89    C   Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO
90    C   is still useful with, e.g., single-domain curvilinear configurations.
91    #undef OLD_GRID_IO
92    
93    C o Execution environment support options
94  #include "CPP_EEOPTIONS.h"  #include "CPP_EEOPTIONS.h"
95    
96    C o Include/exclude code specific to the ECCO/SEALION version.
97    C   AUTODIFF or EXF package.
98    C   Currently controled by a single header file
99    C   For this to work, PACKAGES_CONFIG.h needs to be included!
100    cph#if (defined (ALLOW_AUTODIFF) || \
101    cph     defined (ALLOW_ECCO) || \
102    cph     defined (ALLOW_EXF))
103    cph# include "ECCO_CPPOPTIONS.h"
104    cph#endif
105    
106    C o Allow full 3D specification of vertical diffusivity
107    #ifdef ALLOW_DIFFKR_CONTROL
108    C - Need to be defined if using DIFFKR_CONTROL
109    C   (alternatively, could have put this in ECCO_CPPOPTIONS)
110    #define ALLOW_3D_DIFFKR
111    #else
112    C - otherwise, can be turned on or off hereafter:
113    #undef  ALLOW_3D_DIFFKR
114    #endif /* ALLOW_DIFFKR_CONTROL */
115    
116    #endif /* CPP_OPTIONS_H */
117    

Legend:
Removed from v.1.3  
changed lines
  Added in v.1.44

  ViewVC Help
Powered by ViewVC 1.1.22