--- MITgcm/model/inc/CPP_OPTIONS.h 2003/02/12 06:45:54 1.19.10.1 +++ MITgcm/model/inc/CPP_OPTIONS.h 2005/04/15 13:19:46 1.33 @@ -1,118 +1,14 @@ -C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/model/inc/CPP_OPTIONS.h,v 1.19.10.1 2003/02/12 06:45:54 dimitri Exp $ +C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/model/inc/CPP_OPTIONS.h,v 1.33 2005/04/15 13:19:46 jmc Exp $ C $Name: $ - These lines are here to deliberately cause a compile-time error. - If you see these lines in your .F files or the compiler shows them - 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 +#ifndef CPP_OPTIONS_H +#define CPP_OPTIONS_H -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 +C CPP flags controlling particular source code features C o Shortwave heating as extra term in external_forcing.F -#ifdef ALLOW_KPP -#define 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 +C Note: this should be a run-time option +#undef SHORTWAVE_HEATING C o Include/exclude phi_hyd calculation code #define INCLUDE_PHIHYD_CALCULATION_CODE @@ -123,16 +19,21 @@ C o Include/exclude call to S/R CALC_DIFFUSIVITY #define INCLUDE_CALC_DIFFUSIVITY_CALL -C o Allow nonHydrostatic code -#undef ALLOW_NONHYDROSTATIC +C o Include/exclude Implicit vertical advection code +#define INCLUDE_IMPLVERTADV_CODE + +C o Include/exclude AdamsBashforth-3rd-Order code +#undef ALLOW_ADAMSBASHFORTH_3 + +C o Include/exclude nonHydrostatic code +#undef ALLOW_NONHYDROSTATIC -C o Use "natural" boundary conditions for salinity -C instead of the "virtual salt flux" -#undef USE_NATURAL_BCS +C o Include pressure loading code +#define ATMOSPHERIC_LOADING C o Use "Exact Convervation" of fluid in Free-Surface formulation C so that d/dt(eta) is exactly equal to - Div.Transport -#undef EXACT_CONSERV +#define EXACT_CONSERV C o Allow the use of Non-Linear Free-Surface formulation C this implies that surface thickness (hFactors) vary with time @@ -143,19 +44,21 @@ C because the old code did not have no-slip BCs #undef OLD_ADV_BCS -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 - -C o Include/exclude code for sea-ice model -#undef ALLOW_SEAICE +C o Minimal time-averaged output: S, T, U, V, W, ETA, and phiHydLow. +#undef MINIMAL_TAVE_OUTPUT C o Execution environment support options #include "CPP_EEOPTIONS.h" C o Include/exclude code specific to the ECCO/SEALION version. -#undef INCLUDE_ECCO_PACKAGE -#ifdef INCLUDE_ECCO_PACKAGE -#include "ECCO_CPPOPTIONS.h" -#endif +C AUTODIFF or EXF package. +C Currently controled by a single header file +C For this to work, PACKAGES_CONFIG.h needs to be included! +cph#if (defined (ALLOW_AUTODIFF) || \ +cph defined (ALLOW_ECCO) || \ +cph defined (ALLOW_EXF)) +cph# include "ECCO_CPPOPTIONS.h" +cph#endif + +#endif /* CPP_OPTIONS_H */ +