--- MITgcm/verification/advect_xz/code/CPP_OPTIONS.h	2001/09/28 02:28:10	1.1
+++ MITgcm/verification/advect_xz/code/CPP_OPTIONS.h	2011/12/05 21:59:46	1.3
@@ -1,142 +1,117 @@
-C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/verification/advect_xz/code/CPP_OPTIONS.h,v 1.1 2001/09/28 02:28:10 adcroft Exp $
+C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/verification/advect_xz/code/CPP_OPTIONS.h,v 1.3 2011/12/05 21:59:46 jmc Exp $
 C $Name:  $
 
-C 
-C CPP flags controlling which code in included in the files that
-C will be compiled.
-C
-
-C o Include/exclude code for GM/Redi parameterization
-#undef  ALLOW_GMREDI
-
-C o Include/exclude code for KPP mixing scheme
-#undef  ALLOW_KPP
-
-C o Include/exclude code for C-D grid method of integrating the 
-C   coriolis terms
-#undef  INCLUDE_CD_CODE
-
-C o Include/exclude code for open-boundary conditions
-#undef  ALLOW_OBCS
-
-C o Include/exclude diagnostics package interface code
-#undef  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
-
-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
+#ifndef CPP_OPTIONS_H
+#define CPP_OPTIONS_H
 
-C o Include/exclude momentum forcing code
-#define INCLUDE_MOMENTUM_FORCING_CODE
+C CPP flags controlling particular source code features
 
-C o Include/exclude momentum eqn metric terms code
-#define INCLUDE_MOMENTUM_METRIC_TERM_CODE
+C o Shortwave heating as extra term in external_forcing.F
+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
 
-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 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 Use "natural" boundary conditions for salinity
-C   instead of the "virtual salt flux"
-#undef  USE_NATURAL_BCS
+C o Include/exclude code for single reduction cg-solver
+#undef 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 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
+
+C o Allow the use of Non-Linear Free-Surface formulation
+C   this implies that surface thickness (hFactors) vary with time
+#define 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 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.
+C   AUTODIFF or EXF package.
+C   Currently controled by a single header file
+C   For this to work, PACKAGES_CONFIG.h needs to be included!
+cph#if (defined (ALLOW_AUTODIFF) || \
+cph     defined (ALLOW_ECCO) || \
+cph     defined (ALLOW_EXF))
+cph# include "ECCO_CPPOPTIONS.h"
+cph#endif
+
+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 */
+