--- MITgcm/model/inc/CPP_OPTIONS.h 2003/10/28 22:57:59 1.27 +++ MITgcm/model/inc/CPP_OPTIONS.h 2012/08/01 14:02:11 1.49 @@ -1,4 +1,4 @@ -C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/model/inc/CPP_OPTIONS.h,v 1.27 2003/10/28 22:57:59 edhill Exp $ +C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/model/inc/CPP_OPTIONS.h,v 1.49 2012/08/01 14:02:11 jmc Exp $ C $Name: $ #ifndef CPP_OPTIONS_H @@ -6,20 +6,9 @@ C CPP flags controlling particular source code features -C o Include/exclude temperature forcing code -C#define INCLUDE_T_FORCING_CODE - C o Shortwave heating as extra term in external_forcing.F -C Note: this should be a run-time option and not necessarily dependent on KPP -#ifdef ALLOW_KPP -#define SHORTWAVE_HEATING -#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 @@ -30,12 +19,38 @@ C o Include/exclude call to S/R CALC_DIFFUSIVITY #define INCLUDE_CALC_DIFFUSIVITY_CALL +C o Allow latitudinally varying BryanLewis79 vertical diffusivity +#undef ALLOW_BL79_LAT_VARY + +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 code for single reduction Conjugate-Gradient solver +#define ALLOW_SRCG + C o Include/exclude nonHydrostatic code #undef ALLOW_NONHYDROSTATIC C o Include pressure loading code #define ATMOSPHERIC_LOADING +C o exclude/allow external forcing-fields load +C this allows to read & do simple linear time interpolation of oceanic +C forcing fields, if no specific pkg (e.g., EXF) is used to compute them. +#undef EXCLUDE_FFIELDS_LOAD + +C o Include/exclude balancing surface forcing fluxes code +#undef ALLOW_BALANCE_FLUXES + +C o Include/exclude balancing surface forcing relaxation code +#undef ALLOW_BALANCE_RELAX + +C o Include/exclude GM-like eddy stress in momentum code +#undef ALLOW_EDDYPSI + C o Use "Exact Convervation" of fluid in Free-Surface formulation C so that d/dt(eta) is exactly equal to - Div.Transport #define EXACT_CONSERV @@ -44,24 +59,69 @@ C this implies that surface thickness (hFactors) vary with time #undef NONLIN_FRSURF +C o Allow mass source or sink of Fluid in the interior +C (3-D generalisation of oceanic real-fresh water flux) +#undef ALLOW_ADDFLUID + +C o Choices for implicit solver routines solve_*diagonal.F +C The following has low memory footprint, but not suitable for AD +#undef SOLVE_DIAGONAL_LOWMEMORY +C The following one suitable for AD but does not vectorize +#undef SOLVE_DIAGONAL_KINNER + +C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when +C using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi)) +C *only for use on a lat-lon grid* +C Setting this flag here affects both momentum and tracer equation unless +C it is set/unset again in other header fields (e.g., GAD_OPTIONS.h). +C The definition of the flag is commented to avoid interference with +C such other header files. +C The preferred method is specifying a value for viscAhGrid or viscA4Grid +C in data which is then automatically scaled by the grid size; +C the old method of specifying viscAh/viscA4 and this flag is provided +C for completeness only (and for use with the adjoint). +C#define ISOTROPIC_COS_SCALING + +C o This flag selects the form of COSINE(lat) scaling of bi-harmonic term. +C *only for use on a lat-lon grid* +C Has no effect if ISOTROPIC_COS_SCALING is undefined. +C Has no effect on vector invariant momentum equations. +C Setting this flag here affects both momentum and tracer equation unless +C it is set/unset again in other header fields (e.g., GAD_OPTIONS.h). +C The definition of the flag is commented to avoid interference with +C such other header files. +C#define COSINEMETH_III + 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 #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 Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F +C Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO +C is still useful with, e.g., single-domain curvilinear configurations. +#undef OLD_GRID_IO 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 o Include/exclude single header file containing multiple packages options +C (AUTODIFF, COST, CTRL, ECCO, EXF ...) instead of the standard way where +C each of the above pkg get its own options from its specific option file. +C Although this method, inherited from ECCO setup, has been traditionally +C used for all adjoint built, the alternative standard way is currently +C going through rehabilitation. +c#include "ECCO_CPPOPTIONS.h" + +C o Allow full 3D specification of vertical diffusivity +#ifdef ALLOW_DIFFKR_CONTROL +C - Need to be defined if using DIFFKR_CONTROL +C (alternatively, could have put this in ECCO_CPPOPTIONS) +#define ALLOW_3D_DIFFKR +#else +C - otherwise, can be turned on or off hereafter: +#undef ALLOW_3D_DIFFKR +#endif /* ALLOW_DIFFKR_CONTROL */ #endif /* CPP_OPTIONS_H */