/[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.7 by adcroft, Mon Nov 30 23:45:24 1998 UTC revision 1.19.4.4 by dimitri, Thu May 1 06:10:19 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  CBOP
14    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  C CPP flags controlling which code in included in the files that
19  C will be compiled.  C will be compiled.
20  C  CEOP
21    
22    C o Include/exclude code for direct surface pressure solver
23    #undef  ALLOW_DIRECT_SOLVER
24    
25    C o Include/exclude code for AIM package
26    #undef  ALLOW_AIM
27    
28    C o Include/exclude code for GM/Redi parameterization
29    #undef  ALLOW_GMREDI
30    
31    C o Include/exclude code for KPP mixing scheme
32    #define  ALLOW_KPP
33    
34    C o Shortwave heating as extra term in external_forcing.F
35    #ifdef ALLOW_KPP
36    #define  SHORTWAVE_HEATING
37    #endif
38    
39    C o Include/exclude code for Shapiro filters
40    #define ALLOW_SHAP_FILT
41    
42  C o Include/exclude code for C-D grid method of integrating the  C o Include/exclude code for C-D grid method of integrating the
43  C   coriolis terms  C   coriolis terms
44  #define  INCLUDE_CD_CODE  #define  INCLUDE_CD_CODE
45    
46    C o Include/exclude code for open-boundary conditions
47    #undef  ALLOW_OBCS
48    
49  C o Include/exclude diagnostics package interface code  C o Include/exclude diagnostics package interface code
50  #define  INCLUDE_DIAGNOSTICS_INTERFACE_CODE  #define  ALLOW_TIMEAVE
51    
52  C o Include/exclude latitude circle FFT filter  C o Include/exclude zonal FFT filter code
53  #undef  INCLUDE_LAT_CIRC_FFT_FILTER_CODE  #undef  ALLOW_ZONAL_FILT
54    
55  C o Include/exclude temperature advection code  C o Include/exclude temperature advection code
56  #define  INCLUDE_T_ADVECTION_CODE  #define  INCLUDE_T_ADVECTION_CODE
57  #ifdef   INCLUDE_T_ADVECTION_CODE  #ifdef   INCLUDE_T_ADVECTION_CODE
58  #define  _ADT(a) a  #define  _ADT(a)a
59  #endif  #endif
60  #ifndef  INCLUDE_T_ADVECTION_CODE  #ifndef  INCLUDE_T_ADVECTION_CODE
61  #define  _ADT(a)  #define  _ADT(a)
# Line 28  C o Include/exclude temperature advectio Line 64  C o Include/exclude temperature advectio
64  C o Include/exclude temperature diffusion code  C o Include/exclude temperature diffusion code
65  #define  INCLUDE_T_DIFFUSION_CODE  #define  INCLUDE_T_DIFFUSION_CODE
66  #ifdef   INCLUDE_T_DIFFUSION_CODE  #ifdef   INCLUDE_T_DIFFUSION_CODE
67  #define  _LPT(a) a  #define  _LPT(a)a
68  #define  _BHT(a) a  #define  _BHT(a)a
69  #endif  #endif
70  #ifndef  INCLUDE_T_DIFFUSION_CODE  #ifndef  INCLUDE_T_DIFFUSION_CODE
71  #define  _LPT(a)  #define  _LPT(a)
# Line 42  C o Include/exclude temperature forcing Line 78  C o Include/exclude temperature forcing
78  C o Include/exclude momentum advection code  C o Include/exclude momentum advection code
79  #define  INCLUDE_MOMENTUM_ADVECTION_CODE  #define  INCLUDE_MOMENTUM_ADVECTION_CODE
80  #ifdef   INCLUDE_MOMENTUM_ADVECTION_CODE  #ifdef   INCLUDE_MOMENTUM_ADVECTION_CODE
81  #define  _ADM(a) a  #define  _ADM(a)a
82  #endif  #endif
83  #ifndef  INCLUDE_MOMENTUM_ADVECTION_CODE  #ifndef  INCLUDE_MOMENTUM_ADVECTION_CODE
84  #define  _ADM(a)  #define  _ADM(a)
# Line 51  C o Include/exclude momentum advection c Line 87  C o Include/exclude momentum advection c
87  C o Include/exclude laplacian viscosity code  C o Include/exclude laplacian viscosity code
88  #define  INCLUDE_LP_MOMENTUM_DIFFUSION_CODE  #define  INCLUDE_LP_MOMENTUM_DIFFUSION_CODE
89  #ifdef   INCLUDE_LP_MOMENTUM_DIFFUSION_CODE  #ifdef   INCLUDE_LP_MOMENTUM_DIFFUSION_CODE
90  #define  _LPM(a) a  #define  _LPM(a)a
91  #endif  #endif
92  #ifndef  INCLUDE_LP_MOMENTUM_DIFFUSION_CODE  #ifndef  INCLUDE_LP_MOMENTUM_DIFFUSION_CODE
93  #define  _LPM(a)  #define  _LPM(a)
# Line 60  C o Include/exclude laplacian viscosity Line 96  C o Include/exclude laplacian viscosity
96  C o Include/exclude biharmonic viscosity code  C o Include/exclude biharmonic viscosity code
97  #define  INCLUDE_BH_MOMENTUM_DIFFUSION_CODE  #define  INCLUDE_BH_MOMENTUM_DIFFUSION_CODE
98  #ifdef   INCLUDE_BH_MOMENTUM_DIFFUSION_CODE  #ifdef   INCLUDE_BH_MOMENTUM_DIFFUSION_CODE
99  #define  _BHM(a) a  #define  _BHM(a)a
100  #endif  #endif
101  #ifndef  INCLUDE_BH_MOMENTUM_DIFFUSION_CODE  #ifndef  INCLUDE_BH_MOMENTUM_DIFFUSION_CODE
102  #define  _BHM(a)  #define  _BHM(a)
# Line 69  C o Include/exclude biharmonic viscosity Line 105  C o Include/exclude biharmonic viscosity
105  C o Include/exclude gradient of phy_hyd code  C o Include/exclude gradient of phy_hyd code
106  #define INCLUDE_GRADPH_CODE  #define INCLUDE_GRADPH_CODE
107  #ifdef  INCLUDE_GRADPH_CODE  #ifdef  INCLUDE_GRADPH_CODE
108  #define _PHM(a) a  #define _PHM(a)a
109  #endif  #endif
110  #ifndef INCLUDE_GRADPH_CODE  #ifndef INCLUDE_GRADPH_CODE
111  #define _PHM(a)  #define _PHM(a)
# Line 84  C o Include/exclude momentum eqn metric Line 120  C o Include/exclude momentum eqn metric
120  C o Include/exclude phi_hyd calculation code  C o Include/exclude phi_hyd calculation code
121  #define INCLUDE_PHIHYD_CALCULATION_CODE  #define INCLUDE_PHIHYD_CALCULATION_CODE
122    
 C o Include/exclude prognostic variable shapiro filter code  
 C   Note - Shapiro filter of prognostics variables requires the  
 C          three steps "step forward including edges", filter,  
 C          "communicate edges".  
 C           If the filtering code is included then we do not use the  
 C          pipelined "step forward including edges" in S/R DYNAMICS.  
 C          Instead the three steps are performed before DYNAMICS one  
 C          after another in an un-pipelined fashion.  
 #undef  INCLUDE_SHAPIRO_FILTER_CODE  
 #ifdef  INCLUDE_SHAPIRO_FILTER_CODE  
 #undef  DO_PIPELINED_CORRECTION_STEP  
 #endif  
 #ifndef INCLUDE_SHAPIRO_FILTER_CODE  
 #define DO_PIPELINED_CORRECTION_STEP  
 #endif  
   
 C o Include/exclude call to S/R FIND_RHO  
 #define INCLUDE_FIND_RHO_CALL  
   
123  C o Include/exclude call to S/R CONVECT  C o Include/exclude call to S/R CONVECT
124  #define INCLUDE_CONVECT_CALL  #define INCLUDE_CONVECT_CALL
125    
 C o Include/exclude call to S/R CALC_ISOSLOPES  
 #define INCLUDE_CALC_ISOSLOPES_CALL  
   
126  C o Include/exclude call to S/R CALC_DIFFUSIVITY  C o Include/exclude call to S/R CALC_DIFFUSIVITY
127  #define INCLUDE_CALC_DIFFUSIVITY_CALL  #define INCLUDE_CALC_DIFFUSIVITY_CALL
128    
129    C o Allow nonHydrostatic code
130    #undef  ALLOW_NONHYDROSTATIC
131    
132    C o Use "natural" boundary conditions for salinity
133    C   instead of the "virtual salt flux"
134    #undef  USE_NATURAL_BCS
135    
136    C o Use "Exact Convervation" of fluid in Free-Surface formulation
137    C   so that d/dt(eta) is exactly equal to - Div.Transport
138    #undef EXACT_CONSERV
139    
140    C o Allow the use of Non-Linear Free-Surface formulation
141    C   this implies that surface thickness (hFactors) vary with time
142    #undef NONLIN_FRSURF
143    
144  C o Use "OLD" UV discretisation near boundaries (*not* recommended)  C o Use "OLD" UV discretisation near boundaries (*not* recommended)
145  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
146  C          because the old code did not have no-slip BCs  C          because the old code did not have no-slip BCs
# Line 122  C   Note - only works with  #undef NO_SL Line 151  C   Note - only works with  #undef NO_SL
151  C          because the old code did not have no-slip BCs  C          because the old code did not have no-slip BCs
152  #undef  OLD_UV_GEOMETRY  #undef  OLD_UV_GEOMETRY
153    
154    C o Include/exclude IERS Special Bureau for the Oceans diagnostics
155    #undef  ALLOW_SBO
156    
157    C o Include/exclude code for sea-ice model
158    #undef  ALLOW_SEAICE
159    
160  C o Execution environment support options  C o Execution environment support options
161  #include "CPP_EEOPTIONS.h"  #include "CPP_EEOPTIONS.h"
162    
163    C o Include/exclude code specific to the ECCO/SEALION version.
164    #undef INCLUDE_ECCO_PACKAGE
165    #ifdef INCLUDE_ECCO_PACKAGE
166    #include "ECCO_CPPOPTIONS.h"
167    #endif
Legend:
Removed from v.1.7  
changed lines
  Added in v.1.19.4.4
  ViewVC Help
Powered by ViewVC 1.1.22