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 void() cs_cdo_advection_t(const cs_equation_param_t *eqp, const cs_cell_mesh_t *cm, cs_face_mesh_t *fm, cs_cell_builder_t *cb)
 Compute the convection operator attached to a cell with a CDO vertex-based scheme. The local matrix related ti this operator is stored in cb->loc. More...
 
typedef void() cs_cdo_advection_bc_t(const cs_cell_bc_t *cbc, const cs_cell_mesh_t *cm, const cs_equation_param_t *eqp, cs_face_mesh_t *fm, cs_cell_builder_t *cb, cs_cell_sys_t *csys)
 Compute the BC contribution for the advection operator. More...
 

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...
 
void cs_cdo_advection_get_vb_upwcsvdi (const cs_equation_param_t *eqp, const cs_cell_mesh_t *cm, cs_face_mesh_t *fm, cs_cell_builder_t *cb)
 Compute the convection operator attached to a cell with a CDO vertex-based scheme when diffusion is activated and an upwind scheme and a conservative formulation is used The local matrix related to this operator is stored in cb->loc. More...
 
void cs_cdo_advection_get_vb_upwcsv (const cs_equation_param_t *eqp, const cs_cell_mesh_t *cm, cs_face_mesh_t *fm, cs_cell_builder_t *cb)
 Compute the convection operator attached to a cell with a CDO vertex-based scheme without diffusion and an upwind scheme and a conservative formulation is used. The local matrix related to this operator is stored in cb->loc. More...
 
void cs_cdo_advection_get_vb_cencsv (const cs_equation_param_t *eqp, const cs_cell_mesh_t *cm, cs_face_mesh_t *fm, cs_cell_builder_t *cb)
 Compute the convection operator attached to a cell with a CDO vertex-based scheme when a centered scheme and a conservative formulation is used. The local matrix related to this operator is stored in cb->loc. More...
 
void cs_cdo_advection_get_vb_upwnocdi (const cs_equation_param_t *eqp, const cs_cell_mesh_t *cm, cs_face_mesh_t *fm, cs_cell_builder_t *cb)
 Compute the convection operator attached to a cell with a CDO vertex-based scheme when diffusion is activated and an upwind scheme and a conservative formulation is used The local matrix related to this operator is stored in cb->loc. More...
 
void cs_cdo_advection_get_vb_upwnoc (const cs_equation_param_t *eqp, const cs_cell_mesh_t *cm, cs_face_mesh_t *fm, cs_cell_builder_t *cb)
 Compute the convection operator attached to a cell with a CDO vertex-based scheme without diffusion when an upwind scheme and a conservative formulation is used. The local matrix related to this operator is stored in cb->loc. More...
 
void cs_cdo_advection_get_vb_cennoc (const cs_equation_param_t *eqp, const cs_cell_mesh_t *cm, cs_face_mesh_t *fm, cs_cell_builder_t *cb)
 Compute the convection operator attached to a cell with a CDO vertex-based scheme when a centered scheme and a non-conservative formulation is used. The local matrix related to this operator is stored in cb->loc. More...
 
void cs_cdo_advection_get_vcb_cw (const cs_equation_param_t *eqp, const cs_cell_mesh_t *cm, cs_face_mesh_t *fm, cs_cell_builder_t *cb)
 Compute the convection operator attached to a cell with a CDO vertex+cell-based scheme when the advection field is cellwise constant. More...
 
void cs_cdo_advection_get_vcb (const cs_equation_param_t *eqp, const cs_cell_mesh_t *cm, cs_face_mesh_t *fm, cs_cell_builder_t *cb)
 Compute the convection operator attached to a cell with a CDO vertex+cell-based scheme. More...
 
void cs_cdo_advection_add_vb_bc_cw (const cs_cell_bc_t *cbc, const cs_cell_mesh_t *cm, const cs_equation_param_t *eqp, cs_face_mesh_t *fm, cs_cell_builder_t *cb, cs_cell_sys_t *csys)
 Compute the BC contribution for the convection operator when the advection field is approximated in each cell by a constant vector field. More...
 
