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-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_base.h"
#include "cs_cdo_connect.h"
#include "cs_cdo_quantities.h"
#include "cs_gwf_param.h"
#include "cs_gwf_priv.h"
#include "cs_mesh.h"
#include "cs_property.h"
#include "cs_volume_zone.h"

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

BEGIN_C_DECLS

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

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

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

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

typedef struct {

  double             residual_moisture;

  double             n;
  double             m;
  double             scale;
  double             tortuosity;

} cs_gwf_soil_param_genuchten_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_by_id(int   id);

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

cs_gwf_soil_t *
cs_gwf_soil_by_name(const char    *name);

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

cs_real_t
cs_gwf_soil_get_saturated_moisture(int   soil_id);

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

int
cs_gwf_soil_get_permeability_max_dim(void);

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

bool
cs_gwf_soil_all_are_saturated(void);

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

void
cs_gwf_soil_check(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);

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

void
cs_gwf_build_cell2soil(cs_lnum_t    n_cells);

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

const short int *
cs_gwf_get_cell2soil(void);

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

void
cs_gwf_soil_free_all(void);

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

void
cs_gwf_soil_log_setup(void);

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

void
cs_gwf_soil_set_genuchten_param(cs_gwf_soil_t              *soil,
                                double                      theta_r,
                                double                      alpha,
                                double                      n,
                                double                      L);

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

void
cs_gwf_soil_set_user(cs_gwf_soil_t               *soil,
                     void                        *context,
                     cs_gwf_soil_update_t        *update_func,
                     cs_gwf_soil_free_param_t    *free_param_func);

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

void
cs_gwf_soil_set_shared_properties(cs_property_t      *abs_permeability,
                                  cs_property_t      *soil_porosity);

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

void
cs_gwf_soil_saturated_set_property(cs_property_t   *moisture_content);

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

void
cs_gwf_soil_tpf_set_property(cs_gwf_two_phase_t     *mc);

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

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    *quant);

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

void
cs_gwf_soil_iso_update_mtpf_terms(cs_gwf_two_phase_t    *mc);

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

void
cs_gwf_soil_iso_update_itpf_terms(cs_gwf_two_phase_t     *mc);

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

void
cs_gwf_soil_iso_update_itpf_terms_incr(const cs_time_step_t    *ts,
                                       cs_gwf_two_phase_t      *mc);

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

void
cs_gwf_soil_iso_update_itpf_terms_incr_submesh(const cs_time_step_t    *ts,
                                               const cs_cdo_connect_t  *connect,
                                               cs_gwf_two_phase_t      *mc);

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

END_C_DECLS

#endif /* __CS_GWF_SOIL_H__ */