/[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.19.4.3 by dimitri, Fri Jan 31 05:06:50 2003 UTC revision 1.55 by jmc, Thu Nov 2 17:43:26 2017 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2  C $Name$  C $Name$
3    
4    These lines are here to deliberately cause a compile-time error.  #ifndef CPP_OPTIONS_H
5    If you see these lines in your .F files or the compiler shows them  #define CPP_OPTIONS_H
   as an error then it means you have not placed your configuration  
   files in the appropriate place.  
   You need to place you own copy of CPP_OPTIONS.h in the include  
   path for the model.  
   
 C  
6    
7  CBOP  CBOP
8  C !ROUTINE: CPP_OPTIONS.h  C !ROUTINE: CPP_OPTIONS.h
9  C !INTERFACE:  C !INTERFACE:
10  C include "CPP_OPTIONS.h"  C #include "CPP_OPTIONS.h"
11    
12  C !DESCRIPTION:  C !DESCRIPTION:
13  C CPP flags controlling which code in included in the files that  C *==================================================================*
14  C will be compiled.  C | main CPP options file for the model:
15    C | Control which optional features to compile in model/src code.
16    C *==================================================================*
17  CEOP  CEOP
18    
19  C o Include/exclude code for AIM package  C CPP flags controlling particular source code features
 #undef  ALLOW_AIM  
20    
21  C o Include/exclude code for GM/Redi parameterization  C-- Forcing code options:
 #undef  ALLOW_GMREDI  
   
 C o Include/exclude code for KPP mixing scheme  
 #define  ALLOW_KPP  
22    
23  C o Shortwave heating as extra term in external_forcing.F  C o Shortwave heating as extra term in external_forcing.F
24  #ifdef ALLOW_KPP  C Note: this should be a run-time option
25  #define  SHORTWAVE_HEATING  #undef SHORTWAVE_HEATING
26  #endif  
27    C o Include/exclude Geothermal Heat Flux at the bottom of the ocean
28  C o Include/exclude code for Shapiro filters  #undef ALLOW_GEOTHERMAL_FLUX
29  #define ALLOW_SHAP_FILT  
30    C o Allow to account for heating due to friction (and momentum dissipation)
31  C o Include/exclude code for C-D grid method of integrating the  #undef ALLOW_FRICTION_HEATING
32  C   coriolis terms  
33  #define  INCLUDE_CD_CODE  C o Allow mass source or sink of Fluid in the interior
34    C   (3-D generalisation of oceanic real-fresh water flux)
35  C o Include/exclude code for open-boundary conditions  #undef ALLOW_ADDFLUID
36  #undef  ALLOW_OBCS  
37    C o Include pressure loading code
38  C o Include/exclude diagnostics package interface code  #define ATMOSPHERIC_LOADING
 #define  ALLOW_TIMEAVE  
   
 C o Include/exclude zonal FFT filter code  
 #undef  ALLOW_ZONAL_FILT  
   
 C o Include/exclude temperature advection code  
 #define  INCLUDE_T_ADVECTION_CODE  
 #ifdef   INCLUDE_T_ADVECTION_CODE  
 #define  _ADT(a)a  
 #endif  
 #ifndef  INCLUDE_T_ADVECTION_CODE  
 #define  _ADT(a)  
 #endif  
   
 C o Include/exclude temperature diffusion code  
 #define  INCLUDE_T_DIFFUSION_CODE  
 #ifdef   INCLUDE_T_DIFFUSION_CODE  
 #define  _LPT(a)a  
 #define  _BHT(a)a  
 #endif  
 #ifndef  INCLUDE_T_DIFFUSION_CODE  
 #define  _LPT(a)  
 #define  _BHT(a)  
 #endif  
   
 C o Include/exclude temperature forcing code  
 #define  INCLUDE_T_FORCING_CODE  
   
 C o Include/exclude momentum advection code  
 #define  INCLUDE_MOMENTUM_ADVECTION_CODE  
 #ifdef   INCLUDE_MOMENTUM_ADVECTION_CODE  
 #define  _ADM(a)a  
 #endif  
 #ifndef  INCLUDE_MOMENTUM_ADVECTION_CODE  
 #define  _ADM(a)  
 #endif  
   
 C o Include/exclude laplacian viscosity code  
 #define  INCLUDE_LP_MOMENTUM_DIFFUSION_CODE  
 #ifdef   INCLUDE_LP_MOMENTUM_DIFFUSION_CODE  
 #define  _LPM(a)a  
 #endif  
 #ifndef  INCLUDE_LP_MOMENTUM_DIFFUSION_CODE  
 #define  _LPM(a)  
 #endif  
   
 C o Include/exclude biharmonic viscosity code  
 #define  INCLUDE_BH_MOMENTUM_DIFFUSION_CODE  
 #ifdef   INCLUDE_BH_MOMENTUM_DIFFUSION_CODE  
 #define  _BHM(a)a  
 #endif  
 #ifndef  INCLUDE_BH_MOMENTUM_DIFFUSION_CODE  
 #define  _BHM(a)  
 #endif  
   
 C o Include/exclude gradient of phy_hyd code  
 #define INCLUDE_GRADPH_CODE  
 #ifdef  INCLUDE_GRADPH_CODE  
 #define _PHM(a)a  
 #endif  
 #ifndef INCLUDE_GRADPH_CODE  
 #define _PHM(a)  
 #endif  
39    
40  C o Include/exclude momentum forcing code  C o Include/exclude balancing surface forcing fluxes code
41  #define INCLUDE_MOMENTUM_FORCING_CODE  #undef ALLOW_BALANCE_FLUXES
42    
43  C o Include/exclude momentum eqn metric terms code  C o Include/exclude balancing surface forcing relaxation code
44  #define INCLUDE_MOMENTUM_METRIC_TERM_CODE  #undef ALLOW_BALANCE_RELAX
45    
46    C o Include/exclude checking for negative salinity
47    #undef CHECK_SALINITY_FOR_NEGATIVE_VALUES
48    
49    C-- Options to discard parts of the main code:
50    
51    C o Exclude/allow external forcing-fields load
52    C   this allows to read & do simple linear time interpolation of oceanic
53    C   forcing fields, if no specific pkg (e.g., EXF) is used to compute them.
54    #undef EXCLUDE_FFIELDS_LOAD
55    
56  C o Include/exclude phi_hyd calculation code  C o Include/exclude phi_hyd calculation code
57  #define INCLUDE_PHIHYD_CALCULATION_CODE  #define INCLUDE_PHIHYD_CALCULATION_CODE
58    
59    C-- Vertical mixing code options:
60    
61  C o Include/exclude call to S/R CONVECT  C o Include/exclude call to S/R CONVECT
62  #define INCLUDE_CONVECT_CALL  #define INCLUDE_CONVECT_CALL
63    
64  C o Include/exclude call to S/R CALC_DIFFUSIVITY  C o Include/exclude call to S/R CALC_DIFFUSIVITY
65  #define INCLUDE_CALC_DIFFUSIVITY_CALL  #define INCLUDE_CALC_DIFFUSIVITY_CALL
66    
67  C o Allow nonHydrostatic code  C o Allow full 3D specification of vertical diffusivity
68  #undef  ALLOW_NONHYDROSTATIC  #undef ALLOW_3D_DIFFKR
69    
70    C o Allow latitudinally varying BryanLewis79 vertical diffusivity
71    #undef ALLOW_BL79_LAT_VARY
72    
73    C o Exclude/allow partial-cell effect (physical or enhanced) in vertical mixing
74    C   this allows to account for partial-cell in vertical viscosity and diffusion,
75    C   either from grid-spacing reduction effect or as artificially enhanced mixing
76    C   near surface & bottom for too thin grid-cell
77    #undef EXCLUDE_PCELL_MIX_CODE
78    
79  C o Use "natural" boundary conditions for salinity  C-- Time-stepping code options:
80  C   instead of the "virtual salt flux"  
81  #undef  USE_NATURAL_BCS  C o Include/exclude combined Surf.Pressure and Drag Implicit solver code
82    #undef ALLOW_SOLVE4_PS_AND_DRAG
83  C o Use "Exact Convervation" of fluid in Free-Surface formulation  
84  C   so that d/dt(eta) is exactly equal to - Div.Transport  C o Include/exclude Implicit vertical advection code
85  #undef EXACT_CONSERV  #define INCLUDE_IMPLVERTADV_CODE
86    
87    C o Include/exclude AdamsBashforth-3rd-Order code
88    #undef ALLOW_ADAMSBASHFORTH_3
89    
90    C-- Model formulation options:
91    
92    C o Allow/exclude "Exact Convervation" of fluid in Free-Surface formulation
93    C   that ensures that d/dt(eta) is exactly equal to - Div.Transport
94    #define EXACT_CONSERV
95    
96  C o Allow the use of Non-Linear Free-Surface formulation  C o Allow the use of Non-Linear Free-Surface formulation
97  C   this implies that surface thickness (hFactors) vary with time  C   this implies that grid-cell thickness (hFactors) varies with time
98  #undef NONLIN_FRSURF  #undef NONLIN_FRSURF
99    
100    C o Include/exclude nonHydrostatic code
101    #undef ALLOW_NONHYDROSTATIC
102    
103    C o Include/exclude GM-like eddy stress in momentum code
104    #undef ALLOW_EDDYPSI
105    
106    C-- Algorithm options:
107    
108    C o Use Non Self-Adjoint (NSA) conjugate-gradient solver
109    #undef ALLOW_CG2D_NSA
110    
111    C o Include/exclude code for single reduction Conjugate-Gradient solver
112    #define ALLOW_SRCG
113    
114    C o Choices for implicit solver routines solve_*diagonal.F
115    C   The following has low memory footprint, but not suitable for AD
116    #undef SOLVE_DIAGONAL_LOWMEMORY
117    C   The following one suitable for AD but does not vectorize
118    #undef SOLVE_DIAGONAL_KINNER
119    
120    C-- Retired code options:
121    
122    C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when
123    C   using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi))
124    C *only for use on a lat-lon grid*
125    C   Setting this flag here affects both momentum and tracer equation unless
126    C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
127    C   The definition of the flag is commented to avoid interference with
128    C   such other header files.
129    C   The preferred method is specifying a value for viscAhGrid or viscA4Grid
130    C   in data which is then automatically scaled by the grid size;
131    C   the old method of specifying viscAh/viscA4 and this flag is provided
132    C   for completeness only (and for use with the adjoint).
133    C#define ISOTROPIC_COS_SCALING
134    
135    C o This flag selects the form of COSINE(lat) scaling of bi-harmonic term.
136    C *only for use on a lat-lon grid*
137    C   Has no effect if ISOTROPIC_COS_SCALING is undefined.
138    C   Has no effect on vector invariant momentum equations.
139    C   Setting this flag here affects both momentum and tracer equation unless
140    C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
141    C   The definition of the flag is commented to avoid interference with
142    C   such other header files.
143    C#define COSINEMETH_III
144    
145  C o Use "OLD" UV discretisation near boundaries (*not* recommended)  C o Use "OLD" UV discretisation near boundaries (*not* recommended)
146  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."
147  C          because the old code did not have no-slip BCs  C          because the old code did not have no-slip BCs
148  #undef  OLD_ADV_BCS  #undef OLD_ADV_BCS
149    
150  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
151  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
152  C          because the old code did not have no-slip BCs  C   is still useful with, e.g., single-domain curvilinear configurations.
153  #undef  OLD_UV_GEOMETRY  #undef OLD_GRID_IO
154    
155    C o Use thsice+seaice (old) call sequence: ice-Dyn,ice-Advect,ice-Thermo(thsice)
156    C              as opposed to new sequence: ice-Thermo(thsice),ice-Dyn,ice-Advect
157    #undef OLD_THSICE_CALL_SEQUENCE
158    
159  C o Include/exclude IERS Special Bureau for the Oceans diagnostics  C o Use old EXTERNAL_FORCING_U,V,T,S subroutines (for backward compatibility)
160  #undef  ALLOW_SBO  #undef USE_OLD_EXTERNAL_FORCING
161    
162  C o Include/exclude code for sea-ice model  C-- Other option files:
 #undef  ALLOW_SEAICE  
163    
164  C o Execution environment support options  C o Execution environment support options
165  #include "CPP_EEOPTIONS.h"  #include "CPP_EEOPTIONS.h"
166    
167  C o Include/exclude code specific to the ECCO/SEALION version.  C o Include/exclude single header file containing multiple packages options
168  #undef INCLUDE_ECCO_PACKAGE  C   (AUTODIFF, COST, CTRL, ECCO, EXF ...) instead of the standard way where
169  #ifdef INCLUDE_ECCO_PACKAGE  C   each of the above pkg get its own options from its specific option file.
170  #include "ECCO_CPPOPTIONS.h"  C   Although this method, inherited from ECCO setup, has been traditionally
171  #endif  C   used for all adjoint built, work is in progress to allow to use the
172    C   standard method also for adjoint built.
173    c#ifdef PACKAGES_CONFIG_H
174    c# include "ECCO_CPPOPTIONS.h"
175    c#endif
176    
177    #endif /* CPP_OPTIONS_H */
Legend:
Removed from v.1.19.4.3  
changed lines
  Added in v.1.55
  ViewVC Help
Powered by ViewVC 1.1.22