cs_gwf_soil.h

Go to the documentation of this file.

#ifndef CS_GWF_SOIL_H
#define CS_GWF_SOIL_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-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_base.h"
#include "cdo/cs_cdo_connect.h"
#include "cdo/cs_cdo_quantities.h"
#include "gwf/cs_gwf_param.h"
#include "gwf/cs_gwf_hydraulic_model.h"
#include "mesh/cs_mesh.h"
#include "cdo/cs_property.h"
#include "base/cs_volume_zone.h"
 
/*============================================================================
 * Macro definitions
 *============================================================================*/
 
/*============================================================================
 * Public function pointer prototypes
 *============================================================================*/
 
typedef struct _gwf_soil_vgm_tpf_param_t  cs_gwf_soil_vgm_tpf_param_t;
typedef struct _gwf_soil_t cs_gwf_soil_t;
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
typedef void
(cs_gwf_soil_update_t) (const cs_real_t              t_eval,
                        const cs_mesh_t             *mesh,
                        const cs_cdo_connect_t      *connect,
                        const cs_cdo_quantities_t   *quant,
                        const cs_zone_t             *zone,
                        cs_gwf_soil_t               *soil);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
typedef void
(cs_gwf_soil_free_param_t)(void         **p_param);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
typedef void
(cs_gwf_soil_tpf_eval_t)(const cs_gwf_soil_vgm_tpf_param_t    *sp,
                         const double                          pc,
                         double                               *sl,
                         double                               *dsldpc,
                         double                               *krl,
                         double                               *krg);
 
/*============================================================================
 * Type definitions
 *============================================================================*/
 
typedef enum {
 
  CS_GWF_SOIL_JOIN_NOTHING,
  CS_GWF_SOIL_JOIN_C1_HYPERBOLIC,
  CS_GWF_SOIL_JOIN_C1_EXPONENTIAL,
  CS_GWF_SOIL_JOIN_C1_POLY_ORDER2,
 
  CS_GWF_SOIL_N_JOINS
 
} cs_gwf_soil_join_type_t;
 
typedef enum {
 
  CS_GWF_SOIL_STATE_SATURATED    = 0,
  CS_GWF_SOIL_STATE_UNSATURATED  = 1,
  CS_GWF_SOIL_STATE_DRY          = 2,
 
  CS_GWF_SOIL_N_STATES           = 3,
 
} cs_gwf_soil_state_t;
 
typedef struct {
 
  double             residual_moisture;
 
  double             n;
  double             m;
  double             scale;
  double             tortuosity;
 
} cs_gwf_soil_vgm_spf_param_t;
 
struct _gwf_soil_vgm_tpf_param_t {
 
  double       n;
  double       m;
  double       inv_m;
  double       pr_r;
  double       inv_pr_r;
  double       sl_r;
  double       sl_s;
  double       sl_range;
 
  cs_gwf_soil_join_type_t    sle_jtype;
  cs_gwf_soil_join_type_t    kr_jtype;
  double                     sle_thres;
 
  /* Function pointer */
 
  cs_gwf_soil_tpf_eval_t    *eval_properties;
 
  /* Derived quantities */
 
  double                     pc_star;
  double                     dsldpc_star;
  double                     sle_alpha;
  double                     sle_beta;
 
  double                     krg_star;
  double                     dkrgdsl_star;
  double                     krg_alpha;
 
  double                     krl_star;
  double                     dkrldsl_star;
  double                     krl_alpha;
 
};
 
typedef struct _gwf_soil_vgm_tpf_param_t cs_gwf_soil_vgm_tpf_param_t;
 
struct _gwf_soil_t {
 
  int                             id;
  int                             zone_id;
 
  cs_gwf_model_type_t             hydraulic_model;
  void                           *hydraulic_context;
 
 
  double                          bulk_density;
  double                          porosity;
  int                             abs_permeability_dim;
  double                          abs_permeability[3][3];
 
  cs_gwf_soil_model_t             model;
  void                           *model_param;
 
  /* Pointers to functions */
 
  cs_gwf_soil_update_t           *update_properties;
  cs_gwf_soil_free_param_t       *free_model_param;
 
};
 
/*============================================================================
 * User-defined function prototypes
 *============================================================================*/
 
/*============================================================================
 * Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
int
cs_gwf_get_n_soils(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_gwf_soil_t *
cs_gwf_soil_create(const cs_zone_t                 *zone,
                   cs_gwf_model_type_t              hydraulic_model,
                   cs_gwf_soil_model_t              model,
                   cs_property_type_t               perm_type,
                   double                           k_abs[3][3],
                   double                           porosity,
                   double                           bulk_density,
                   void                            *hydraulic_context);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_gwf_soil_t *
cs_gwf_soil_by_id(int   id);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_gwf_soil_t *
cs_gwf_soil_by_name(const char    *name);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
const cs_zone_t *
cs_gwf_soil_get_zone(int   soil_id);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_gwf_soil_free_all(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_gwf_soil_finalize_setup(cs_gwf_model_type_t    gwf_model,
                           cs_flag_t              post_flag,
                           cs_lnum_t              n_cells);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_gwf_soil_log_setup(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_gwf_soil_update(cs_real_t                     time_eval,
                   const cs_mesh_t              *mesh,
                   const cs_cdo_connect_t       *connect,
                   const cs_cdo_quantities_t    *cdoq);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_gwf_soil_update_soil_state(cs_lnum_t            n_cells,
                              const cs_real_t     *sliq);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_gwf_soil_define_shared_properties(cs_property_t   *abs_permeability,
                                     cs_property_t   *soil_porosity);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_gwf_soil_define_sspf_property(cs_property_t   *moisture_content);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_gwf_soil_build_dual_porous_volume(const cs_cdo_quantities_t    *cdoq,
                                     const cs_cdo_connect_t       *connect);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
const double *
cs_gwf_soil_get_dual_porous_volume(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
const short int *
cs_gwf_soil_get_cell2soil(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
const int *
cs_gwf_soil_get_soil_state(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_real_t
cs_gwf_soil_get_porosity(int   soil_id);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
cs_real_t
cs_gwf_soil_get_saturated_moisture(int   soil_id);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
int
cs_gwf_soil_get_permeability_max_dim(void);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_gwf_soil_set_vgm_spf_param(cs_gwf_soil_t         *soil,
                              double                 theta_r,
                              double                 alpha,
                              double                 n,
                              double                 L);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_gwf_soil_set_vgm_tpf_param(cs_gwf_soil_t         *soil,
                              double                 n,
                              double                 pr_r,
                              double                 sl_r,
                              double                 sl_s);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_gwf_soil_set_vgm_tpf_advanced_param(cs_gwf_soil_t             *soil,
                                       cs_gwf_soil_join_type_t    sle_jtype,
                                       cs_gwf_soil_join_type_t    kr_jtype,
                                       double                     sle_thres);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_gwf_soil_set_user_model_param(cs_gwf_soil_t               *soil,
                                 void                        *param,
                                 cs_gwf_soil_update_t        *update_func,
                                 cs_gwf_soil_free_param_t    *free_param_func);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_gwf_soil_set_joining_poly_order(int    order);
 
/*----------------------------------------------------------------------------*/
 
#endif /* CS_GWF_SOIL_H */