| 1 | C $Header$ | C $Header$ | 
| 2 | C | C $Name$ | 
| 3 |  |  | 
| 4 | C | #ifndef CPP_OPTIONS_H | 
| 5 | C CPP flags controlling which code in included in the files that | #define CPP_OPTIONS_H | 
|  | C will be compiled. |  | 
|  | C |  | 
|  |  |  | 
|  | C o Include/exclude code for C-D grid method of integrating the |  | 
|  | C   coriolis terms |  | 
|  | #define  INCLUDE_CD_CODE |  | 
|  |  |  | 
|  | C o Include/exclude diagnostics package interface code |  | 
|  | #define  INCLUDE_DIAGNOSTICS_INTERFACE_CODE |  | 
|  |  |  | 
|  | C o Include/exclude latitude circle FFT filter |  | 
|  | #undef  INCLUDE_LAT_CIRC_FFT_FILTER_CODE |  | 
|  |  |  | 
|  | 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 |  | 
| 6 |  |  | 
| 7 | C o Include/exclude biharmonic viscosity code | C CPP flags controlling particular source code features | 
|  | #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 |  | 
| 8 |  |  | 
| 9 | C o Include/exclude gradient of phy_hyd code | C o Shortwave heating as extra term in external_forcing.F | 
| 10 | #define INCLUDE_GRADPH_CODE | C Note: this should be a run-time option and not necessarily dependent on KPP | 
| 11 | #ifdef  INCLUDE_GRADPH_CODE | #ifdef ALLOW_KPP | 
| 12 | #define _PHM(a) a | #define  SHORTWAVE_HEATING | 
| 13 | #endif | #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 |  | 
| 14 |  |  | 
| 15 | C o Include/exclude phi_hyd calculation code | C o Include/exclude phi_hyd calculation code | 
| 16 | #define INCLUDE_PHIHYD_CALCULATION_CODE | #define INCLUDE_PHIHYD_CALCULATION_CODE | 
| 17 |  |  | 
|  | 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 |  | 
|  |  |  | 
| 18 | C o Include/exclude call to S/R CONVECT | C o Include/exclude call to S/R CONVECT | 
| 19 | #define INCLUDE_CONVECT_CALL | #define INCLUDE_CONVECT_CALL | 
| 20 |  |  | 
|  | C o Include/exclude call to S/R CALC_ISOSLOPES |  | 
|  | #define INCLUDE_CALC_ISOSLOPES_CALL |  | 
|  |  |  | 
| 21 | C o Include/exclude call to S/R CALC_DIFFUSIVITY | C o Include/exclude call to S/R CALC_DIFFUSIVITY | 
| 22 | #define INCLUDE_CALC_DIFFUSIVITY_CALL | #define INCLUDE_CALC_DIFFUSIVITY_CALL | 
| 23 |  |  | 
| 24 | C o Use "natural" boundary conditions for salinity | C o Include/exclude nonHydrostatic code | 
| 25 | C   instead of the "virtual salt flux" | #undef ALLOW_NONHYDROSTATIC | 
| 26 | #undef USE_NATURAL_BCS |  | 
| 27 |  | C o Include pressure loading code | 
| 28 |  | #define ATMOSPHERIC_LOADING | 
| 29 |  |  | 
| 30 |  | C o Use "Exact Convervation" of fluid in Free-Surface formulation | 
| 31 |  | C   so that d/dt(eta) is exactly equal to - Div.Transport | 
| 32 |  | #define EXACT_CONSERV | 
| 33 |  |  | 
| 34 |  | C o Allow the use of Non-Linear Free-Surface formulation | 
| 35 |  | C   this implies that surface thickness (hFactors) vary with time | 
| 36 |  | #undef NONLIN_FRSURF | 
| 37 |  |  | 
| 38 | C o Use "OLD" UV discretisation near boundaries (*not* recommended) | C o Use "OLD" UV discretisation near boundaries (*not* recommended) | 
| 39 | 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 | 
| 40 | C          because the old code did not have no-slip BCs | C          because the old code did not have no-slip BCs | 
| 41 | #undef  OLD_ADV_BCS | #undef  OLD_ADV_BCS | 
| 42 |  |  | 
|  | 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 |  | 
|  |  |  | 
| 43 | C o Execution environment support options | C o Execution environment support options | 
| 44 | #include "CPP_EEOPTIONS.h" | #include "CPP_EEOPTIONS.h" | 
| 45 |  |  | 
| 46 |  | C o Include/exclude code specific to the ECCO/SEALION version. | 
| 47 |  | #undef INCLUDE_ECCO_PACKAGE | 
| 48 |  | #ifdef INCLUDE_ECCO_PACKAGE | 
| 49 |  | #include "ECCO_CPPOPTIONS.h" | 
| 50 |  | #endif | 
| 51 |  |  | 
| 52 |  | #endif /* CPP_OPTIONS_H */ | 
| 53 |  |  |