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

Legend:
Removed from v.1.5  
changed lines
  Added in v.1.18

  ViewVC Help
Powered by ViewVC 1.1.22