cs_gwf_hydraulic_model.h

Go to the documentation of this file.

#ifndef CS_GWF_HYDRAULIC_MODEL_H
#define CS_GWF_HYDRAULIC_MODEL_H
 
/*============================================================================
 * Structures related to the hydraulic models available in the GWF module
 *============================================================================*/
 
/*
  This file is part of code_saturne, a general-purpose CFD tool.
 
  Copyright (C) 1998-2026 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 "base/cs_defs.h"
 
#include "cdo/cs_equation_system.h"
#include "alge/cs_param_sles.h"
 
/*============================================================================
 * Macro definitions
 *============================================================================*/
 
/*============================================================================
 * Type definitions
 *============================================================================*/
 
typedef struct _gwf_darcy_flux_t  cs_gwf_darcy_flux_t;
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
typedef void
(cs_gwf_darcy_update_t)(const cs_cdo_connect_t    *connect,
                        const cs_cdo_quantities_t *cdoq,
                        cs_real_t                  t_eval,
                        bool                       cur2prev,
                        cs_gwf_darcy_flux_t       *darcy);
 
/* ++++++++++++++++++++++++++++++++++++++++++++++ */
/* Saturated single-phase flows in a porous media */
/* ++++++++++++++++++++++++++++++++++++++++++++++ */
 
typedef struct {
 
  cs_equation_t                *richards;
 
  cs_gwf_darcy_flux_t          *darcy;
 
  cs_property_t                *moisture_content;
 
  cs_field_t                   *pressure_head;
 
} cs_gwf_sspf_t;
 
/* ++++++++++++++++++++++++++++++++++++++++++++++++ */
/* Unsaturated single-phase flows in a porous media */
/* ++++++++++++++++++++++++++++++++++++++++++++++++ */
 
typedef struct {
 
  cs_equation_t                *richards;
 
  cs_gwf_darcy_flux_t          *darcy;
 
  cs_property_t                *permeability;
  cs_property_t                *moisture_content;
  cs_property_t                *soil_capacity;
 
  cs_field_t                   *permeability_field;
  cs_field_t                   *moisture_field;
  cs_field_t                   *capacity_field;
  cs_field_t                   *pressure_head;
 
  cs_real_t                    *head_in_law;
 
} cs_gwf_uspf_t;
 
/* +++++++++++++++++++++++++++++++++ */
/* Two-phase flows in a porous media */
/* +++++++++++++++++++++++++++++++++ */
 
typedef enum {
 
  CS_GWF_TPF_SOLVER_PLPC_COUPLED,
  CS_GWF_TPF_SOLVER_PLPC_COUPLED_INCR,
 
  CS_GWF_TPF_N_SOLVERS
 
} cs_gwf_tpf_solver_type_t;
 
typedef enum {
 
  CS_GWF_TPF_APPROX_PC_CELL_AVERAGE,
  CS_GWF_TPF_APPROX_PC_CELL_VERTEX_AVERAGE,
  CS_GWF_TPF_APPROX_PC_EDGE_AVERAGE,
  CS_GWF_TPF_APPROX_PC_VERTEX_AVERAGE,
 
  CS_GWF_TPF_APPROX_VERTEX_SUBCELL,
 
  CS_GWF_TPF_N_APPROX
 
} cs_gwf_tpf_approx_type_t;
 
typedef struct {
 
  /* Set of equations associated to this modelling */
 
  cs_equation_t                *w_eq;
 
  cs_equation_t                *h_eq;
 
  cs_equation_param_t          *b01_w_eqp;
 
  cs_equation_param_t          *b10_h_eqp;
 
  cs_equation_system_t         *system;
 
  cs_gwf_darcy_flux_t          *l_darcy;
  cs_gwf_darcy_flux_t          *g_darcy;
 
  cs_property_t                *krl_pty;
  cs_property_t                *krg_pty;
  cs_property_t                *lsat_pty;
  cs_property_t                *lcap_pty;
 
  /* Properties associated to a discrete term in the system of equations
   *
   * \var time_wc_pty
   * Property related to the unsteady term of the water conservation equation
   * w.r.t. the capillary pressure
   *
   * \var diff_wl_pty
   * Property related to the diffusion term of the water conservation equation
   * w.r.t. the pressure in the liquid phase
   *
   * \var time_hc_pty
   * Property related to the unsteady term of the hydrogen conservation equation
   * w.r.t. the capillary pressure
   *
   * \var diff_hc_pty
   * Property related to the diffusion term of the hydrogen conservation
   * equation w.r.t. the capillary pressure
   *
   * \var time_hl_pty
   * Property related to the unsteady term of the hydrogen conservation equation
   * w.r.t. the pressure in the liquid phase.
   *
   * \var diff_hl_pty
   * Property related to the diffusion term of the hydrogen conservation
   * equation w.r.t. the pressure in the liquid phase
   *
   * \var diff_g_pty
   * Property used in the definition of the Darcy flux in the gas phase
   */
 
  cs_property_t                *time_wc_pty;
  cs_property_t                *diff_wl_pty;
 
  cs_property_t                *time_hc_pty;
  cs_property_t                *diff_hc_pty;
 
  cs_property_t                *time_hl_pty;
  cs_property_t                *diff_hl_pty;
 
  cs_property_t                *diff_g_pty;
 
  cs_field_t                   *c_pressure;
  cs_field_t                   *l_pressure;
  cs_field_t                   *g_pressure;
  cs_field_t                   *l_saturation;
  cs_field_t                   *l_rho_h;
  cs_field_t                   *g_rho_h;
 
  cs_real_t                    *srct_w_array;
  cs_real_t                    *srct_h_array;
  cs_real_t                    *lsat_pre_array;
 
  bool                          is_miscible;
 
  cs_real_t                     l_mass_density;
  cs_real_t                     l_viscosity;
  cs_real_t                     g_viscosity;
  cs_real_t                     l_diffusivity_h;
  cs_real_t                     h_molar_mass;
  cs_real_t                     ref_temperature;
  cs_real_t                     henry_constant;
 
  cs_gwf_tpf_solver_type_t       solver_type;
  bool                           enforce_pg_positivity;
  cs_gwf_tpf_approx_type_t       approx_type;
  double                         cell_weight;
  double                         upwind_weight;
 
  cs_param_nl_algo_t             nl_algo_type;
  int                            nl_algo_verbosity;
  cs_param_convergence_t         nl_cvg_param;
  cs_iter_algo_param_aac_t       anderson_param;
 
  cs_iter_algo_t                *nl_algo;
 
} cs_gwf_tpf_t;
 
 
typedef struct {
 
  int                           verbosity;
  cs_gwf_model_type_t           model;
  cs_flag_t                     flag;
  cs_flag_t                     post_flag;
 
  cs_property_t                *soil_porosity;
  cs_property_t                *abs_permeability;
 
  void                         *model_context;
 
} cs_gwf_t;
 
/*============================================================================
 * Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
 
#endif /* CS_GWF_HYDRAULIC_MODEL_H */