wc13.h

Go to the documentation of this file.

/*
** git $id$
*******************************************************************************
** copyright(c) 2002-2025 the roms group                                    **
**   licensed under a mit/x style license                                    **
**   see license_roms.md                                                     **
*******************************************************************************
**
** options for the california current system, 1/3 degree resolution.
**
** application flag:   wc13
** input script:       roms_wc13.in
**                     s4dvar.in
**
** available drivers options: choose only one and activate it in the
**                            build.sh script(my_cpp_flags definition)
**
**  ad_sensitivity            adjoint sensitivity driver
**  aft_eigenmodes            adjoint finite time eigenmodes
**  array_modes               stabilized representer matrix array modes
**  clipping                  stabilized representer matrix clipped analysis
**  correlation               background-error correlation check
**  gradient_check            tlm/adm gradient check
**  forcing_sv                forcing singular vectors
**  ft_eigenmodes             finite time eigenmodes
**  i4dvar                    incremental, strong constraint 4d-var
**  nlm_driver                nonlinear basic state trajectory
**  normalization             background error covariance normalization
**  opt_perturbation          optimal perturbations
**  picard_test               picard iterations test
**  rbl4dvar                  strong/weak constraint rbl4d-var
**  r4dvar                    stronf/weak constraint r4d-var
**  r_symmetry                representer matrix symmetry test
**  sanity_check              sanity check
**  so_semi                   stochastic optimals: semi-norm
**  tlm_check                 tangent linear model check
**  verification              nl observation verification driver
*/
 
/*
**-----------------------------------------------------------------------------
**  nonlinear basic state settings.
**-----------------------------------------------------------------------------
*/
 
#ifdef VERIFICATION
# define FULL_GRID
#endif
 
#define ANA_BSFLUX
#define ANA_BTFLUX
 
#define UV_ADV
#define DJ_GRADPS
#define UV_COR
#define UV_QDRAG
#define UV_VIS2
#define MIX_S_UV
#define MIX_GEO_TS
#define SPLINES_VDIFF
#define SPLINES_VVISC
#define TS_DIF2
#define SOLVE3D
#define SALINITY
#define NONLIN_EOS
#define CURVGRID
#define PROFILE
#define SPHERICAL
#define MASKING
 
#ifdef NLM_DRIVER
# define AVERAGES           /* define if writing out time-averaged data */
#endif
 
/*
**  vertical mixing parameterization
*/
 
#define GLS_MIXING
#ifdef GLS_MIXING
# define N2S2_HORAVG
# define KANTHA_CLAYSON
# define RI_SPLINES
#endif
 
/*
** surface atmospheric fluxes. note, that we must define diurnal_srflux
** when using daily averaged fields.
*/
 
#define BULK_FLUXES      /* turn ON or OFF bulk fluxes computation */
 
#define DIURNAL_SRFLUX   /* impose shortwave radiation local diurnal cycle */
#define SOLAR_SOURCE     /* define solar radiation source term */
#define LONGWAVE_OUT     /* Compute net longwave radiation internally */
#define EMINUSP          /* turn ON internal calculation of E-P */
 
/*
**-----------------------------------------------------------------------------
**  variational Data assimilation.
**-----------------------------------------------------------------------------
*/
 
/*
**  options to compute error covariance normalization coefficients.
*/
 
#ifdef NORMALIZATION
# define ADJUST_BOUNDARY
# define ADJUST_WSTRESS
# define ADJUST_STFLUX
# define CORRELATION
# define VCONVOLUTION
# define IMPLICIT_VCONV
# define FULL_GRID
# define FORWARD_WRITE
# define FORWARD_READ
# define FORWARD_MIXING
# define OUT_DOUBLE
#endif
 
/*
**  options for adjoint-based algorithms sanity checks.
*/
 
#ifdef SANITY_CHECK
# define FULL_GRID
# define FORWARD_READ
# define FORWARD_WRITE
# define FORWARD_MIXING
# define OUT_DOUBLE
# define ANA_PERTURB
# define ANA_INITIAL
#endif
 
 
/*
**  Common options to all 4dvar algorithms.
*/
 
#if defined ARRAY_MODES              || \
    defined clipping                 || \
    defined i4dvar                   || \
    defined i4dvar_ana_sensitivity   || \
    defined rbl4dvar                 || \
    defined rbl4dvar_ana_sensitivity || \
    defined r4dvar                   || \
    defined r4dvar_ana_sensitivity
# define ADJUST_BOUNDARY
# define ADJUST_WSTRESS
# define ADJUST_STFLUX
# define PRIOR_BULK_FLUXES
# define FORWARD_FLUXES
# define VCONVOLUTION
# define IMPLICIT_VCONV
# define BALANCE_OPERATOR
# ifdef BALANCE_OPERATOR
#  define ZETA_ELLIPTIC
# endif
# define FORWARD_WRITE
# define FORWARD_READ
# define FORWARD_MIXING
# define OUT_DOUBLE
#endif
 
/*
**  special options for each 4dvar algorithm.
*/
 
#if defined ARRAY_MODES            || \
    defined r4dvar                 || \
    defined r4dvar_ana_sensitivity
# define RPM_RELAXATION
#endif