/[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.5 by adcroft, Wed Jul 1 19:49:36 1998 UTC revision 1.19.6.1 by dimitri, Thu Feb 13 19:28:37 2003 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2    C $Name$
3    
4      These lines are here to deliberately cause a compile-time error.
5      If you see these lines in your .F files or the compiler shows them
6      as an error then it means you have not placed your configuration
7      files in the appropriate place.
8      You need to place you own copy of CPP_OPTIONS.h in the include
9      path for the model.
10    
11  C  C
12    
13  C This enables the C-D grid method of integrating the Coriolis terms  CBOP
14  #define ALLOW_CD  C !ROUTINE: CPP_OPTIONS.h
15    C !INTERFACE:
16    C include "CPP_OPTIONS.h"
17    C !DESCRIPTION:
18    C CPP flags controlling which code in included in the files that
19    C will be compiled.
20    CEOP
21    
22    C o Include/exclude code for AIM package
23    #undef  ALLOW_AIM
24    
25    C o Include/exclude code for GM/Redi parameterization
26    #undef  ALLOW_GMREDI
27    
28    C o Include/exclude code for KPP mixing scheme
29    #define  ALLOW_KPP
30    
31    C o Shortwave heating as extra term in external_forcing.F
32    #ifdef ALLOW_KPP
33    #define  SHORTWAVE_HEATING
34    #endif
35    
36    C o Include/exclude code for Shapiro filters
37    #define ALLOW_SHAP_FILT
38    
39    C o Include/exclude code for C-D grid method of integrating the
40    C   coriolis terms
41    #define  INCLUDE_CD_CODE
42    
43    C o Include/exclude code for open-boundary conditions
44    #undef  ALLOW_OBCS
45    
46    C o Include/exclude diagnostics package interface code
47    #define  ALLOW_TIMEAVE
48    
49    C o Include/exclude zonal FFT filter code
50    #undef  ALLOW_ZONAL_FILT
51    
52    C o Include/exclude temperature advection code
53    #define  INCLUDE_T_ADVECTION_CODE
54    #ifdef   INCLUDE_T_ADVECTION_CODE
55    #define  _ADT(a)a
56    #endif
57    #ifndef  INCLUDE_T_ADVECTION_CODE
58    #define  _ADT(a)
59    #endif
60    
61    C o Include/exclude temperature diffusion code
62    #define  INCLUDE_T_DIFFUSION_CODE
63    #ifdef   INCLUDE_T_DIFFUSION_CODE
64    #define  _LPT(a)a
65    #define  _BHT(a)a
66    #endif
67    #ifndef  INCLUDE_T_DIFFUSION_CODE
68    #define  _LPT(a)
69    #define  _BHT(a)
70    #endif
71    
72    C o Include/exclude temperature forcing code
73    #define  INCLUDE_T_FORCING_CODE
74    
75    C o Include/exclude momentum advection code
76    #define  INCLUDE_MOMENTUM_ADVECTION_CODE
77    #ifdef   INCLUDE_MOMENTUM_ADVECTION_CODE
78    #define  _ADM(a)a
79    #endif
80    #ifndef  INCLUDE_MOMENTUM_ADVECTION_CODE
81    #define  _ADM(a)
82    #endif
83    
84  C This enables use of the diagnostics packages  C o Include/exclude laplacian viscosity code
85  #define ALLOW_DIAGNOSTICS  #define  INCLUDE_LP_MOMENTUM_DIFFUSION_CODE
86    #ifdef   INCLUDE_LP_MOMENTUM_DIFFUSION_CODE
87    #define  _LPM(a)a
88    #endif
89    #ifndef  INCLUDE_LP_MOMENTUM_DIFFUSION_CODE
90    #define  _LPM(a)
91    #endif
92    
93    C o Include/exclude biharmonic viscosity code
94    #define  INCLUDE_BH_MOMENTUM_DIFFUSION_CODE
95    #ifdef   INCLUDE_BH_MOMENTUM_DIFFUSION_CODE
96    #define  _BHM(a)a
97    #endif
98    #ifndef  INCLUDE_BH_MOMENTUM_DIFFUSION_CODE
99    #define  _BHM(a)
100    #endif
101    
102    C o Include/exclude gradient of phy_hyd code
103    #define INCLUDE_GRADPH_CODE
104    #ifdef  INCLUDE_GRADPH_CODE
105    #define _PHM(a)a
106    #endif
107    #ifndef INCLUDE_GRADPH_CODE
108    #define _PHM(a)
109    #endif
110    
111    C o Include/exclude momentum forcing code
112    #define INCLUDE_MOMENTUM_FORCING_CODE
113    
114    C o Include/exclude momentum eqn metric terms code
115    #define INCLUDE_MOMENTUM_METRIC_TERM_CODE
116    
117    C o Include/exclude phi_hyd calculation code
118    #define INCLUDE_PHIHYD_CALCULATION_CODE
119    
120    C o Include/exclude call to S/R CONVECT
121    #define INCLUDE_CONVECT_CALL
122    
123    C o Include/exclude call to S/R CALC_DIFFUSIVITY
124    #define INCLUDE_CALC_DIFFUSIVITY_CALL
125    
126    C o Allow nonHydrostatic code
127    #undef  ALLOW_NONHYDROSTATIC
128    
129    C o Use "natural" boundary conditions for salinity
130    C   instead of the "virtual salt flux"
131    #undef  USE_NATURAL_BCS
132    
133    C o Use "Exact Convervation" of fluid in Free-Surface formulation
134    C   so that d/dt(eta) is exactly equal to - Div.Transport
135    #undef EXACT_CONSERV
136    
137    C o Allow the use of Non-Linear Free-Surface formulation
138    C   this implies that surface thickness (hFactors) vary with time
139    #undef NONLIN_FRSURF
140    
141    C o Use "OLD" UV discretisation near boundaries (*not* recommended)
142    C   Note - only works with  #undef NO_SLIP_LATERAL  in calc_mom_rhs.F
143    C          because the old code did not have no-slip BCs
144    #undef  OLD_ADV_BCS
145    
146    C o Use "OLD" UV geometry on sphere (definately *NOT* recommended)
147    C   Note - only works with  #undef NO_SLIP_LATERAL  in calc_mom_rhs.F
148    C          because the old code did not have no-slip BCs
149    #undef  OLD_UV_GEOMETRY
150    
151    C o Include/exclude code for sea-ice model
152    #undef  ALLOW_SEAICE
153    
154    C o Execution environment support options
155  #include "CPP_EEOPTIONS.h"  #include "CPP_EEOPTIONS.h"
156    
157    C o Include/exclude code specific to the ECCO/SEALION version.
158    #undef INCLUDE_ECCO_PACKAGE
159    #ifdef INCLUDE_ECCO_PACKAGE
160    #include "ECCO_CPPOPTIONS.h"
161    #endif
Legend:
Removed from v.1.5  
changed lines
  Added in v.1.19.6.1
  ViewVC Help
Powered by ViewVC 1.1.22