void cs_cdo_advection_add_vb_bc (const cs_cell_bc_t *cbc, const cs_cell_mesh_t *cm, const cs_equation_param_t *eqp, cs_face_mesh_t *fm, cs_cell_builder_t *cb, cs_cell_sys_t *csys)
 Compute the BC contribution for the convection operator when the convection field is not uniform inside a cell. More...
 
void cs_cdo_advection_add_vcb_bc_cw (const cs_cell_bc_t *cbc, const cs_cell_mesh_t *cm, const cs_equation_param_t *eqp, cs_face_mesh_t *fm, cs_cell_builder_t *cb, cs_cell_sys_t *csys)
 Compute the BC contribution for the convection operator with CDO V+C schemes when the advection field is cellwise constant. More...
 
void cs_cdo_advection_add_vcb_bc (const cs_cell_bc_t *cbc, const cs_cell_mesh_t *cm, const cs_equation_param_t *eqp, cs_face_mesh_t *fm, cs_cell_builder_t *cb, cs_cell_sys_t *csys)
 Compute the BC contribution for the convection operator with CDO V+C schemes. More...
 
void cs_cdo_advection_add_vcb_bc_analytic (const cs_cell_bc_t *cbc, const cs_cell_mesh_t *cm, const cs_equation_param_t *eqp, cs_face_mesh_t *fm, cs_cell_builder_t *cb, cs_cell_sys_t *csys)
 Compute the BC contribution for the convection operator with CDO V+C schemes when the advection is defined by an analytic function. 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_advection_bc_t

typedef void() cs_cdo_advection_bc_t(const cs_cell_bc_t *cbc, const cs_cell_mesh_t *cm, const cs_equation_param_t *eqp, cs_face_mesh_t *fm, cs_cell_builder_t *cb, cs_cell_sys_t *csys)

Compute the BC contribution for the advection operator.

Parameters
[in]cbcpointer to a cs_cell_bc_t structure
[in]cmpointer to a cs_cell_mesh_t structure
[in]eqppointer to a cs_equation_param_t structure
[in,out]fmpointer to a cs_face_mesh_t structure
[in,out]bpointer to a convection builder structure
[in,out]csyscell-wise structure storing the local system

◆ cs_cdo_advection_t

typedef void() cs_cdo_advection_t(const cs_equation_param_t *eqp, const cs_cell_mesh_t *cm, cs_face_mesh_t *fm, cs_cell_builder_t *cb)

Compute the convection operator attached to a cell with a CDO vertex-based scheme. The local matrix related ti this operator is stored in cb->loc.

Parameters
[in]eqppointer to a cs_equation_param_t structure
[in]cmpointer to a cs_cell_mesh_t structure
[in]fmpointer to a cs_face_mesh_t structure
[in,out]cbpointer to a cs_cell_builder_t structure

Function Documentation

◆ cs_cdo_advection_add_vb_bc()

void cs_cdo_advection_add_vb_bc ( const cs_cell_bc_t cbc,
const cs_cell_mesh_t cm,
const cs_equation_param_t eqp,
cs_face_mesh_t fm,
cs_cell_builder_t cb,
cs_cell_sys_t csys 
)

Compute the BC contribution for the convection operator when the convection field is not uniform inside a cell.

Parameters
[in]cbcpointer to a cs_cell_bc_t structure
[in]cmpointer to a cs_cell_mesh_t structure
[in]eqppointer to a cs_equation_param_t structure
[in,out]fmpointer to a cs_face_mesh_t structure
[in,out]cbpointer to a convection builder structure
[in,out]csyscell-wise structure storing the local system

◆ cs_cdo_advection_add_vb_bc_cw()

void cs_cdo_advection_add_vb_bc_cw ( const cs_cell_bc_t cbc,
const cs_cell_mesh_t cm,
const cs_equation_param_t eqp,
cs_face_mesh_t fm,
cs_cell_builder_t cb,
cs_cell_sys_t csys 
)

Compute the BC contribution for the convection operator when the advection field is approximated in each cell by a constant vector field.

