--- MITgcm/model/inc/CPP_OPTIONS.h 1998/11/30 23:45:24 1.7 +++ MITgcm/model/inc/CPP_OPTIONS.h 2003/03/07 05:31:47 1.19.6.2 @@ -1,25 +1,73 @@ -C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/model/inc/CPP_OPTIONS.h,v 1.7 1998/11/30 23:45:24 adcroft Exp $ +C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/model/inc/CPP_OPTIONS.h,v 1.19.6.2 2003/03/07 05:31:47 heimbach 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 -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. -C +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 --- + + +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 INCLUDE_DIAGNOSTICS_INTERFACE_CODE +#define ALLOW_TIMEAVE -C o Include/exclude latitude circle FFT filter -#undef INCLUDE_LAT_CIRC_FFT_FILTER_CODE +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 +#define _ADT(a)a #endif #ifndef INCLUDE_T_ADVECTION_CODE #define _ADT(a) @@ -28,8 +76,8 @@ 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 +#define _LPT(a)a +#define _BHT(a)a #endif #ifndef INCLUDE_T_DIFFUSION_CODE #define _LPT(a) @@ -42,7 +90,7 @@ C o Include/exclude momentum advection code #define INCLUDE_MOMENTUM_ADVECTION_CODE #ifdef INCLUDE_MOMENTUM_ADVECTION_CODE -#define _ADM(a) a +#define _ADM(a)a #endif #ifndef INCLUDE_MOMENTUM_ADVECTION_CODE #define _ADM(a) @@ -51,7 +99,7 @@ C o Include/exclude laplacian viscosity code #define INCLUDE_LP_MOMENTUM_DIFFUSION_CODE #ifdef INCLUDE_LP_MOMENTUM_DIFFUSION_CODE -#define _LPM(a) a +#define _LPM(a)a #endif #ifndef INCLUDE_LP_MOMENTUM_DIFFUSION_CODE #define _LPM(a) @@ -60,7 +108,7 @@ C o Include/exclude biharmonic viscosity code #define INCLUDE_BH_MOMENTUM_DIFFUSION_CODE #ifdef INCLUDE_BH_MOMENTUM_DIFFUSION_CODE -#define _BHM(a) a +#define _BHM(a)a #endif #ifndef INCLUDE_BH_MOMENTUM_DIFFUSION_CODE #define _BHM(a) @@ -69,7 +117,7 @@ C o Include/exclude gradient of phy_hyd code #define INCLUDE_GRADPH_CODE #ifdef INCLUDE_GRADPH_CODE -#define _PHM(a) a +#define _PHM(a)a #endif #ifndef INCLUDE_GRADPH_CODE #define _PHM(a) @@ -84,34 +132,27 @@ C o Include/exclude phi_hyd calculation code #define INCLUDE_PHIHYD_CALCULATION_CODE -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 - C o Include/exclude call to S/R CONVECT #define INCLUDE_CONVECT_CALL -C o Include/exclude call to S/R CALC_ISOSLOPES -#define INCLUDE_CALC_ISOSLOPES_CALL - 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 Use "natural" boundary conditions for salinity +C instead of the "virtual salt flux" +#undef USE_NATURAL_BCS + +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 + +C o Allow the use of Non-Linear Free-Surface formulation +C this implies that surface thickness (hFactors) vary with time +#undef NONLIN_FRSURF + C o Use "OLD" UV discretisation near boundaries (*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 @@ -122,5 +163,18 @@ C because the old code did not have no-slip BCs #undef OLD_UV_GEOMETRY +C o Include/exclude IERS Special Bureau for the Oceans diagnostics +#undef ALLOW_SBO + +C o Include/exclude code for sea-ice model +#undef ALLOW_SEAICE + 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 +