| 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 |
| 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 Allow latitudinally varying BryanLewis79 vertical diffusivity |
| 23 |
#undef ALLOW_NONHYDROSTATIC |
#undef ALLOW_BL79_LAT_VARY |
| 24 |
|
|
| 25 |
|
C o Include/exclude Implicit vertical advection code |
| 26 |
|
#define INCLUDE_IMPLVERTADV_CODE |
| 27 |
|
|
| 28 |
|
C o Include/exclude AdamsBashforth-3rd-Order code |
| 29 |
|
#undef ALLOW_ADAMSBASHFORTH_3 |
| 30 |
|
|
| 31 |
|
C o Include/exclude code for single reduction cg-solver |
| 32 |
|
#undef ALLOW_SRCG |
| 33 |
|
|
| 34 |
|
C o Include/exclude nonHydrostatic code |
| 35 |
|
#undef ALLOW_NONHYDROSTATIC |
| 36 |
|
|
| 37 |
|
C o Include pressure loading code |
| 38 |
|
#define ATMOSPHERIC_LOADING |
| 39 |
|
|
| 40 |
C o Use "natural" boundary conditions for salinity |
C o exclude/allow external forcing-fields load |
| 41 |
C instead of the "virtual salt flux" |
C this allows to read & do simple linear time interpolation of oceanic |
| 42 |
#undef USE_NATURAL_BCS |
C forcing fields, if no specific pkg (e.g., EXF) is used to compute them. |
| 43 |
|
#undef EXCLUDE_FFIELDS_LOAD |
| 44 |
|
|
| 45 |
|
C o Include/exclude GM-like eddy stress in momentum code |
| 46 |
|
#undef ALLOW_EDDYPSI |
| 47 |
|
|
| 48 |
C o Use "Exact Convervation" of fluid in Free-Surface formulation |
C o Use "Exact Convervation" of fluid in Free-Surface formulation |
| 49 |
C so that d/dt(eta) is exactly equal to - Div.Transport |
C so that d/dt(eta) is exactly equal to - Div.Transport |
| 50 |
#undef EXACT_CONSERV |
#define EXACT_CONSERV |
| 51 |
|
|
| 52 |
C o Allow the use of Non-Linear Free-Surface formulation |
C o Allow the use of Non-Linear Free-Surface formulation |
| 53 |
C this implies that surface thickness (hFactors) vary with time |
C this implies that surface thickness (hFactors) vary with time |
| 54 |
#undef NONLIN_FRSURF |
#undef NONLIN_FRSURF |
| 55 |
|
|
| 56 |
|
C o Allow mass source or sink of Fluid in the interior |
| 57 |
|
C (3-D generalisation of oceanic real-fresh water flux) |
| 58 |
|
#undef ALLOW_ADDFLUID |
| 59 |
|
|
| 60 |
|
C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when |
| 61 |
|
C using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi)) |
| 62 |
|
C *only for use on a lat-lon grid* |
| 63 |
|
C Setting this flag here affects both momentum and tracer equation unless |
| 64 |
|
C it is set/unset again in other header fields (e.g., GAD_OPTIONS.h). |
| 65 |
|
C The definition of the flag is commented to avoid interference with |
| 66 |
|
C such other header files. |
| 67 |
|
C The preferred method is specifying a value for viscAhGrid or viscA4Grid |
| 68 |
|
C in data which is then automatically scaled by the grid size; |
| 69 |
|
C the old method of specifying viscAh/viscA4 and this flag is provided |
| 70 |
|
C for completeness only (and for use with the adjoint). |
| 71 |
|
C#define ISOTROPIC_COS_SCALING |
| 72 |
|
|
| 73 |
|
C o This flag selects the form of COSINE(lat) scaling of bi-harmonic term. |
| 74 |
|
C *only for use on a lat-lon grid* |
| 75 |
|
C Has no effect if ISOTROPIC_COS_SCALING is undefined. |
| 76 |
|
C Has no effect on vector invariant momentum equations. |
| 77 |
|
C Setting this flag here affects both momentum and tracer equation unless |
| 78 |
|
C it is set/unset again in other header fields (e.g., GAD_OPTIONS.h). |
| 79 |
|
C The definition of the flag is commented to avoid interference with |
| 80 |
|
C such other header files. |
| 81 |
|
C#define COSINEMETH_III |
| 82 |
|
|
| 83 |
C o Use "OLD" UV discretisation near boundaries (*not* recommended) |
C o Use "OLD" UV discretisation near boundaries (*not* recommended) |
| 84 |
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 |
| 85 |
C because the old code did not have no-slip BCs |
C because the old code did not have no-slip BCs |
| 86 |
#undef OLD_ADV_BCS |
#undef OLD_ADV_BCS |
| 87 |
|
|
| 88 |
C o Use "OLD" UV geometry on sphere (definately *NOT* recommended) |
C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F |
| 89 |
C Note - only works with #undef NO_SLIP_LATERAL in calc_mom_rhs.F |
C Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO |
| 90 |
C because the old code did not have no-slip BCs |
C is still useful with, e.g., single-domain curvilinear configurations. |
| 91 |
#undef OLD_UV_GEOMETRY |
#undef OLD_GRID_IO |
|
|
|
|
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 |
|
| 92 |
|
|
| 93 |
C o Execution environment support options |
C o Execution environment support options |
| 94 |
#include "CPP_EEOPTIONS.h" |
#include "CPP_EEOPTIONS.h" |
| 95 |
|
|
| 96 |
C o Include/exclude code specific to the ECCO/SEALION version. |
C o Include/exclude code specific to the ECCO/SEALION version. |
| 97 |
#undef INCLUDE_ECCO_PACKAGE |
C AUTODIFF or EXF package. |
| 98 |
#ifdef INCLUDE_ECCO_PACKAGE |
C Currently controled by a single header file |
| 99 |
#include "ECCO_CPPOPTIONS.h" |
C For this to work, PACKAGES_CONFIG.h needs to be included! |
| 100 |
#endif |
cph#if (defined (ALLOW_AUTODIFF) || \ |
| 101 |
|
cph defined (ALLOW_ECCO) || \ |
| 102 |
|
cph defined (ALLOW_EXF)) |
| 103 |
|
cph# include "ECCO_CPPOPTIONS.h" |
| 104 |
|
cph#endif |
| 105 |
|
|
| 106 |
|
C o Allow full 3D specification of vertical diffusivity |
| 107 |
|
#ifdef ALLOW_DIFFKR_CONTROL |
| 108 |
|
C - Need to be defined if using DIFFKR_CONTROL |
| 109 |
|
C (alternatively, could have put this in ECCO_CPPOPTIONS) |
| 110 |
|
#define ALLOW_3D_DIFFKR |
| 111 |
|
#else |
| 112 |
|
C - otherwise, can be turned on or off hereafter: |
| 113 |
|
#undef ALLOW_3D_DIFFKR |
| 114 |
|
#endif /* ALLOW_DIFFKR_CONTROL */ |
| 115 |
|
|
| 116 |
|
#endif /* CPP_OPTIONS_H */ |
| 117 |
|
|
Parent Directory
| 
Revision Log
| 
Revision Graph
| 
Patch