doxygen/double__gyre_8h_source.html

/*

** git $id$

*******************************************************************************

** copyright(c) 2002-2025 the roms group                                    **

**   licensed under a mit/x style license                                    **

**   see license_roms.md                                                     **

*******************************************************************************

**

** options for 4dvar Data assimilation toy.

**

** application flag:   double_gyre

** input script:       roms_double_gyre.in

**

**

** available driver options:  choose only one and activate it in the

**                            build.sh script(my_cpp_flags definition)

**

** ad_sensitivity             adjoint sensitivity

** aft_eigenmodes             adjoint finite time eigenmodes

** 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

** opt_perturbation           optimal perturbations

** picard_test                picard iterations tes

** rbl4dvar                   strong/weak constraint rbl4d-var

** r4dvar                     strong/weak constraint r4d-var

** r_symmetry                 representer matrix symmetry tes

** sanity_check               sanity check

** so_semi                    stochastic optimals: semi-norm

** tlm_check                  tangent linear model check

*/


#define SOLVE3D


/*

**-----------------------------------------------------------------------------

**  nonlinear basic state tracjectory.

**-----------------------------------------------------------------------------

*/


#if defined NLM_DRIVER

# if defined SOLVE3D                   /* 3D Application */

#  undef  UV_C2ADVECTION

#  define UV_ADV

#  define UV_COR

#  define UV_LDRAG

#  define UV_VIS2

#  define MIX_S_UV

#  undef  MIX_GEO_UV

#  undef  WJ_GRADP

#  define DJ_GRADPS

#  define SPLINES_VDIFF

#  define SPLINES_VVISC

#  define TS_DIF2

#  undef  TS_DIF4

#  define MIX_S_TS

#  undef  MIX_GEO_TS

#  undef  MIX_ISO_TS

#  define NONLIN_EOS

#  define SALINITY

#  define AVERAGES

#  define ANA_GRID

#  undef  MY25_MIXING

#  if defined MY25_MIXING

#   undef  KANTHA_CLAYSON

#   undef  CANUTO_A

#   undef  N2S2_HORAVG

#   define RI_SPLINES

#  endif

#  undef  ANA_INITIAL

#  define ANA_TCLIMA

#  define ANA_SMFLUX

#  define ANA_STFLUX

#  define ANA_SSFLUX

#  define ANA_BSFLUX

#  define ANA_BTFLUX

#  undef  ANA_VMIX

#  undef  VERIFICATION

#  define FORWARD_RHS

#  define FORWARD_WRITE

#  define OUT_DOUBLE

# else                                 /* 2D Application */

#  undef  UV_C2ADVECTION

#  define UV_ADV

#  define UV_COR

#  define UV_LDRAG

#  define UV_VIS2

#  define AVERAGES

#  define ANA_GRID

#  undef  ANA_INITIAL

#  define ANA_SMFLUX

#  undef  FORWARD_RHS

#  undef  FORWARD_WRITE

#  undef  OUT_DOUBLE

# endif

#endif


/*

**-----------------------------------------------------------------------------

**  picard iteration test.

**-----------------------------------------------------------------------------

*/


#if defined PICARD_TEST

# if defined SOLVE3D                   /* 3D Application */

#  undef  UV_C2ADVECTION

#  define UV_ADV

#  define UV_COR

#  define UV_LDRAG

#  define UV_VIS2

#  define MIX_S_UV

#  undef  MIX_GEO_UV

#  undef  WJ_GRADP

#  define DJ_GRADPS

#  define SPLINES_VDIFF

#  define SPLINES_VVISC

#  define TS_DIF2

#  undef  TS_DIF4

#  undef  MIX_S_TS

#  undef  MIX_GEO_TS

#  define MIX_ISO_TS

#  define NONLIN_EOS

#  define ANA_GRID

#  undef  ANA_INITIAL

#  undef  ANA_TCLIMA

#  define ANA_SMFLUX

#  define ANA_STFLUX

#  define ANA_BTFLUX

#  undef  ANA_VMIX

#  undef  IMPULSE

#  undef  FORWARD_RHS

#  define FORWARD_READ

#  define FORWARD_WRITE

#  undef  RST_SINGLE

#  define OUT_DOUBLE

# else                                 /* 2D Application */

#  undef  UV_C2ADVECTION

#  define UV_ADV

#  define UV_COR

#  define UV_LDRAG

#  define UV_VIS2

#  undef  UV_VIS4

#  define ANA_GRID

#  undef  ANA_INITIAL

#  define ANA_SMFLUX

#  undef  FORWARD_RHS

#  define FORWARD_READ

#  define FORWARD_WRITE

#  define OUT_DOUBLE

# endif

#endif


/*

**-----------------------------------------------------------------------------

**  generalized stability theory analysis.

**-----------------------------------------------------------------------------

*/


#if defined AFT_EIGENMODES || defined FT_EIGENMODES    || \

    defined forcing_sv     || defined opt_perturbation || \

    defined so_semi

# if defined SOLVE3D                   /* 3D Application */

#  define UV_ADV

#  define UV_LDRAG

#  define UV_VIS2

#  define MIX_S_UV

#  define UV_COR

#  define TS_DIF2

#  define MIX_S_TS

#  define DJ_GRADPS

#  define NONLIN_EOS

#  define ANA_GRID

