8.0
general documentation
cs_gwf_priv.c File Reference

Helper functions dedicated to groundwater flows when using CDO schemes. More...

#include "cs_defs.h"
#include <assert.h>
#include <stdlib.h>
#include <string.h>
#include <bft_mem.h>
#include "cs_advection_field.h"
#include "cs_array.h"
#include "cs_parall.h"
#include "cs_gwf_priv.h"
+ Include dependency graph for cs_gwf_priv.c:

Macros

#define CS_GWF_PRIV_DBG   0
 

Functions

cs_gwf_darcy_flux_tcs_gwf_darcy_flux_create (cs_flag_t loc_flag)
 Allocate and initialize a cs_gwf_darcy_flux_t structure. More...
 
void cs_gwf_darcy_flux_free (cs_gwf_darcy_flux_t **p_darcy)
 Free a cs_gwf_darcy_flux_t structure. More...
 
void cs_gwf_darcy_flux_log (cs_gwf_darcy_flux_t *darcy)
 Log a cs_gwf_darcy_flux_t structure. More...
 
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)
 Set the definition of the advection field attached to a cs_gwf_darcy_flux_t structure If the function pointer is set to NULL, then an automatic settings is done. More...
 
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)
 Operate the balance by zone (relying on the splitting arising from the boundary settings) for the advection field attached to a cs_gwf_darcy_flux_t structure. More...
 

Detailed Description

Helper functions dedicated to groundwater flows when using CDO schemes.

Macro Definition Documentation

◆ CS_GWF_PRIV_DBG

#define CS_GWF_PRIV_DBG   0

Function Documentation

◆ cs_gwf_darcy_flux_balance()

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 
)

Operate the balance by zone (relying on the splitting arising from the boundary settings) for the advection field attached to a cs_gwf_darcy_flux_t structure.

Parameters
[in]connectpointer to a cs_cdo_connect_t structure
[in]quantpointer to a cs_cdo_quantities_t structure
[in]eqppointer to the set of equation parameters
[in,out]darcypointer to the darcy structure

◆ cs_gwf_darcy_flux_create()

cs_gwf_darcy_flux_t* cs_gwf_darcy_flux_create ( cs_flag_t  loc_flag)

Allocate and initialize a cs_gwf_darcy_flux_t structure.

Parameters
[in]loc_flagflag to define where the flux is defined
Returns
a pointer to the newly allocated structure

◆ cs_gwf_darcy_flux_define()

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 
)

Set the definition of the advection field attached to a cs_gwf_darcy_flux_t structure If the function pointer is set to NULL, then an automatic settings is done.

Parameters
[in]connectpointer to a cs_cdo_connect_t structure
[in]quantpointer to a cs_cdo_quantities_t structure
[in]space_schemespace discretization using this structure
[in]update_contextpointer to the context for the update step
[in]update_funcpointer to an update function or NULL
[in,out]darcypointer to the darcy structure

◆ cs_gwf_darcy_flux_free()

void cs_gwf_darcy_flux_free ( cs_gwf_darcy_flux_t **  p_darcy)

Free a cs_gwf_darcy_flux_t structure.

Parameters
[in,out]p_darcypointer of pointer to the darcy structure

◆ cs_gwf_darcy_flux_log()

void cs_gwf_darcy_flux_log ( cs_gwf_darcy_flux_t darcy)

Log a cs_gwf_darcy_flux_t structure.

Parameters
[in,out]darcypointer to the darcy structure