cs_gwf_priv.h

Go to the documentation of this file.

#ifndef __CS_GWF_PRIV_H__
#define __CS_GWF_PRIV_H__

/*============================================================================
 * Structures/types related to the groundwater flow module
 *============================================================================*/

/*
  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_equation_system.h"
#include "cs_gwf_param.h"

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

BEGIN_C_DECLS

/*============================================================================
 * Macro definitions
 *============================================================================*/

/*============================================================================
 * Type definitions
 *============================================================================*/

typedef struct _gwf_darcy_flux_t  cs_gwf_darcy_flux_t;

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

typedef void
(cs_gwf_darcy_update_t)(const cs_real_t              t_eval,
                        const cs_equation_t         *eq,
                        bool                         cur2prev,
                        void                        *input,
                        cs_gwf_darcy_flux_t         *darcy);

struct _gwf_darcy_flux_t {

  cs_adv_field_t               *adv_field;
  cs_flag_t                     flux_location;
  cs_real_t                    *flux_val;
  cs_real_t                    *boundary_flux_val;

  void                         *update_input;
  cs_gwf_darcy_update_t        *update_func;

};


typedef struct {

  cs_equation_t                *richards;

  cs_gwf_darcy_flux_t          *darcy;

  cs_property_t                *moisture_content;

  cs_field_t                   *permeability_field;
  cs_field_t                   *pressure_head;

} cs_gwf_saturated_single_phase_t;

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_unsaturated_single_phase_t;

typedef struct {

  /* Set of equations associated to this modelling */

  cs_equation_t                *wl_eq;

  cs_equation_t                *hg_eq;

  cs_equation_param_t          *wg_eqp;

  cs_equation_param_t          *hl_eqp;

  cs_equation_system_t         *system;

  cs_gwf_darcy_flux_t          *l_darcy;
  cs_gwf_darcy_flux_t          *g_darcy;

  cs_property_t                *time_wl_pty;
  cs_property_t                *diff_wl_pty;

  cs_property_t                *time_wg_pty;

  cs_property_t                *time_hg_pty;
  cs_property_t                *diff_hg_pty;
  cs_property_t                *reac_hg_pty;

  cs_property_t                *time_hl_pty;
  cs_property_t                *diff_hl_pty;

  cs_field_t                   *l_saturation;
  cs_field_t                   *c_pressure;
  cs_field_t                   *l_pressure;
  cs_field_t                   *g_pressure;

  cs_real_t                    *time_wl_array;
  cs_real_t                    *diff_wl_array;
  cs_real_t                    *srct_wl_array;

  cs_real_t                    *time_wg_array;

  cs_real_t                    *time_hg_array;
  cs_real_t                    *diff_hg_array;
  cs_real_t                    *reac_hg_array;
  cs_real_t                    *srct_hg_array;

  cs_real_t                    *time_hl_array;
  cs_real_t                    *diff_hl_array;

  cs_real_t                    *l_rel_permeability;
  cs_real_t                    *g_rel_permeability;

  /* These arrays are not always allocated. It depends on the numerical
     settings */

  cs_real_t                    *l_capacity;
  cs_real_t                    *capillarity_cell_pressure;
  cs_real_t                    *g_cell_pressure;
  cs_real_t                    *l_saturation_submesh;
  cs_real_t                    *l_saturation_submesh_pre;

  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                     w_molar_mass;
  cs_real_t                     h_molar_mass;
  cs_real_t                     ref_temperature;
  cs_real_t                     henry_constant;

  bool                           use_coupled_solver;
  bool                           use_incremental_solver;
  bool                           use_properties_on_submesh;
  bool                           use_explicit_dsldt_liquid;

  cs_param_nl_algo_t             nl_algo_type;
  cs_iter_algo_param_t           nl_algo_param;
  cs_iter_algo_param_aa_t        anderson_param;

  cs_iter_algo_t                *nl_algo;

} cs_gwf_two_phase_t;


typedef struct {

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

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

cs_gwf_darcy_flux_t *
cs_gwf_darcy_flux_create(cs_flag_t         loc_flag);

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

void
cs_gwf_darcy_flux_free(cs_gwf_darcy_flux_t  **p_darcy);

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

void
cs_gwf_darcy_flux_log(cs_gwf_darcy_flux_t    *darcy);

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

void
cs_gwf_darcy_flux_define(const cs_cdo_connect_t       *connect,
                         const cs_cdo_quantities_t    *quant,
                         cs_param_space_scheme_t       space_scheme,
                         void                         *update_context,
                         cs_gwf_darcy_update_t        *update_func,
                         cs_gwf_darcy_flux_t          *darcy);

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

void
cs_gwf_darcy_flux_balance(const cs_cdo_connect_t       *connect,
                          const cs_cdo_quantities_t    *quant,
                          const cs_equation_param_t    *eqp,
                          cs_gwf_darcy_flux_t          *darcy);

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

END_C_DECLS

#endif /* __CS_GWF_PRIV_H__ */