cs_gwf_tracer.h

Go to the documentation of this file.

#ifndef __CS_GWF_TRACER_H__
#define __CS_GWF_TRACER_H__

/*============================================================================
 * Set of main functions to handle soils in the groundwater flow module
 * when using CDO schemes
 *============================================================================*/

/*
  This file is part of code_saturne, a general-purpose CFD tool.

  Copyright (C) 1998-2022 EDF S.A.

  This program is free software; you can redistribute it and/or modify it under
  the terms of the GNU General Public License as published by the Free Software
  Foundation; either version 2 of the License, or (at your option) any later
  version.

  This program is distributed in the hope that it will be useful, but WITHOUT
  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  details.

  You should have received a copy of the GNU General Public License along with
  this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
  Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/

/*----------------------------------------------------------------------------*/

/*----------------------------------------------------------------------------
 *  Local headers
 *----------------------------------------------------------------------------*/

#include "cs_advection_field.h"
#include "cs_base.h"
#include "cs_equation.h"
#include "cs_gwf_param.h"

/*----------------------------------------------------------------------------*/

BEGIN_C_DECLS

/*============================================================================
 * Typedef definition
 *============================================================================*/

typedef struct _gwf_tracer_t  cs_gwf_tracer_t;

/*============================================================================
 * Public function pointer prototypes
 *============================================================================*/

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

typedef void
(cs_gwf_tracer_init_setup_t) (cs_gwf_tracer_t             *tracer);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

typedef void
(cs_gwf_tracer_finalize_setup_t) (const cs_cdo_connect_t      *connect,
                                  const cs_cdo_quantities_t   *quant,
                                  const cs_adv_field_t        *adv,
                                  cs_gwf_tracer_t             *tracer);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

typedef void
(cs_gwf_tracer_update_t) (cs_gwf_tracer_t             *tracer,
                          cs_real_t                    t_eval,
                          const cs_mesh_t             *mesh,
                          const cs_cdo_connect_t      *connect,
                          const cs_cdo_quantities_t   *quant);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

typedef void
(cs_gwf_tracer_free_context_t) (cs_gwf_tracer_t      *tracer);

/*============================================================================
 * Structure definitions
 *============================================================================*/

/* Set of parameters related to a tracer equation attached to a standard
   modelling */

typedef struct {

  /* Parameters to determine the behavior in each soil
   * (array of size: n_soils)
   */

  /* Common settings shared by all physical modelling */
  /* ------------------------------------------------ */

  double    *rho_bulk;      /* bulk density (kg.m^-3) */
  double    *kd0;           /* reference value of the distribution coefficient
                               (m^".kg^-1) */
  double    *rho_kd;        /* Derived quantity: rho_bulk*kd0 */

  double    *alpha_l;       /* Longitudinal dispersivity */
  double    *alpha_t;       /* Transversal dispersivity */

  double    *wmd;           /* Water molecular diffusivity (m^2.s^-1) */

  double    *reaction_rate; /* First order decay coefficient (related to the
                               reaction term) */

  /* Precipitation members (set to NULL if not used) */
  /* ----------------------------------------------- */

  double       *conc_w_star;    /* maximal value of the concentraction of tracer
                                   in the liquid phase. Exceeded quantities are
                                   stored in the solid phase (->
                                   conc_precip). These values corresponds to the
                                   user settings */

  cs_real_t    *conc_satura;    /* array storing the value of the saturated
                                   concentration in the liquid phase at vertices
                                   (only used in case of CDOVB schemes or CDOVCB
                                   schemes */
  cs_real_t    *conc_precip;    /* array storing the concentration in the
                                   precipitation (solid) storage. The size may
                                   vary w.r.t. to the discrtization scheme.
                                */

  cs_field_t   *precip_field;

  /* Sorption members (set to NULL if not used) */
  /* ------------------------------------------ */

  double       *k0_plus;        /* kinetic coefficient towards site 2 locations
                                   (m^3.kg^-1.s^-1) */
  double       *k0_minus;       /* kinetic coefficient from site 2 locations
                                   (s^-1) */

  cs_real_t    *conc_site2;     /* array allocated to n_cells */

  /* Variables used for the update of physical properties (shared pointers) */

  const cs_field_t  *darcy_velocity_field;

} cs_gwf_tracer_default_context_t;


