/[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.21 by cheisey, Thu Nov 21 19:11:42 2002 UTC revision 1.31 by jmc, Mon Apr 5 23:42:52 2004 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2  C $Name$  C $Name$
3    
4    These lines are here to deliberately cause a compile-time error.  #ifndef CPP_OPTIONS_H
5    If you see these lines in your .F files or the compiler shows them  #define CPP_OPTIONS_H
   as an error then it means you have not placed your configuration  
   files in the appropriate place.  
   You need to place you own copy of CPP_OPTIONS.h in the include  
   path for the model.  
   
 C  
   
 CBOP  
 C !ROUTINE: CPP_OPTIONS.h  
 C !INTERFACE:  
 C include "CPP_OPTIONS.h"  
 C !DESCRIPTION:  
 C CPP flags controlling which code in included in the files that  
 C will be compiled.  
 CEOP  
   
 C o Include/exclude code for AIM package  
 #undef  ALLOW_AIM  
   
 C o Include/exclude code for GM/Redi parameterization  
 #undef  ALLOW_GMREDI  
   
 C o Include/exclude code for KPP mixing scheme  
 #define  ALLOW_KPP  
   
 cswdblk --- add ---  
 C o Include/exclude code for bulk formula  
 #define  ALLOW_BULK_FORCE  
 #ifdef ALLOW_BULK_FORCE  
 cswdice -- add ---  
 C o allow seaice  
 #define ALLOW_THERM_SEAICE  
 cswdice -- end add ---  
   
 C o try to conserve qnet and emp  
 #define CONSERV_BULKF  
 #endif  
 cswdblk -- end add ---  
6    
7    C CPP flags controlling particular source code features
8    
9  C o Shortwave heating as extra term in external_forcing.F  C o Shortwave heating as extra term in external_forcing.F
10  #ifdef ALLOW_KPP  C Note: this should be a run-time option
11  #define  SHORTWAVE_HEATING  #undef SHORTWAVE_HEATING
 #endif  
   
 C o Include/exclude code for Shapiro filters  
 #define ALLOW_SHAP_FILT  
   
 C o Include/exclude code for C-D grid method of integrating the  
 C   coriolis terms  
 #define  INCLUDE_CD_CODE  
   
 C o Include/exclude code for open-boundary conditions  
 #undef  ALLOW_OBCS  
   
 C o Include/exclude diagnostics package interface code  
 #define  ALLOW_TIMEAVE  
   
 C o Include/exclude zonal FFT filter code  
 #undef  ALLOW_ZONAL_FILT  
   
 C o Include/exclude temperature advection code  
 #define  INCLUDE_T_ADVECTION_CODE  
 #ifdef   INCLUDE_T_ADVECTION_CODE  
 #define  _ADT(a)a  
 #endif  
 #ifndef  INCLUDE_T_ADVECTION_CODE  
 #define  _ADT(a)  
 #endif  
   
 C o Include/exclude temperature diffusion code  
 #define  INCLUDE_T_DIFFUSION_CODE  
 #ifdef   INCLUDE_T_DIFFUSION_CODE  
 #define  _LPT(a)a  
 #define  _BHT(a)a  
 #endif  
 #ifndef  INCLUDE_T_DIFFUSION_CODE  
 #define  _LPT(a)  
 #define  _BHT(a)  
 #endif  
   
 C o Include/exclude temperature forcing code  
 #define  INCLUDE_T_FORCING_CODE  
   
 C o Include/exclude momentum advection code  
 #define  INCLUDE_MOMENTUM_ADVECTION_CODE  
 #ifdef   INCLUDE_MOMENTUM_ADVECTION_CODE  
 #define  _ADM(a)a  
 #endif  
 #ifndef  INCLUDE_MOMENTUM_ADVECTION_CODE  
 #define  _ADM(a)  
 #endif  
   
 C o Include/exclude laplacian viscosity code  
 #define  INCLUDE_LP_MOMENTUM_DIFFUSION_CODE  
 #ifdef   INCLUDE_LP_MOMENTUM_DIFFUSION_CODE  
 #define  _LPM(a)a  
 #endif  
 #ifndef  INCLUDE_LP_MOMENTUM_DIFFUSION_CODE  
 #define  _LPM(a)  
 #endif  
   
 C o Include/exclude biharmonic viscosity code  
 #define  INCLUDE_BH_MOMENTUM_DIFFUSION_CODE  
 #ifdef   INCLUDE_BH_MOMENTUM_DIFFUSION_CODE  
 #define  _BHM(a)a  
 #endif  
 #ifndef  INCLUDE_BH_MOMENTUM_DIFFUSION_CODE  
 #define  _BHM(a)  
 #endif  
   
 C o Include/exclude gradient of phy_hyd code  
 #define INCLUDE_GRADPH_CODE  
 #ifdef  INCLUDE_GRADPH_CODE  
 #define _PHM(a)a  
 #endif  
 #ifndef INCLUDE_GRADPH_CODE  
 #define _PHM(a)  
 #endif  
   
 C o Include/exclude momentum forcing code  
 #define INCLUDE_MOMENTUM_FORCING_CODE  
   
 C o Include/exclude momentum eqn metric terms code  
 #define INCLUDE_MOMENTUM_METRIC_TERM_CODE  
12    
13  C o Include/exclude phi_hyd calculation code  C o Include/exclude phi_hyd calculation code
14  #define INCLUDE_PHIHYD_CALCULATION_CODE  #define INCLUDE_PHIHYD_CALCULATION_CODE
# Line 138  C o Include/exclude call to S/R CONVECT Line 19  C o Include/exclude call to S/R CONVECT
19  C o Include/exclude call to S/R CALC_DIFFUSIVITY  C o Include/exclude call to S/R CALC_DIFFUSIVITY
20  #define INCLUDE_CALC_DIFFUSIVITY_CALL  #define INCLUDE_CALC_DIFFUSIVITY_CALL
21    
22  C o Allow nonHydrostatic code  C o Include/exclude Implicit vertical advection code
23  #undef  ALLOW_NONHYDROSTATIC  #define INCLUDE_IMPLVERTADV_CODE
24    
25  C o Use "natural" boundary conditions for salinity  C o Include/exclude nonHydrostatic code
26  C   instead of the "virtual salt flux"  #undef ALLOW_NONHYDROSTATIC
27  #undef  USE_NATURAL_BCS  
28    C o Include pressure loading code
29    #define ATMOSPHERIC_LOADING
30    
31  C o Use "Exact Convervation" of fluid in Free-Surface formulation  C o Use "Exact Convervation" of fluid in Free-Surface formulation
32  C   so that d/dt(eta) is exactly equal to - Div.Transport  C   so that d/dt(eta) is exactly equal to - Div.Transport
33  #undef EXACT_CONSERV  #define EXACT_CONSERV
34    
35  C o Allow the use of Non-Linear Free-Surface formulation  C o Allow the use of Non-Linear Free-Surface formulation
36  C   this implies that surface thickness (hFactors) vary with time  C   this implies that surface thickness (hFactors) vary with time
# Line 158  C   Note - only works with  #undef NO_SL Line 41  C   Note - only works with  #undef NO_SL
41  C          because the old code did not have no-slip BCs  C          because the old code did not have no-slip BCs
42  #undef  OLD_ADV_BCS  #undef  OLD_ADV_BCS
43    
 C o Use "OLD" UV geometry on sphere (definately *NOT* recommended)  
 C   Note - only works with  #undef NO_SLIP_LATERAL  in calc_mom_rhs.F  
 C          because the old code did not have no-slip BCs  
 #undef  OLD_UV_GEOMETRY  
   
44  C o Execution environment support options  C o Execution environment support options
45  #include "CPP_EEOPTIONS.h"  #include "CPP_EEOPTIONS.h"
46    
47  C o Include/exclude code specific to the ECCO/SEALION version.  C o Include/exclude code specific to the ECCO/SEALION version.
48  #undef INCLUDE_ECCO_PACKAGE  C   AUTODIFF or EXF package.
49  #ifdef INCLUDE_ECCO_PACKAGE  C   Currently controled by a single header file
50  #include "ECCO_CPPOPTIONS.h"  C   For this to work, PACKAGES_CONFIG.h needs to be included!
51  #endif  cph#if (defined (ALLOW_AUTODIFF) || \
52    cph     defined (ALLOW_ECCO) || \
53    cph     defined (ALLOW_EXF))
54    cph# include "ECCO_CPPOPTIONS.h"
55    cph#endif
56    
57    #endif /* CPP_OPTIONS_H */
58    
Legend:
Removed from v.1.21  
changed lines
  Added in v.1.31
  ViewVC Help
Powered by ViewVC 1.1.22