/[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.22 by dimitri, Tue Feb 18 05:33:53 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 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    cswdblk --- add ---
32    C o Include/exclude code for bulk formula
33    #define  ALLOW_BULK_FORCE
34    #ifdef ALLOW_BULK_FORCE
35    cswdice -- add ---
36    C o allow seaice
37    #define ALLOW_THERM_SEAICE
38    cswdice -- end add ---
39    
40    C o try to conserve qnet and emp
41    #define CONSERV_BULKF
42    #endif
43    cswdblk -- end add ---
44    
45    
46    C o Shortwave heating as extra term in external_forcing.F
47    #ifdef ALLOW_KPP
48    #define  SHORTWAVE_HEATING
49    #endif
50    
51    C o Include/exclude code for Shapiro filters
52    #define ALLOW_SHAP_FILT
53    
54  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
55  C   coriolis terms  C   coriolis terms
56  #define  INCLUDE_CD_CODE  #define  INCLUDE_CD_CODE
57    
58    C o Include/exclude code for open-boundary conditions
59    #undef  ALLOW_OBCS
60    
61  C o Include/exclude diagnostics package interface code  C o Include/exclude diagnostics package interface code
62  #define  INCLUDE_DIAGNOSTICS_INTERFACE_CODE  #define  ALLOW_TIMEAVE
63    
64  C o Include/exclude latitude circle FFT filter  C o Include/exclude zonal FFT filter code
65  #undef  INCLUDE_LAT_CIRC_FFT_FILTER_CODE  #undef  ALLOW_ZONAL_FILT
66    
67  C o Include/exclude temperature advection code  C o Include/exclude temperature advection code
68  #define  INCLUDE_T_ADVECTION_CODE  #define  INCLUDE_T_ADVECTION_CODE
69  #ifdef   INCLUDE_T_ADVECTION_CODE  #ifdef   INCLUDE_T_ADVECTION_CODE
70  #define  _ADT(a) a  #define  _ADT(a)a
71  #endif  #endif
72  #ifndef  INCLUDE_T_ADVECTION_CODE  #ifndef  INCLUDE_T_ADVECTION_CODE
73  #define  _ADT(a)  #define  _ADT(a)
# Line 28  C o Include/exclude temperature advectio Line 76  C o Include/exclude temperature advectio
76  C o Include/exclude temperature diffusion code  C o Include/exclude temperature diffusion code
77  #define  INCLUDE_T_DIFFUSION_CODE  #define  INCLUDE_T_DIFFUSION_CODE
78  #ifdef   INCLUDE_T_DIFFUSION_CODE  #ifdef   INCLUDE_T_DIFFUSION_CODE
79  #define  _LPT(a) a  #define  _LPT(a)a
80  #define  _BHT(a) a  #define  _BHT(a)a
81  #endif  #endif
82  #ifndef  INCLUDE_T_DIFFUSION_CODE  #ifndef  INCLUDE_T_DIFFUSION_CODE
83  #define  _LPT(a)  #define  _LPT(a)
# Line 42  C o Include/exclude temperature forcing Line 90  C o Include/exclude temperature forcing
90  C o Include/exclude momentum advection code  C o Include/exclude momentum advection code
91  #define  INCLUDE_MOMENTUM_ADVECTION_CODE  #define  INCLUDE_MOMENTUM_ADVECTION_CODE
92  #ifdef   INCLUDE_MOMENTUM_ADVECTION_CODE  #ifdef   INCLUDE_MOMENTUM_ADVECTION_CODE
93  #define  _ADM(a) a  #define  _ADM(a)a
94  #endif  #endif
95  #ifndef  INCLUDE_MOMENTUM_ADVECTION_CODE  #ifndef  INCLUDE_MOMENTUM_ADVECTION_CODE
96  #define  _ADM(a)  #define  _ADM(a)
# Line 51  C o Include/exclude momentum advection c Line 99  C o Include/exclude momentum advection c
99  C o Include/exclude laplacian viscosity code  C o Include/exclude laplacian viscosity code
100  #define  INCLUDE_LP_MOMENTUM_DIFFUSION_CODE  #define  INCLUDE_LP_MOMENTUM_DIFFUSION_CODE
101  #ifdef   INCLUDE_LP_MOMENTUM_DIFFUSION_CODE  #ifdef   INCLUDE_LP_MOMENTUM_DIFFUSION_CODE
102  #define  _LPM(a) a  #define  _LPM(a)a
103  #endif  #endif
104  #ifndef  INCLUDE_LP_MOMENTUM_DIFFUSION_CODE  #ifndef  INCLUDE_LP_MOMENTUM_DIFFUSION_CODE
105  #define  _LPM(a)  #define  _LPM(a)
# Line 60  C o Include/exclude laplacian viscosity Line 108  C o Include/exclude laplacian viscosity
108  C o Include/exclude biharmonic viscosity code  C o Include/exclude biharmonic viscosity code
109  #define  INCLUDE_BH_MOMENTUM_DIFFUSION_CODE  #define  INCLUDE_BH_MOMENTUM_DIFFUSION_CODE
110  #ifdef   INCLUDE_BH_MOMENTUM_DIFFUSION_CODE  #ifdef   INCLUDE_BH_MOMENTUM_DIFFUSION_CODE
111  #define  _BHM(a) a  #define  _BHM(a)a
112  #endif  #endif
113  #ifndef  INCLUDE_BH_MOMENTUM_DIFFUSION_CODE  #ifndef  INCLUDE_BH_MOMENTUM_DIFFUSION_CODE
114  #define  _BHM(a)  #define  _BHM(a)
# Line 69  C o Include/exclude biharmonic viscosity Line 117  C o Include/exclude biharmonic viscosity
117  C o Include/exclude gradient of phy_hyd code  C o Include/exclude gradient of phy_hyd code
118  #define INCLUDE_GRADPH_CODE  #define INCLUDE_GRADPH_CODE
119  #ifdef  INCLUDE_GRADPH_CODE  #ifdef  INCLUDE_GRADPH_CODE
120  #define _PHM(a) a  #define _PHM(a)a
121  #endif  #endif
122  #ifndef INCLUDE_GRADPH_CODE  #ifndef INCLUDE_GRADPH_CODE
123  #define _PHM(a)  #define _PHM(a)
# Line 84  C o Include/exclude momentum eqn metric Line 132  C o Include/exclude momentum eqn metric
132  C o Include/exclude phi_hyd calculation code  C o Include/exclude phi_hyd calculation code
133  #define INCLUDE_PHIHYD_CALCULATION_CODE  #define INCLUDE_PHIHYD_CALCULATION_CODE
134    
 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  
   
135  C o Include/exclude call to S/R CONVECT  C o Include/exclude call to S/R CONVECT
136  #define INCLUDE_CONVECT_CALL  #define INCLUDE_CONVECT_CALL
137    
 C o Include/exclude call to S/R CALC_ISOSLOPES  
 #define INCLUDE_CALC_ISOSLOPES_CALL  
   
138  C o Include/exclude call to S/R CALC_DIFFUSIVITY  C o Include/exclude call to S/R CALC_DIFFUSIVITY
139  #define INCLUDE_CALC_DIFFUSIVITY_CALL  #define INCLUDE_CALC_DIFFUSIVITY_CALL
140    
141    C o Allow nonHydrostatic code
142    #undef  ALLOW_NONHYDROSTATIC
143    
144    C o Use "natural" boundary conditions for salinity
145    C   instead of the "virtual salt flux"
146    #undef  USE_NATURAL_BCS
147    
148    C o Use "Exact Convervation" of fluid in Free-Surface formulation
149    C   so that d/dt(eta) is exactly equal to - Div.Transport
150    #undef EXACT_CONSERV
151    
152    C o Allow the use of Non-Linear Free-Surface formulation
153    C   this implies that surface thickness (hFactors) vary with time
154    #undef NONLIN_FRSURF
155    
156  C o Use "OLD" UV discretisation near boundaries (*not* recommended)  C o Use "OLD" UV discretisation near boundaries (*not* recommended)
157  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
158  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 163  C   Note - only works with  #undef NO_SL
163  C          because the old code did not have no-slip BCs  C          because the old code did not have no-slip BCs
164  #undef  OLD_UV_GEOMETRY  #undef  OLD_UV_GEOMETRY
165    
166    C o Include/exclude IERS Special Bureau for the Oceans diagnostics
167    #undef  ALLOW_SBO
168    
169    C o Include/exclude code for sea-ice model
170    #undef  ALLOW_SEAICE
171    
172  C o Execution environment support options  C o Execution environment support options
173  #include "CPP_EEOPTIONS.h"  #include "CPP_EEOPTIONS.h"
174    
175    C o Include/exclude code specific to the ECCO/SEALION version.
176    #undef INCLUDE_ECCO_PACKAGE
177    #ifdef INCLUDE_ECCO_PACKAGE
178    #include "ECCO_CPPOPTIONS.h"
179    #endif
180    
Legend:
Removed from v.1.7  
changed lines
  Added in v.1.22
  ViewVC Help
Powered by ViewVC 1.1.22