/[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.27 by edhill, Tue Oct 28 22:57:59 2003 UTC revision 1.54 by jmc, Mon Nov 28 22:55:00 2016 UTC
# Line 4  C $Name$ Line 4  C $Name$
4  #ifndef CPP_OPTIONS_H  #ifndef CPP_OPTIONS_H
5  #define CPP_OPTIONS_H  #define CPP_OPTIONS_H
6    
7  C CPP flags controlling particular source code features  CBOP
8    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 o Include/exclude temperature forcing code  C CPP flags controlling particular source code features
 C#define  INCLUDE_T_FORCING_CODE  
20    
21  C o Shortwave heating as extra term in external_forcing.F  C o Shortwave heating as extra term in external_forcing.F
22  C Note: this should be a run-time option and not necessarily dependent on KPP  C Note: this should be a run-time option
23  #ifdef ALLOW_KPP  #undef SHORTWAVE_HEATING
 #define  SHORTWAVE_HEATING  
 #endif  
   
 C o Include/exclude momentum forcing code  
 #define INCLUDE_MOMENTUM_FORCING_CODE  
24    
25  C o Include/exclude momentum eqn metric terms code  C o Include/exclude Geothermal Heat Flux at the bottom of the ocean
26  #define INCLUDE_MOMENTUM_METRIC_TERM_CODE  #undef ALLOW_GEOTHERMAL_FLUX
27    
28  C o Include/exclude phi_hyd calculation code  C o Include/exclude phi_hyd calculation code
29  #define INCLUDE_PHIHYD_CALCULATION_CODE  #define INCLUDE_PHIHYD_CALCULATION_CODE
# Line 30  C o Include/exclude call to S/R CONVECT Line 34  C o Include/exclude call to S/R CONVECT
34  C o Include/exclude call to S/R CALC_DIFFUSIVITY  C o Include/exclude call to S/R CALC_DIFFUSIVITY
35  #define INCLUDE_CALC_DIFFUSIVITY_CALL  #define INCLUDE_CALC_DIFFUSIVITY_CALL
36    
37    C o Allow full 3D specification of vertical diffusivity
38    #undef ALLOW_3D_DIFFKR
39    
40    C o Allow latitudinally varying BryanLewis79 vertical diffusivity
41    #undef ALLOW_BL79_LAT_VARY
42    
43    C o Include/exclude Implicit vertical advection code
44    #define INCLUDE_IMPLVERTADV_CODE
45    
46    C o Include/exclude combined Surf.Pressure and Drag Implicit solver code
47    #undef ALLOW_SOLVE4_PS_AND_DRAG
48    
49    C o Include/exclude AdamsBashforth-3rd-Order code
50    #undef ALLOW_ADAMSBASHFORTH_3
51    
52  C o Include/exclude nonHydrostatic code  C o Include/exclude nonHydrostatic code
53  #undef ALLOW_NONHYDROSTATIC  #undef ALLOW_NONHYDROSTATIC
54    
55    C o Allow to account for heating due to friction (and momentum dissipation)
56    #undef ALLOW_FRICTION_HEATING
57    
58    C o Allow mass source or sink of Fluid in the interior
59    C   (3-D generalisation of oceanic real-fresh water flux)
60    #undef ALLOW_ADDFLUID
61    
62  C o Include pressure loading code  C o Include pressure loading code
63  #define ATMOSPHERIC_LOADING  #define ATMOSPHERIC_LOADING
64    
65    C o exclude/allow external forcing-fields load
66    C   this allows to read & do simple linear time interpolation of oceanic
67    C   forcing fields, if no specific pkg (e.g., EXF) is used to compute them.
68    #undef EXCLUDE_FFIELDS_LOAD
69    
70    C o Include/exclude balancing surface forcing fluxes code
71    #undef ALLOW_BALANCE_FLUXES
72    
73    C o Include/exclude balancing surface forcing relaxation code
74    #undef ALLOW_BALANCE_RELAX
75    
76    C o Include/exclude GM-like eddy stress in momentum code
77    #undef ALLOW_EDDYPSI
78    
79  C o Use "Exact Convervation" of fluid in Free-Surface formulation  C o Use "Exact Convervation" of fluid in Free-Surface formulation
80  C   so that d/dt(eta) is exactly equal to - Div.Transport  C   so that d/dt(eta) is exactly equal to - Div.Transport
81  #define EXACT_CONSERV  #define EXACT_CONSERV
# Line 44  C o Allow the use of Non-Linear Free-Sur Line 84  C o Allow the use of Non-Linear Free-Sur
84  C   this implies that surface thickness (hFactors) vary with time  C   this implies that surface thickness (hFactors) vary with time
85  #undef NONLIN_FRSURF  #undef NONLIN_FRSURF
86    
87    C o Include/exclude code for single reduction Conjugate-Gradient solver
88    #define ALLOW_SRCG
89    
90    C o Choices for implicit solver routines solve_*diagonal.F
91    C   The following has low memory footprint, but not suitable for AD
92    #undef SOLVE_DIAGONAL_LOWMEMORY
93    C   The following one suitable for AD but does not vectorize
94    #undef SOLVE_DIAGONAL_KINNER
95    
96    C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when
97    C   using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi))
98    C *only for use on a lat-lon grid*
99    C   Setting this flag here affects both momentum and tracer equation unless
100    C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
101    C   The definition of the flag is commented to avoid interference with
102    C   such other header files.
103    C   The preferred method is specifying a value for viscAhGrid or viscA4Grid
104    C   in data which is then automatically scaled by the grid size;
105    C   the old method of specifying viscAh/viscA4 and this flag is provided
106    C   for completeness only (and for use with the adjoint).
107    C#define ISOTROPIC_COS_SCALING
108    
109    C o This flag selects the form of COSINE(lat) scaling of bi-harmonic term.
110    C *only for use on a lat-lon grid*
111    C   Has no effect if ISOTROPIC_COS_SCALING is undefined.
112    C   Has no effect on vector invariant momentum equations.
113    C   Setting this flag here affects both momentum and tracer equation unless
114    C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
115    C   The definition of the flag is commented to avoid interference with
116    C   such other header files.
117    C#define COSINEMETH_III
118    
119  C o Use "OLD" UV discretisation near boundaries (*not* recommended)  C o Use "OLD" UV discretisation near boundaries (*not* recommended)
120  C   Note - only works with  #undef NO_SLIP_LATERAL  in calc_mom_rhs.F  C   Note - only works with pkg/mom_fluxform and "no_slip_sides=.FALSE."
121  C          because the old code did not have no-slip BCs  C          because the old code did not have no-slip BCs
122  #undef  OLD_ADV_BCS  #undef OLD_ADV_BCS
123    
124  C o Use "OLD" UV geometry on sphere (definately *NOT* recommended)  C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F
125  C   Note - only works with  #undef NO_SLIP_LATERAL  in calc_mom_rhs.F  C   Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO
126  C          because the old code did not have no-slip BCs  C   is still useful with, e.g., single-domain curvilinear configurations.
127  #undef  OLD_UV_GEOMETRY  #undef OLD_GRID_IO
128    
129    C o Use old EXTERNAL_FORCING_U,V,T,S subroutines (for backward compatibility)
130    #undef USE_OLD_EXTERNAL_FORCING
131    
132  C o Execution environment support options  C o Execution environment support options
133  #include "CPP_EEOPTIONS.h"  #include "CPP_EEOPTIONS.h"
134    
135  C o Include/exclude code specific to the ECCO/SEALION version.  C o Include/exclude single header file containing multiple packages options
136  #undef INCLUDE_ECCO_PACKAGE  C   (AUTODIFF, COST, CTRL, ECCO, EXF ...) instead of the standard way where
137  #ifdef INCLUDE_ECCO_PACKAGE  C   each of the above pkg get its own options from its specific option file.
138  #include "ECCO_CPPOPTIONS.h"  C   Although this method, inherited from ECCO setup, has been traditionally
139  #endif  C   used for all adjoint built, work is in progress to allow to use the
140    C   standard method also for adjoint built.
141    c#ifdef PACKAGES_CONFIG_H
142    c# include "ECCO_CPPOPTIONS.h"
143    c#endif
144    
145  #endif /* CPP_OPTIONS_H */  #endif /* CPP_OPTIONS_H */
   
Legend:
Removed from v.1.27  
changed lines
  Added in v.1.54
  ViewVC Help
Powered by ViewVC 1.1.22