#  define ANA_TCLIMA

#  define ANA_GRID

#  define ANA_INITIAL

#  define ANA_SMFLUX

#  define ANA_STFLUX

#  define ANA_BTFLUX

#  define FORWARD_READ

# else                                 /* 2D Application */

#  define UV_ADV

#  define UV_VIS2

#  define UV_COR

#  define UV_LDRAG

#  define ANA_GRID

#  define ANA_INITIAL

#  define ANA_SMFLUX

#  define FORWARD_READ

# endif

#endif


/*

**-----------------------------------------------------------------------------

**  variational Data assimilation.

**-----------------------------------------------------------------------------

*/


#if defined CORRELATION || defined I4DVAR    || \

    defined rbl4dvar    || defined r4dvar    || \

    defined r_symmetry  || defined tlm_check

# if defined SOLVE3D                   /* 3D Application */

#  undef  UV_C2ADVECTION

#  undef  UV_C4ADVECTION

#  undef  UV_SADVECTION

#  define UV_ADV

#  define UV_COR

#  define UV_LDRAG

#  define UV_VIS2

#  define MIX_S_UV

#  undef  MIX_GEO_UV

#  undef  WJ_GRADP

#  define DJ_GRADPS

#  define SPLINES_VDIFF

#  define SPLINES_VVISC

#  undef  TS_FIXED

#  define TS_DIF2

#  define MIX_S_TS

#  undef  MIX_GEO_TS

#  undef  NONLIN_EOS

#  define SALINITY

#  undef  ANA_INITIAL

#  define ANA_GRID

#  define ANA_TCLIMA

#  define ANA_SMFLUX

#  define ANA_STFLUX

#  define ANA_SSFLUX

#  define ANA_BTFLUX

#  define ANA_BSFLUX

#  define FORWARD_WRITE

#  define FORWARD_READ

#  undef  FULL_GRID

#  define OUT_DOUBLE

#  define VCONVOLUTION

#  define IMPLICIT_VCONV

#  ifdef R4DVAR

#   define RPM_RELAXATION

#  endif

# else                                 /* 2D Application */

#  undef  UV_C2ADVECTION

#  define UV_ADV

#  define UV_LDRAG

#  define UV_VIS2

#  undef  UV_VIS4

#  define UV_COR

#  undef  AVERAGES

#  define ANA_GRID

#  undef  ANA_INITIAL

#  define ANA_SMFLUX

#  define FORWARD_WRITE

#  define FORWARD_READ

#  define OUT_DOUBLE

# endif

#endif


/*

**-----------------------------------------------------------------------------

**  sanity check.

**-----------------------------------------------------------------------------

*/


#if defined SANITY_CHECK

# if defined SOLVE3D                   /* 3D Application */

#  undef  UV_C2ADVECTION

#  define UV_C4ADVECTION

#  undef  UV_SADVECTION

#  define UV_ADV

#  define UV_COR

#  define UV_LDRAG

#  undef  UV_QDRAG

#  undef  UV_VIS2

#  define UV_VIS4

#  undef  MIX_S_UV

#  define MIX_GEO_UV

#  define WJ_GRADP

#  undef  DJ_GRADPS

#  define SPLINES_VDIFF

#  define SPLINES_VVISC

#  define TS_DIF2

#  undef  TS_DIF4

#  define MIX_S_TS

#  undef  MIX_GEO_TS

#  undef  MIX_ISO_TS

#  define NONLIN_EOS

#  define ANA_INITIAL

#  define ANA_GRID

#  define ANA_TCLIMA

#  define ANA_SMFLUX

#  define ANA_STFLUX

#  define ANA_BTFLUX

#  define ANA_PERTURB

#  define SANITY_CHECK

#  define FORWARD_READ

#  undef  OUT_DOUBLE

# else                                 /* 2D Application */

#  define UV_ADV

#  define UV_VIS2

#  undef  UV_VIS4

#  define UV_COR

#  define UV_LDRAG

#  define ANA_GRID

#  define ANA_INITIAL

#  define ANA_SMFLUX

#  define ANA_PERTURB

#  define FORWARD_READ

# endif

#endif


/*

**-----------------------------------------------------------------------------

**  3d double-gyre adjoint sensitivity.

**-----------------------------------------------------------------------------

*/


#if defined AD_SENSITIVITY

# if defined SOLVE3D                   /* 3D Application */

#  undef  UV_C2ADVECTION

#  undef  UV_C4ADVECTION

#  undef  UV_SADVECTION

#  define UV_ADV

#  define UV_COR

#  define UV_LDRAG

#  define UV_VIS2

#  define MIX_S_UV

#  undef  MIX_GEO_UV

#  undef  WJ_GRADP

#  undef  DJ_GRADPS

#  define SPLINES_VDIFF

#  define SPLINES_VVISC

#  define TS_DIF2

#  define MIX_S_TS

#  undef  MIX_GEO_TS

#  define NONLIN_EOS

#  define AVERAGES

#  undef  ANA_INITIAL

#  define ANA_GRID

#  define ANA_TCLIMA

#  define ANA_SMFLUX

#  define ANA_STFLUX

#  define ANA_BTFLUX

#  define ANA_SCOPE

#  define AD_SENSITIVITY

#  define FORWARD_READ

#  define OUT_DOUBLE

# endif

#endif