/* Set of parameters describing a tracer structure */
/* ----------------------------------------------- */

struct _gwf_tracer_t{

  cs_gwf_model_type_t          hydraulic_model;

  /* Physical modelling adopted for this tracer */

  cs_gwf_tracer_model_t        model;

  cs_field_t                  *diffusivity; /* NULL if no diffusion term is
                                               build in the tracer equation */
  int                          reaction_id; /* id related to the reaction
                                               term in the tracer equation */

  cs_equation_t                  *equation;

  /* Pointer to a context structure according to the model */

  void                           *context;

  /* Pointers to functions */

  cs_gwf_tracer_update_t           *update_diff_tensor;
  cs_gwf_tracer_update_t           *update_precipitation;
  cs_gwf_tracer_finalize_setup_t   *finalize_setup;
  cs_gwf_tracer_init_setup_t       *init_setup;
  cs_gwf_tracer_free_context_t     *free_context;

};

/*============================================================================
 * Public function prototypes
 *============================================================================*/

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

cs_gwf_tracer_t *
cs_gwf_tracer_by_name(const char   *eq_name);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

cs_gwf_tracer_t *
cs_gwf_tracer_add(cs_gwf_tracer_model_t            tr_model,
                  cs_gwf_model_type_t              gwf_model,
                  const char                      *eq_name,
                  const char                      *var_name,
                  cs_adv_field_t                  *adv_field,
                  cs_gwf_tracer_init_setup_t      *init_setup,
                  cs_gwf_tracer_finalize_setup_t  *finalize_setup);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

void
cs_gwf_tracer_free_all(void);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

cs_real_t
cs_gwf_tracer_get_time_theta_max(void);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

void
cs_gwf_tracer_set_main_param(cs_gwf_tracer_t   *tracer,
                             const char        *soil_name,
                             double             wmd,
                             double             alpha_l,
                             double             alpha_t,
                             double             distrib_coef,
                             double             reaction_rate);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

void
cs_gwf_tracer_set_precip_param(cs_gwf_tracer_t   *tracer,
                               const char        *soil_name,
                               double             conc_w_star);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

void
cs_gwf_tracer_init_setup(void);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

void
cs_gwf_tracer_finalize_setup(const cs_cdo_connect_t      *connect,
                             const cs_cdo_quantities_t   *quant);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

void
cs_gwf_tracer_update_diff_tensor(cs_real_t                    t_eval,
                                 const cs_mesh_t             *mesh,
                                 const cs_cdo_connect_t      *connect,
                                 const cs_cdo_quantities_t   *quant);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

void
cs_gwf_tracer_log_all(void);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

void
cs_gwf_tracer_compute_steady_all(const cs_mesh_t              *mesh,
                                 const cs_time_step_t         *time_step,
                                 const cs_cdo_connect_t       *connect,
                                 const cs_cdo_quantities_t    *cdoq);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

void
cs_gwf_tracer_compute_all(const cs_mesh_t              *mesh,
                          const cs_time_step_t         *time_step,
                          const cs_cdo_connect_t       *connect,
                          const cs_cdo_quantities_t    *cdoq);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

void
cs_gwf_tracer_default_init_setup(cs_gwf_tracer_t     *tracer);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

void
cs_gwf_tracer_sat_finalize_setup(const cs_cdo_connect_t      *connect,
                                 const cs_cdo_quantities_t   *quant,
                                 const cs_adv_field_t        *adv,
                                 cs_gwf_tracer_t             *tracer);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

void
cs_gwf_tracer_unsat_finalize_setup(const cs_cdo_connect_t      *connect,
                                   const cs_cdo_quantities_t   *quant,
                                   const cs_adv_field_t        *adv,
                                   cs_gwf_tracer_t             *tracer);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

cs_real_t
cs_gwf_tracer_integrate(const cs_cdo_connect_t     *connect,
                        const cs_cdo_quantities_t  *cdoq,
                        const cs_gwf_tracer_t      *tracer,
                        const char                 *z_name);

/*----------------------------------------------------------------------------*/

END_C_DECLS

#endif /* __CS_GWF_TRACER_H__ */