/[MITgcm]/MITgcm/verification/natl_box/code/CPP_OPTIONS.h
ViewVC logotype

Diff of /MITgcm/verification/natl_box/code/CPP_OPTIONS.h

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

revision 1.4.2.1 by jmc, Fri Apr 6 15:19:00 2001 UTC revision 1.12 by jmc, Mon Aug 11 18:27:43 2014 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2  C $Name$  C $Name$
 C  
3    
4  C  #ifndef CPP_OPTIONS_H
5  C CPP flags controlling which code in included in the files that  #define CPP_OPTIONS_H
 C will be compiled.  
 C  
6    
7  C o Include/exclude code for AIM package  CBOP
8  #undef  ALLOW_AIM  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 code for GM/Redi parameterization  C CPP flags controlling particular source code features
 #undef  ALLOW_GMREDI  
   
 C o Include/exclude code for KPP mixing scheme  
 #define  ALLOW_KPP  
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  #ifdef ALLOW_KPP  C Note: this should be a run-time option
23  #define  SHORTWAVE_HEATING  #define SHORTWAVE_HEATING
 #endif  
   
 C o Include/exclude code for Shapiro filters  
 #define ALLOW_SHAP_FILT  
   
 C o Include/exclude code for C-D grid method of integrating the  
 C   coriolis terms  
 #define  INCLUDE_CD_CODE  
   
 C o Include/exclude code for open-boundary conditions  
 #undef   ALLOW_OBCS  
   
 C o Include/exclude diagnostics package interface code  
 #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  
   
 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  #define 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 111  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 nonHydrostatic code  C o Allow full 3D specification of vertical diffusivity
38  #undef  ALLOW_NONHYDROSTATIC  #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 AdamsBashforth-3rd-Order code
47    #undef ALLOW_ADAMSBASHFORTH_3
48    
49    C o Include/exclude nonHydrostatic code
50    #undef ALLOW_NONHYDROSTATIC
51    
52    C o Allow to account for heating due to friction (and momentum dissipation)
53    #undef ALLOW_FRICTION_HEATING
54    
55    C o Allow mass source or sink of Fluid in the interior
56    C   (3-D generalisation of oceanic real-fresh water flux)
57    #undef ALLOW_ADDFLUID
58    
59  C o Use "natural" boundary conditions for salinity  C o Include pressure loading code
60  C   instead of the "virtual salt flux"  #define ATMOSPHERIC_LOADING
61  #undef  USE_NATURAL_BCS  
62    C o exclude/allow external forcing-fields load
63    C   this allows to read & do simple linear time interpolation of oceanic
64    C   forcing fields, if no specific pkg (e.g., EXF) is used to compute them.
65    #undef EXCLUDE_FFIELDS_LOAD
66    
67    C o Include/exclude balancing surface forcing fluxes code
68    #undef ALLOW_BALANCE_FLUXES
69    
70    C o Include/exclude balancing surface forcing relaxation code
71    #undef ALLOW_BALANCE_RELAX
72    
73    C o Include/exclude GM-like eddy stress in momentum code
74    #undef ALLOW_EDDYPSI
75    
76  C o Use "Exact Convervation" of fluid in Free-Surface formulation  C o Use "Exact Convervation" of fluid in Free-Surface formulation
77  C   so that d/dt(eta) is exactly equal to - Div.Transport  C   so that d/dt(eta) is exactly equal to - Div.Transport
# Line 126  C o Allow the use of Non-Linear Free-Sur Line 81  C o Allow the use of Non-Linear Free-Sur
81  C   this implies that surface thickness (hFactors) vary with time  C   this implies that surface thickness (hFactors) vary with time
82  #undef NONLIN_FRSURF  #undef NONLIN_FRSURF
83    
84    C o Include/exclude code for single reduction Conjugate-Gradient solver
85    #define ALLOW_SRCG
86    
87    C o Choices for implicit solver routines solve_*diagonal.F
88    C   The following has low memory footprint, but not suitable for AD
89    #undef SOLVE_DIAGONAL_LOWMEMORY
90    C   The following one suitable for AD but does not vectorize
91    #undef SOLVE_DIAGONAL_KINNER
92    
93    C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when
94    C   using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi))
95    C *only for use on a lat-lon grid*
96    C   Setting this flag here affects both momentum and tracer equation unless
97    C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
98    C   The definition of the flag is commented to avoid interference with
99    C   such other header files.
100    C   The preferred method is specifying a value for viscAhGrid or viscA4Grid
101    C   in data which is then automatically scaled by the grid size;
102    C   the old method of specifying viscAh/viscA4 and this flag is provided
103    C   for completeness only (and for use with the adjoint).
104    C#define ISOTROPIC_COS_SCALING
105    
106    C o This flag selects the form of COSINE(lat) scaling of bi-harmonic term.
107    C *only for use on a lat-lon grid*
108    C   Has no effect if ISOTROPIC_COS_SCALING is undefined.
109    C   Has no effect on vector invariant momentum equations.
110    C   Setting this flag here affects both momentum and tracer equation unless
111    C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
112    C   The definition of the flag is commented to avoid interference with
113    C   such other header files.
114    C#define COSINEMETH_III
115    
116  C o Use "OLD" UV discretisation near boundaries (*not* recommended)  C o Use "OLD" UV discretisation near boundaries (*not* recommended)
117  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."
118  C          because the old code did not have no-slip BCs  C          because the old code did not have no-slip BCs
119  #undef  OLD_ADV_BCS  #undef OLD_ADV_BCS
120    
121  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
122  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
123  C          because the old code did not have no-slip BCs  C   is still useful with, e.g., single-domain curvilinear configurations.
124  #undef  OLD_UV_GEOMETRY  #undef OLD_GRID_IO
125    
126    C o Use old EXTERNAL_FORCING_U,V,T,S subroutines (for backward compatibility)
127    #undef USE_OLD_EXTERNAL_FORCING
128    
129  C o Execution environment support options  C o Execution environment support options
130  #include "CPP_EEOPTIONS.h"  #include "CPP_EEOPTIONS.h"
131    
132  C o Include/exclude code specific to the ECCO/SEALION version.  C o Include/exclude single header file containing multiple packages options
133  #undef INCLUDE_ECCO_PACKAGE  C   (AUTODIFF, COST, CTRL, ECCO, EXF ...) instead of the standard way where
134  #ifdef INCLUDE_ECCO_PACKAGE  C   each of the above pkg get its own options from its specific option file.
135  #include "ECCO_CPPOPTIONS.h"  C   Although this method, inherited from ECCO setup, has been traditionally
136  #endif  C   used for all adjoint built, work is in progress to allow to use the
137    C   standard method also for adjoint built.
138    c#ifdef PACKAGES_CONFIG_H
139    c# include "ECCO_CPPOPTIONS.h"
140    c#endif
141    
142    #endif /* CPP_OPTIONS_H */
Legend:
Removed from v.1.4.2.1  
changed lines
  Added in v.1.12
  ViewVC Help
Powered by ViewVC 1.1.22