tutorial_dic_adjoffline/code_ad/CPP_OPTIONS.h

01a4b8e46d Patr*0001 #ifndef CPP_OPTIONS_H
                0002 #define CPP_OPTIONS_H
                0003
4dd7556535 Jean*0004 CBOP
                0005 C !ROUTINE: CPP_OPTIONS.h
                0006 C !INTERFACE:
                0007 C #include "CPP_OPTIONS.h"
                0008
                0009 C !DESCRIPTION:
                0010 C *==================================================================*
                0011 C | main CPP options file for the model:
                0012 C | Control which optional features to compile in model/src code.
                0013 C *==================================================================*
                0014 CEOP
                0015
                0016 C CPP flags controlling particular source code features
01a4b8e46d Patr*0017
                0018 C o Shortwave heating as extra term in external_forcing.F
4dd7556535 Jean*0019 C Note: this should be a run-time option
                0020 #undef SHORTWAVE_HEATING
01a4b8e46d Patr*0021
                0022 C o Include/exclude phi_hyd calculation code
                0023 #define INCLUDE_PHIHYD_CALCULATION_CODE
                0024
                0025 C o Include/exclude call to S/R CONVECT
                0026 #define INCLUDE_CONVECT_CALL
                0027
                0028 C o Include/exclude call to S/R CALC_DIFFUSIVITY
                0029 #define INCLUDE_CALC_DIFFUSIVITY_CALL
                0030
4dd7556535 Jean*0031 C o Allow full 3D specification of vertical diffusivity
                0032 #undef ALLOW_3D_DIFFKR
01a4b8e46d Patr*0033
4dd7556535 Jean*0034 C o Allow latitudinally varying BryanLewis79 vertical diffusivity
                0035 #undef ALLOW_BL79_LAT_VARY
01a4b8e46d Patr*0036
4dd7556535 Jean*0037 C o Include/exclude Implicit vertical advection code
                0038 #undef INCLUDE_IMPLVERTADV_CODE
                0039
                0040 C o Include/exclude AdamsBashforth-3rd-Order code
                0041 #undef ALLOW_ADAMSBASHFORTH_3
                0042
                0043 C o Include/exclude nonHydrostatic code
                0044 #undef ALLOW_NONHYDROSTATIC
                0045
                0046 C o Allow mass source or sink of Fluid in the interior
                0047 C   (3-D generalisation of oceanic real-fresh water flux)
                0048 #undef ALLOW_ADDFLUID
                0049
                0050 C o Include pressure loading code
01a4b8e46d Patr*0051 #define ATMOSPHERIC_LOADING
                0052
4dd7556535 Jean*0053 C o exclude/allow external forcing-fields load
                0054 C   this allows to read & do simple linear time interpolation of oceanic
                0055 C   forcing fields, if no specific pkg (e.g., EXF) is used to compute them.
                0056 #undef EXCLUDE_FFIELDS_LOAD
                0057
                0058 C o Include/exclude balancing surface forcing fluxes code
                0059 #undef ALLOW_BALANCE_FLUXES
                0060
                0061 C o Include/exclude balancing surface forcing relaxation code
                0062 #undef ALLOW_BALANCE_RELAX
                0063
                0064 C o Include/exclude GM-like eddy stress in momentum code
                0065 #undef ALLOW_EDDYPSI
                0066
                0067 C o Use "Exact Convervation" of fluid in Free-Surface formulation
                0068 C   so that d/dt(eta) is exactly equal to - Div.Transport
                0069 #define EXACT_CONSERV
                0070
                0071 C o Allow the use of Non-Linear Free-Surface formulation
                0072 C   this implies that surface thickness (hFactors) vary with time
                0073 #undef NONLIN_FRSURF
                0074
                0075 C o Include/exclude code for single reduction Conjugate-Gradient solver
                0076 #undef ALLOW_SRCG
                0077
                0078 C o Choices for implicit solver routines solve_*diagonal.F
                0079 C   The following has low memory footprint, but not suitable for AD
                0080 #undef SOLVE_DIAGONAL_LOWMEMORY
                0081 C   The following one suitable for AD but does not vectorize
                0082 #undef SOLVE_DIAGONAL_KINNER
                0083
                0084 C o ALLOW isotropic scaling of harmonic and bi-harmonic terms when
                0085 C   using an locally isotropic spherical grid with (dlambda) x (dphi*cos(phi))
                0086 C *only for use on a lat-lon grid*
                0087 C   Setting this flag here affects both momentum and tracer equation unless
                0088 C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
                0089 C   The definition of the flag is commented to avoid interference with
                0090 C   such other header files.
                0091 C   The preferred method is specifying a value for viscAhGrid or viscA4Grid
                0092 C   in data which is then automatically scaled by the grid size;
                0093 C   the old method of specifying viscAh/viscA4 and this flag is provided
                0094 C   for completeness only (and for use with the adjoint).
                0095 C#define ISOTROPIC_COS_SCALING
                0096
                0097 C o This flag selects the form of COSINE(lat) scaling of bi-harmonic term.
                0098 C *only for use on a lat-lon grid*
                0099 C   Has no effect if ISOTROPIC_COS_SCALING is undefined.
                0100 C   Has no effect on vector invariant momentum equations.
                0101 C   Setting this flag here affects both momentum and tracer equation unless
                0102 C   it is set/unset again in other header fields (e.g., GAD_OPTIONS.h).
                0103 C   The definition of the flag is commented to avoid interference with
                0104 C   such other header files.
                0105 C#define COSINEMETH_III
                0106
                0107 C o Use LONG.bin, LATG.bin, etc., initialization for ini_curviliear_grid.F
                0108 C   Default is to use "new" grid files (OLD_GRID_IO undef) but OLD_GRID_IO
                0109 C   is still useful with, e.g., single-domain curvilinear configurations.
                0110 #undef OLD_GRID_IO
                0111
01a4b8e46d Patr*0112 C o Execution environment support options
                0113 #include "CPP_EEOPTIONS.h"
                0114
4dd7556535 Jean*0115 C o Include/exclude single header file containing multiple packages options
                0116 C   (AUTODIFF, COST, CTRL, ECCO, EXF ...) instead of the standard way where
                0117 C   each of the above pkg get its own options from its specific option file.
                0118 C   Although this method, inherited from ECCO setup, has been traditionally
                0119 C   used for all adjoint built, work is in progress to allow to use the
                0120 C   standard method also for adjoint built.
                0121 #ifdef PACKAGES_CONFIG_H
11c3150c71 Mart*0122 c# include "ECCO_CPPOPTIONS.h"
01a4b8e46d Patr*0123 #endif
                0124
                0125 #endif /* CPP_OPTIONS_H */