/[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.15 by jmc, Tue Feb 20 14:44:37 2001 UTC revision 1.37 by dimitri, Tue Jan 9 23:27:43 2007 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  C CPP flags controlling particular source code features
 #undef  ALLOW_AIM  
   
 C o Include/exclude code for GM/Redi parameterization  
 #undef  ALLOW_GMREDI  
   
 C o Include/exclude code for KPP mixing scheme  
 #define  ALLOW_KPP  
8    
9  C o Shortwave heating as extra term in external_forcing.F  C o Shortwave heating as extra term in external_forcing.F
10  #ifdef ALLOW_KPP  C Note: this should be a run-time option
11  #define  SHORTWAVE_HEATING  #undef 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  INCLUDE_DIAGNOSTICS_INTERFACE_CODE  
   
 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  
   
 C o Include/exclude momentum eqn metric terms code  
 #define INCLUDE_MOMENTUM_METRIC_TERM_CODE  
12    
13  C o Include/exclude phi_hyd calculation code  C o Include/exclude phi_hyd calculation code
14  #define INCLUDE_PHIHYD_CALCULATION_CODE  #define INCLUDE_PHIHYD_CALCULATION_CODE
# Line 111  C o Include/exclude call to S/R CONVECT Line 19  C o Include/exclude call to S/R CONVECT
19  C o Include/exclude call to S/R CALC_DIFFUSIVITY  C o Include/exclude call to S/R CALC_DIFFUSIVITY
20  #define INCLUDE_CALC_DIFFUSIVITY_CALL  #define INCLUDE_CALC_DIFFUSIVITY_CALL
21    
22  C o Allow nonHydrostatic code  C o Include/exclude Implicit vertical advection code
23  #undef  ALLOW_NONHYDROSTATIC  #define INCLUDE_IMPLVERTADV_CODE
24    
25    C o Include/exclude AdamsBashforth-3rd-Order code
26    #undef ALLOW_ADAMSBASHFORTH_3
27    
28  C o Use "natural" boundary conditions for salinity  C o Include/exclude nonHydrostatic code
29  C   instead of the "virtual salt flux"  #undef ALLOW_NONHYDROSTATIC
30  #undef  USE_NATURAL_BCS  
31    C o Include pressure loading code
32    #define ATMOSPHERIC_LOADING
33    
34    C o Use "Exact Convervation" of fluid in Free-Surface formulation
35    C   so that d/dt(eta) is exactly equal to - Div.Transport
36    #define EXACT_CONSERV
37    
38    C o Allow the use of Non-Linear Free-Surface formulation
39    C   this implies that surface thickness (hFactors) vary with time
40    #undef NONLIN_FRSURF
41    
42    C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when
43    C   using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi))
44    C *only for use on a lat-lon grid*
45    C   Setting this flag here affects both momentum and tracer equation unless
46    C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
47    C   The definition of the flag is commented to avoid interference with
48    C   such other header files.
49    C   The preferred method is specifying a value for viscAhGrid or viscA4Grid
50    C   in data which is then automatically scaled by the grid size;
51    C   the old method of specifying viscAh/viscA4 and this flag is provided
52    C   for completeness only (and for use with the adjoint).
53    C#define ISOTROPIC_COS_SCALING
54    
55    C o This flag selects the form of COSINE(lat) scaling of bi-harmonic term.
56    C *only for use on a lat-lon grid*
57    C   Has no effect if ISOTROPIC_COS_SCALING is undefined.
58    C   Has no effect on vector invariant momentum equations.
59    C   Setting this flag here affects both momentum and tracer equation unless
60    C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
61    C   The definition of the flag is commented to avoid interference with
62    C   such other header files.
63    C#define COSINEMETH_III
64    
65  C o Use "OLD" UV discretisation near boundaries (*not* recommended)  C o Use "OLD" UV discretisation near boundaries (*not* recommended)
66  C   Note - only works with  #undef NO_SLIP_LATERAL  in calc_mom_rhs.F  C   Note - only works with  #undef NO_SLIP_LATERAL  in calc_mom_rhs.F
67  C          because the old code did not have no-slip BCs  C          because the old code did not have no-slip BCs
68  #undef  OLD_ADV_BCS  #undef  OLD_ADV_BCS
69    
70  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
71  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
72  C          because the old code did not have no-slip BCs  C   is still useful with, e.g., single-domain curvilinear configurations.
73  #undef  OLD_UV_GEOMETRY  #undef OLD_GRID_IO
74    
75  C o Execution environment support options  C o Execution environment support options
76  #include "CPP_EEOPTIONS.h"  #include "CPP_EEOPTIONS.h"
77    
78  C o Include/exclude code specific to the ECCO/SEALION version.  C o Include/exclude code specific to the ECCO/SEALION version.
79  #undef INCLUDE_ECCO_PACKAGE  C   AUTODIFF or EXF package.
80  #ifdef INCLUDE_ECCO_PACKAGE  C   Currently controled by a single header file
81  #include "ECCO_CPPOPTIONS.h"  C   For this to work, PACKAGES_CONFIG.h needs to be included!
82  #endif  cph#if (defined (ALLOW_AUTODIFF) || \
83    cph     defined (ALLOW_ECCO) || \
84    cph     defined (ALLOW_EXF))
85    cph# include "ECCO_CPPOPTIONS.h"
86    cph#endif
87    
88    #endif /* CPP_OPTIONS_H */
89    
Legend:
Removed from v.1.15  
changed lines
  Added in v.1.37
  ViewVC Help
Powered by ViewVC 1.1.22