Parameters
[in]eqppointer to a cs_equation_param_t structure
[in]cbcpointer to a cs_cell_bc_t structure
[in]cmpointer to a cs_cell_mesh_t structure
[in,out]fmpointer to a cs_face_mesh_t structure
[in,out]bpointer to a convection builder structure
[in,out]csyscell-wise structure storing the local system
[in]cbcpointer to a cs_cell_bc_t structure
[in]cmpointer to a cs_cell_mesh_t structure
[in]eqppointer to a cs_equation_param_t structure
[in,out]fmpointer to a cs_face_mesh_t structure
[in,out]cbpointer to a convection builder structure
[in,out]csyscell-wise structure storing the local system

◆ cs_cdo_advection_add_vcb_bc()

void cs_cdo_advection_add_vcb_bc ( const cs_cell_bc_t cbc,
const cs_cell_mesh_t cm,
const cs_equation_param_t eqp,
cs_face_mesh_t fm,
cs_cell_builder_t cb,
cs_cell_sys_t csys 
)

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

Parameters
[in]cbcpointer to a cs_cell_bc_t structure
[in]cmpointer to a cs_cell_mesh_t structure
[in]eqppointer to a cs_equation_param_t structure
[in,out]fmpointer to a cs_face_mesh_t structure
[in,out]cbpointer to a cs_cell_builder_t structure
[in,out]csyscell-wise structure storing the local system

◆ cs_cdo_advection_add_vcb_bc_analytic()

void cs_cdo_advection_add_vcb_bc_analytic ( const cs_cell_bc_t cbc,
const cs_cell_mesh_t cm,
const cs_equation_param_t eqp,
cs_face_mesh_t fm,
cs_cell_builder_t cb,
cs_cell_sys_t csys 
)

Compute the BC contribution for the convection operator with CDO V+C schemes when the advection is defined by an analytic function.

Parameters
[in]cbcpointer to a cs_cell_bc_t structure
[in]cmpointer to a cs_cell_mesh_t structure
[in]eqppointer to a cs_equation_param_t structure
[in,out]fmpointer to a cs_face_mesh_t structure
[in,out]cbpointer to a cs_cell_builder_t structure
[in,out]csyscell-wise structure storing the local system

◆ cs_cdo_advection_add_vcb_bc_cw()

void cs_cdo_advection_add_vcb_bc_cw ( const cs_cell_bc_t cbc,
const cs_cell_mesh_t cm,
const cs_equation_param_t eqp,
cs_face_mesh_t fm,
cs_cell_builder_t cb,
cs_cell_sys_t csys 
)

Compute the BC contribution for the convection operator with CDO V+C schemes when the advection field is cellwise constant.

Parameters
[in]cbcpointer to a cs_cell_bc_t structure
[in]cmpointer to a cs_cell_mesh_t structure
[in]eqppointer to a cs_equation_param_t structure
[in,out]fmpointer to a cs_face_mesh_t structure
[in,out]cbpointer to a cs_cell_builder_t structure
[in,out]csyscell-wise structure storing the local system

◆ 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]coefvalarray of real numbers to fill (in) Peclet number in each cell (out) value of the upwind coefficient

◆ cs_cdo_advection_get_vb_cencsv()

void cs_cdo_advection_get_vb_cencsv ( const cs_equation_param_t eqp,
const cs_cell_mesh_t cm,
cs_face_mesh_t fm,
cs_cell_builder_t cb 
)

Compute the convection operator attached to a cell with a CDO vertex-based scheme when a centered scheme and a conservative formulation is used. The local matrix related to this operator is stored in cb->loc.

Parameters
[in]eqppointer to a cs_equation_param_t structure
[in]cmpointer to a cs_cell_mesh_t structure
[in]fmpointer to a cs_face_mesh_t structure
[in,out]cbpointer to a cs_cell_builder_t structure

◆ cs_cdo_advection_get_vb_cennoc()

void cs_cdo_advection_get_vb_cennoc ( const cs_equation_param_t eqp,
const cs_cell_mesh_t cm,
cs_face_mesh_t fm,
cs_cell_builder_t cb 
)

Compute the convection operator attached to a cell with a CDO vertex-based scheme when a centered scheme and a non-conservative formulation is used. The local matrix related to this operator is stored in cb->loc.

