/[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.8 by adcroft, Tue Dec 15 00:20:34 1998 UTC revision 1.19 by cnh, Fri Sep 21 03:54: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  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 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  C o Include/exclude code for C-D grid method of integrating the
40  C   coriolis terms  C   coriolis terms
41  #define  INCLUDE_CD_CODE  #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  C o Include/exclude diagnostics package interface code
47  #define  INCLUDE_DIAGNOSTICS_INTERFACE_CODE  #define  ALLOW_TIMEAVE
48    
49  C o Include/exclude latitude circle FFT filter  C o Include/exclude zonal FFT filter code
50  #undef  INCLUDE_LAT_CIRC_FFT_FILTER_CODE  #undef  ALLOW_ZONAL_FILT
51    
52  C o Include/exclude temperature advection code  C o Include/exclude temperature advection code
53  #define  INCLUDE_T_ADVECTION_CODE  #define  INCLUDE_T_ADVECTION_CODE
54  #ifdef   INCLUDE_T_ADVECTION_CODE  #ifdef   INCLUDE_T_ADVECTION_CODE
55  #define  _ADT(a) a  #define  _ADT(a)a
56  #endif  #endif
57  #ifndef  INCLUDE_T_ADVECTION_CODE  #ifndef  INCLUDE_T_ADVECTION_CODE
58  #define  _ADT(a)  #define  _ADT(a)
# Line 28  C o Include/exclude temperature advectio Line 61  C o Include/exclude temperature advectio
61  C o Include/exclude temperature diffusion code  C o Include/exclude temperature diffusion code
62  #define  INCLUDE_T_DIFFUSION_CODE  #define  INCLUDE_T_DIFFUSION_CODE
63  #ifdef   INCLUDE_T_DIFFUSION_CODE  #ifdef   INCLUDE_T_DIFFUSION_CODE
64  #define  _LPT(a) a  #define  _LPT(a)a
65  #define  _BHT(a) a  #define  _BHT(a)a
66  #endif  #endif
67  #ifndef  INCLUDE_T_DIFFUSION_CODE  #ifndef  INCLUDE_T_DIFFUSION_CODE
68  #define  _LPT(a)  #define  _LPT(a)
# Line 42  C o Include/exclude temperature forcing Line 75  C o Include/exclude temperature forcing
75  C o Include/exclude momentum advection code  C o Include/exclude momentum advection code
76  #define  INCLUDE_MOMENTUM_ADVECTION_CODE  #define  INCLUDE_MOMENTUM_ADVECTION_CODE
77  #ifdef   INCLUDE_MOMENTUM_ADVECTION_CODE  #ifdef   INCLUDE_MOMENTUM_ADVECTION_CODE
78  #define  _ADM(a) a  #define  _ADM(a)a
79  #endif  #endif
80  #ifndef  INCLUDE_MOMENTUM_ADVECTION_CODE  #ifndef  INCLUDE_MOMENTUM_ADVECTION_CODE
81  #define  _ADM(a)  #define  _ADM(a)
# Line 51  C o Include/exclude momentum advection c Line 84  C o Include/exclude momentum advection c
84  C o Include/exclude laplacian viscosity code  C o Include/exclude laplacian viscosity code
85  #define  INCLUDE_LP_MOMENTUM_DIFFUSION_CODE  #define  INCLUDE_LP_MOMENTUM_DIFFUSION_CODE
86  #ifdef   INCLUDE_LP_MOMENTUM_DIFFUSION_CODE  #ifdef   INCLUDE_LP_MOMENTUM_DIFFUSION_CODE
87  #define  _LPM(a) a  #define  _LPM(a)a
88  #endif  #endif
89  #ifndef  INCLUDE_LP_MOMENTUM_DIFFUSION_CODE  #ifndef  INCLUDE_LP_MOMENTUM_DIFFUSION_CODE
90  #define  _LPM(a)  #define  _LPM(a)
# Line 60  C o Include/exclude laplacian viscosity Line 93  C o Include/exclude laplacian viscosity
93  C o Include/exclude biharmonic viscosity code  C o Include/exclude biharmonic viscosity code
94  #define  INCLUDE_BH_MOMENTUM_DIFFUSION_CODE  #define  INCLUDE_BH_MOMENTUM_DIFFUSION_CODE
95  #ifdef   INCLUDE_BH_MOMENTUM_DIFFUSION_CODE  #ifdef   INCLUDE_BH_MOMENTUM_DIFFUSION_CODE
96  #define  _BHM(a) a  #define  _BHM(a)a
97  #endif  #endif
98  #ifndef  INCLUDE_BH_MOMENTUM_DIFFUSION_CODE  #ifndef  INCLUDE_BH_MOMENTUM_DIFFUSION_CODE
99  #define  _BHM(a)  #define  _BHM(a)
# Line 69  C o Include/exclude biharmonic viscosity Line 102  C o Include/exclude biharmonic viscosity
102  C o Include/exclude gradient of phy_hyd code  C o Include/exclude gradient of phy_hyd code
103  #define INCLUDE_GRADPH_CODE  #define INCLUDE_GRADPH_CODE
104  #ifdef  INCLUDE_GRADPH_CODE  #ifdef  INCLUDE_GRADPH_CODE
105  #define _PHM(a) a  #define _PHM(a)a
106  #endif  #endif
107  #ifndef INCLUDE_GRADPH_CODE  #ifndef INCLUDE_GRADPH_CODE
108  #define _PHM(a)  #define _PHM(a)
# Line 84  C o Include/exclude momentum eqn metric Line 117  C o Include/exclude momentum eqn metric
117  C o Include/exclude phi_hyd calculation code  C o Include/exclude phi_hyd calculation code
118  #define INCLUDE_PHIHYD_CALCULATION_CODE  #define INCLUDE_PHIHYD_CALCULATION_CODE
119    
 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  
   
120  C o Include/exclude call to S/R CONVECT  C o Include/exclude call to S/R CONVECT
121  #define INCLUDE_CONVECT_CALL  #define INCLUDE_CONVECT_CALL
122    
 C o Include/exclude call to S/R CALC_ISOSLOPES  
 #define INCLUDE_CALC_ISOSLOPES_CALL  
   
123  C o Include/exclude call to S/R CALC_DIFFUSIVITY  C o Include/exclude call to S/R CALC_DIFFUSIVITY
124  #define INCLUDE_CALC_DIFFUSIVITY_CALL  #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  C o Use "natural" boundary conditions for salinity
130  C   instead of the "virtual salt flux"  C   instead of the "virtual salt flux"
131  #undef USE_NATURAL_BCS  #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)  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  C   Note - only works with  #undef NO_SLIP_LATERAL  in calc_mom_rhs.F
# Line 128  C          because the old code did not Line 150  C          because the old code did not
150    
151  C o Execution environment support options  C o Execution environment support options
152  #include "CPP_EEOPTIONS.h"  #include "CPP_EEOPTIONS.h"
153    
154    C o Include/exclude code specific to the ECCO/SEALION version.
155    #undef INCLUDE_ECCO_PACKAGE
156    #ifdef INCLUDE_ECCO_PACKAGE
157    #include "ECCO_CPPOPTIONS.h"
158    #endif
159    
Legend:
Removed from v.1.8  
changed lines
  Added in v.1.19
  ViewVC Help
Powered by ViewVC 1.1.22