/[MITgcm]/MITgcm/verification/lab_sea/code_ad/CPP_OPTIONS.h

Diff of /MITgcm/verification/lab_sea/code_ad/CPP_OPTIONS.h

Parent Directory | Revision Log | View Revision Graph Revision Graph | View Patch Patch

-revision 1.2 by jmc,
Thu Aug 21 16:03:22 2008 UTC
+revision 1.3 by jmc,
Tue Aug 14 03:09:00 2012 UTC
 Line 4 
 C $Name$
  #ifndef CPP_OPTIONS_H
  #define CPP_OPTIONS_H
- #include "PACKAGES_CONFIG.h"
+ CBOP
+ C !ROUTINE: CPP_OPTIONS.h
+ C !INTERFACE:
+ C #include "CPP_OPTIONS.h"
+ C !DESCRIPTION:
+ C *==================================================================*
+ C | main CPP options file for the model:
+ C | Control which optional features to compile in model/src code.
+ C *==================================================================*
+ CEOP
  C CPP flags controlling particular source code features
-Line 21 
 C o Include/exclude call to S/R CONVECT
+Line 31 
 C o Include/exclude call to S/R CONVECT
  C o Include/exclude call to S/R CALC_DIFFUSIVITY
  #define INCLUDE_CALC_DIFFUSIVITY_CALL
+ C o Allow full 3D specification of vertical diffusivity
+ #undef ALLOW_3D_DIFFKR
+ C o Allow latitudinally varying BryanLewis79 vertical diffusivity
+ #undef ALLOW_BL79_LAT_VARY
  C o Include/exclude Implicit vertical advection code
  #undef INCLUDE_IMPLVERTADV_CODE
+ C o Include/exclude AdamsBashforth-3rd-Order code
+ #undef ALLOW_ADAMSBASHFORTH_3
  C o Include/exclude nonHydrostatic code
  #undef ALLOW_NONHYDROSTATIC
+ 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 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
-Line 38 
 C o Allow the use of Non-Linear Free-Sur
+Line 75 
 C o Allow the use of Non-Linear Free-Sur
  C   this implies that surface thickness (hFactors) vary with time
  #undef NONLIN_FRSURF
- C o Use "OLD" UV discretisation near boundaries (*not* recommended)
+ C o Include/exclude code for single reduction Conjugate-Gradient solver
- C   Note - only works with  #undef NO_SLIP_LATERAL  in calc_mom_rhs.F
+ #undef ALLOW_SRCG
- C          because the old code did not have no-slip BCs
- #undef  OLD_ADV_BCS
+ 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 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 o Include/exclude single header file containing multiple packages options
- C   AUTODIFF or EXF package.
+ C   (AUTODIFF, COST, CTRL, ECCO, EXF ...) instead of the standard way where
- C   Currently controled by a single header file
+ C   each of the above pkg get its own options from its specific option file.
- C   For this to work, PACKAGES_CONFIG.h needs to be included!
+ C   Although this method, inherited from ECCO setup, has been traditionally
- cph#if (defined (ALLOW_AUTODIFF) || \
+ C   used for all adjoint built, work is in progress to allow to use the
- cph     defined (ALLOW_ECCO) || \
+ C   standard method also for adjoint built.
- cph     defined (ALLOW_EXF))
+ #ifdef PACKAGES_CONFIG_H
- #include "ECCO_CPPOPTIONS.h"
+ # include "ECCO_CPPOPTIONS.h"
- cph#endif
+ #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 */

 Legend:



Removed from v.1.2
 


changed lines


 
Added in v.1.3
 Legend:



Removed from v.1.2
 


changed lines


 
Added in v.1.3
-Removed from v.1.2
+Added in v.1.3

	ViewVC Help
Powered by ViewVC 1.1.22