Parameters
[in]eqppointer to a cs_equation_param_t structure
[in]cmpointer to a cs_cell_mesh_t structure
[in]fmpointer to a cs_face_mesh_t structure
[in,out]cbpointer to a cs_cell_builder_t structure

◆ cs_cdo_advection_get_vb_upwcsv()

void cs_cdo_advection_get_vb_upwcsv ( const cs_equation_param_t eqp,
const cs_cell_mesh_t cm,
cs_face_mesh_t fm,
cs_cell_builder_t cb 
)

Compute the convection operator attached to a cell with a CDO vertex-based scheme without diffusion and an upwind scheme and a conservative formulation is used. The local matrix related to this operator is stored in cb->loc.

Parameters
[in]eqppointer to a cs_equation_param_t structure
[in]cmpointer to a cs_cell_mesh_t structure
[in]fmpointer to a cs_face_mesh_t structure
[in,out]cbpointer to a cs_cell_builder_t structure

◆ cs_cdo_advection_get_vb_upwcsvdi()

void cs_cdo_advection_get_vb_upwcsvdi ( const cs_equation_param_t eqp,
const cs_cell_mesh_t cm,
cs_face_mesh_t fm,
cs_cell_builder_t cb 
)

Compute the convection operator attached to a cell with a CDO vertex-based scheme when diffusion is activated and an upwind scheme and a conservative formulation is used The local matrix related to this operator is stored in cb->loc.

Parameters
[in]eqppointer to a cs_equation_param_t structure
[in]cmpointer to a cs_cell_mesh_t structure
[in]fmpointer to a cs_face_mesh_t structure
[in,out]cbpointer to a cs_cell_builder_t structure

◆ cs_cdo_advection_get_vb_upwnoc()

void cs_cdo_advection_get_vb_upwnoc ( const cs_equation_param_t eqp,
const cs_cell_mesh_t cm,
cs_face_mesh_t fm,
cs_cell_builder_t cb 
)

Compute the convection operator attached to a cell with a CDO vertex-based scheme without diffusion when an upwind scheme and a conservative formulation is used. The local matrix related to this operator is stored in cb->loc.

Parameters
[in]eqppointer to a cs_equation_param_t structure
[in]cmpointer to a cs_cell_mesh_t structure
[in]fmpointer to a cs_face_mesh_t structure
[in,out]cbpointer to a cs_cell_builder_t structure

◆ cs_cdo_advection_get_vb_upwnocdi()

void cs_cdo_advection_get_vb_upwnocdi ( const cs_equation_param_t eqp,
const cs_cell_mesh_t cm,
cs_face_mesh_t fm,
cs_cell_builder_t cb 
)

Compute the convection operator attached to a cell with a CDO vertex-based scheme when diffusion is activated and an upwind scheme and a conservative formulation is used The local matrix related to this operator is stored in cb->loc.

Parameters
[in]eqppointer to a cs_equation_param_t structure
[in]cmpointer to a cs_cell_mesh_t structure
[in]fmpointer to a cs_face_mesh_t structure
[in,out]cbpointer to a cs_cell_builder_t structure

◆ cs_cdo_advection_get_vcb()

void cs_cdo_advection_get_vcb ( const cs_equation_param_t eqp,
const cs_cell_mesh_t cm,
cs_face_mesh_t fm,
cs_cell_builder_t cb 
)

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

Parameters
[in]eqppointer to a cs_equation_param_t structure
[in]cmpointer to a cs_cell_mesh_t structure
[in]fmpointer to a cs_face_mesh_t structure
[in,out]cbpointer to a cs_cell_builder_t structure

◆ cs_cdo_advection_get_vcb_cw()

void cs_cdo_advection_get_vcb_cw ( const cs_equation_param_t eqp,
const cs_cell_mesh_t cm,
cs_face_mesh_t fm,
cs_cell_builder_t cb 
)

Compute the convection operator attached to a cell with a CDO vertex+cell-based scheme when the advection field is cellwise constant.

Parameters
[in]eqppointer to a cs_equation_param_t structure
[in]cmpointer to a cs_cell_mesh_t structure
[in]fmpointer to a cs_face_mesh_t structure
[in,out]cbpointer to a cs_cell_builder_t structure

◆ 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