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-2024 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.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_cdo_connect_t    *connect,
                        const cs_cdo_quantities_t *cdoq,
                        cs_real_t                  t_eval,
                        bool                       cur2prev,
                        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;
  bool                          simplified_boundary_update;
 
  cs_gwf_darcy_update_t        *update_func;
  void                         *update_input;
 
};
 
/*============================================================================
 * Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_gwf_get_value_pointers(const cs_equation_t  *eq,
                          cs_real_t           **p_dof_vals,
                          cs_real_t           **p_cell_vals);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
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);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_gwf_darcy_flux_update_on_boundary(const cs_equation_t       *eq,
                                     const cs_equation_param_t *eqp,
                                     const cs_property_t       *diff_pty,
                                     const cs_real_t           *dof_vals,
                                     const cs_real_t           *cell_vals,
                                     cs_real_t                  t_eval,
                                     cs_adv_field_t            *adv);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_gwf_darcy_flux_update_on_boundary_wo_eq(const cs_cdo_connect_t     *connect,
                                           const cs_cdo_quantities_t  *cdoq,
                                           cs_real_t                  *cell_vel,
                                           cs_adv_field_t             *adv);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_gwf_update_head(const cs_cdo_connect_t      *connect,
                   const cs_cdo_quantities_t   *cdoq,
                   const cs_equation_t         *richards,
                   cs_flag_t                    option_flag,
                   cs_field_t                  *pressure_head,
                   cs_real_t                    head_in_law[],
                   bool                         cur2prev);
 
/*----------------------------------------------------------------------------*/
 
END_C_DECLS
 
#endif /* __CS_GWF_PRIV_H__ */