programmer's documentation
Typedefs | Functions
cs_cdo_advection.h File Reference
#include "cs_advection_field.h"
#include "cs_cdo.h"
#include "cs_cdo_connect.h"
#include "cs_cdo_local.h"
#include "cs_cdo_quantities.h"
#include "cs_equation_param.h"
#include "cs_param.h"
#include "cs_property.h"
Include dependency graph for cs_cdo_advection.h:

Go to the source code of this file.

Typedefs

typedef struct _cs_cdo_adv_t cs_cdo_adv_t
 

Functions

void cs_cdo_advection_set_cip_coef (double new_value)
 Set the value of the stabilization coefficient used in CIP scheme. More...
 
double cs_cdo_advection_get_cip_coef (void)
 Get the value of the stabilization coefficient used in CIP scheme. More...
 
cs_cdo_adv_tcs_cdo_advection_builder_init (const cs_cdo_connect_t *connect, const cs_equation_param_t *eqp, bool do_diffusion)
 Initialize a builder structure for the convection operator. More...
 
cs_cdo_adv_tcs_cdo_advection_builder_free (cs_cdo_adv_t *b)
 Destroy a builder structure for the convection operator. More...
 
cs_locmat_tcs_cdovb_advection_build (const cs_cell_mesh_t *cm, const cs_equation_param_t *eqp, const cs_real_33_t diffmat, cs_cdo_adv_t *b)
 Compute the convection operator attached to a cell with a CDO vertex-based scheme. More...
 
cs_locmat_tcs_cdovcb_advection_build (const cs_cell_mesh_t *cm, const cs_equation_param_t *eqp, cs_cdo_adv_t *b)
 Compute the convection operator attached to a cell with a CDO vertex+cell-based scheme. More...
 
void cs_cdovb_advection_add_bc (const cs_cell_mesh_t *cm, const cs_equation_param_t *eqp, cs_cdo_adv_t *b, cs_cdo_locsys_t *ls)
 Compute the BC contribution for the convection operator. More...
 
void cs_cdovcb_advection_add_bc (const cs_cell_mesh_t *cm, const cs_equation_param_t *eqp, cs_cdo_adv_t *b, cs_cdo_locsys_t *ls)
 Compute the BC contribution for the convection operator with CDO V+C schemes. More...
 
void cs_cdo_advection_get_upwind_coef_cell (const cs_cdo_quantities_t *cdoq, const cs_param_advection_t a_info, cs_real_t coefval[])
 Compute the value in each cell of the upwinding coefficient given a related Peclet number. More...
 

Typedef Documentation

◆ cs_cdo_adv_t

typedef struct _cs_cdo_adv_t cs_cdo_adv_t

Function Documentation

◆ cs_cdo_advection_builder_free()

cs_cdo_adv_t* cs_cdo_advection_builder_free ( cs_cdo_adv_t b)

Destroy a builder structure for the convection operator.

Parameters
[in,out]bpointer to a cs_cdo_adv_t struct. to free
Returns
a NULL pointer

◆ cs_cdo_advection_builder_init()

cs_cdo_adv_t* cs_cdo_advection_builder_init ( const cs_cdo_connect_t connect,
const cs_equation_param_t eqp,
bool  do_diffusion 
)

Initialize a builder structure for the convection operator.

Parameters
[in]connectpointer to the connectivity structure
[in]eqppointer to a cs_equation_param_t structure
[in]do_diffusiontrue is diffusion is activated
Returns
a pointer to a new allocated builder structure

◆ cs_cdo_advection_get_cip_coef()

double cs_cdo_advection_get_cip_coef ( void  )

Get the value of the stabilization coefficient used in CIP scheme.

Returns
the value the stabilization coefficient

◆ cs_cdo_advection_get_upwind_coef_cell()

void cs_cdo_advection_get_upwind_coef_cell ( const cs_cdo_quantities_t cdoq,
const cs_param_advection_t  a_info,
cs_real_t  coefval[] 
)

Compute the value in each cell of the upwinding coefficient given a related Peclet number.

Parameters
[in]cdoqpointer to the cdo quantities structure
[in,out]coefvalpointer to the pointer of real numbers to fill in: Peclet number in each cell out: value of the upwind coefficient
[in]cdoqpointer to the cdo quantities structure
[in]a_infoset of options for the advection term
[in,out]coefvalpointer to the pointer of real numbers to fill in: Peclet number in each cell out: value of the upwind coefficient

◆ cs_cdo_advection_set_cip_coef()

void cs_cdo_advection_set_cip_coef ( double  new_value)

Set the value of the stabilization coefficient used in CIP scheme.

Parameters
[in]new_valuevalue of the stabilization coefficient

◆ cs_cdovb_advection_add_bc()

void cs_cdovb_advection_add_bc ( const cs_cell_mesh_t cm,
const cs_equation_param_t eqp,
cs_cdo_adv_t b,
cs_cdo_locsys_t ls 
)

Compute the BC contribution for the convection operator.

Parameters
[in]cmpointer to a cs_cell_mesh_t structure
[in]eqppointer to a cs_equation_param_t structure
[in,out]bpointer to a convection builder structure
[in,out]lscell-wise structure sotring the local system

◆ cs_cdovb_advection_build()

cs_locmat_t* cs_cdovb_advection_build ( const cs_cell_mesh_t cm,
const cs_equation_param_t eqp,
const cs_real_33_t  diffmat,
cs_cdo_adv_t b 
)

Compute the convection operator attached to a cell with a CDO vertex-based scheme.

Parameters
[in]cmpointer to a cs_cell_mesh_t structure
[in]eqppointer to a cs_equation_param_t structure
[in]diffmattensor related to the diffusion property
[in,out]bpointer to a convection builder structure
Returns
a pointer to a local dense matrix structure

◆ cs_cdovcb_advection_add_bc()

void cs_cdovcb_advection_add_bc ( const cs_cell_mesh_t cm,
const cs_equation_param_t eqp,
cs_cdo_adv_t b,
cs_cdo_locsys_t ls 
)

Compute the BC contribution for the convection operator with CDO V+C schemes.

Parameters
[in]cmpointer to a cs_cell_mesh_t structure
[in]eqppointer to a cs_equation_param_t structure
[in,out]bpointer to a convection builder structure
[in,out]lscell-wise structure sotring the local system

◆ cs_cdovcb_advection_build()

cs_locmat_t* cs_cdovcb_advection_build ( const cs_cell_mesh_t cm,
const cs_equation_param_t eqp,
cs_cdo_adv_t b 
)

Compute the convection operator attached to a cell with a CDO vertex+cell-based scheme.

Parameters
[in]cmpointer to a cs_cell_mesh_t structure
[in]eqppointer to a cs_equation_param_t structure
[in,out]bpointer to a convection builder structure
Returns
a pointer to a local dense matrix structure