| 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 | 
 C o Include/exclude code for open-boundary conditions | 
| 59 | 
 #undef   ALLOW_OBCS | 
 #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 | 
| 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 | 
 C o Use "natural" boundary conditions for salinity | 
| 145 | 
 C   instead of the "virtual salt flux" | 
 C   instead of the "virtual salt flux" | 
| 146 | 
 #undef USE_NATURAL_BCS | 
 #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 | 
| 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 | 
  | 
  |