#include "cs_base.h"
#include "cs_cdo_connect.h"
#include "cs_flag.h"
#include "cs_math.h"
#include "cs_mesh.h"
#include "cs_mesh_quantities.h"

Include dependency graph for cs_cdo_quantities.h:

Go to the source code of this file.

Data Structures
struct	cs_quant_info_t

struct	cs_quant_t

struct	cs_cdo_quantities_t

Macros
#define	CS_CDO_ORTHO (1 << 0)

Enumerations
enum	cs_cdo_quantities_algo_ccenter_t { CS_CDO_QUANTITIES_MEANV_CENTER, CS_CDO_QUANTITIES_BARYC_CENTER, CS_CDO_QUANTITIES_SATURNE_CENTER, CS_CDO_QUANTITIES_N_CENTER_ALGOS }

Functions
double	cs_compute_area_from_quant (const cs_quant_t qa, const cs_real_t *xb)
	Compute the area of the triangle of base given by q (related to a segment) with apex located at xa. More...

void	cs_cdo_quantities_set_algo_ccenter (cs_cdo_quantities_algo_ccenter_t algo)
	Set the type of algorithm to use for computing the cell center. More...

cs_cdo_quantities_t *	cs_cdo_quantities_build (const cs_mesh_t m, const cs_mesh_quantities_t mq, const cs_cdo_connect_t *topo)
	Build a cs_cdo_quantities_t structure. More...

cs_cdo_quantities_t *	cs_cdo_quantities_free (cs_cdo_quantities_t *q)
	Destroy a cs_cdo_quantities_t structure. More...

void	cs_cdo_quantities_summary (const cs_cdo_quantities_t *quant)
	Summarize generic information about the cdo mesh quantities. More...

void	cs_cdo_quantities_dump (const cs_cdo_quantities_t *cdoq)
	Dump a cs_cdo_quantities_t structure. More...

void	cs_cdo_quantities_compute_dual_volumes (const cs_cdo_quantities_t cdoq, const cs_adjacency_t c2v, cs_real_t *dual_vol)
	Compute the dual volume surrounding each vertex. More...

void	cs_cdo_quantities_compute_wvf (const cs_cdo_connect_t connect, const cs_cdo_quantities_t cdoq, cs_lnum_t bf_id, cs_real_t wvf[])
	Compute the weight related to each vertex of a face. This weight ensures a 2nd order approximation if the face center is the face barycenter. More...

static const cs_real_t *	cs_quant_get_face_vector_area (cs_lnum_t f_id, const cs_cdo_quantities_t *cdoq)
	Retrieve the face vector which the face_area * face_normal for a primal face (interior or border) More...

static const cs_real_t *	cs_quant_get_face_center (cs_lnum_t f_id, const cs_cdo_quantities_t *cdoq)
	Retrieve the face center for a primal face (interior or border) More...

cs_quant_t	cs_quant_set_face (cs_lnum_t f_id, const cs_cdo_quantities_t *cdoq)
	Define a cs_quant_t structure for a primal face (interior or border) More...

cs_nvec3_t	cs_quant_set_face_nvec (cs_lnum_t f_id, const cs_cdo_quantities_t *cdoq)
	Retrieve the face surface and its unit normal vector for a primal face (interior or border) More...

cs_nvec3_t	cs_quant_set_edge_nvec (cs_lnum_t e_id, const cs_cdo_quantities_t *cdoq)
	Get the two normalized vector associated to a primal edge. More...

cs_nvec3_t	cs_quant_set_dedge_nvec (cs_lnum_t f_shift, const cs_cdo_quantities_t *cdoq)
	Get the two normalized vector associated to a dual edge. More...

void	cs_quant_dump (FILE *f, cs_lnum_t num, const cs_quant_t q)
	Dump a cs_quant_t structure. More...

Macro Definition Documentation

◆ CS_CDO_ORTHO

#define CS_CDO_ORTHO (1 << 0)

Enumeration Type Documentation

◆ cs_cdo_quantities_algo_ccenter_t

enum cs_cdo_quantities_algo_ccenter_t

Enumerator
CS_CDO_QUANTITIES_MEANV_CENTER
CS_CDO_QUANTITIES_BARYC_CENTER
CS_CDO_QUANTITIES_SATURNE_CENTER
CS_CDO_QUANTITIES_N_CENTER_ALGOS

Function Documentation

◆ cs_cdo_quantities_build()

cs_cdo_quantities_t* cs_cdo_quantities_build	(	const cs_mesh_t *	m,
		const cs_mesh_quantities_t *	mq,
		const cs_cdo_connect_t *	topo
	)

Build a cs_cdo_quantities_t structure.

Parameters

[in]	m	pointer to a cs_mesh_t structure
[in]	mq	pointer to a cs_mesh_quantities_t structure
[in]	topo	pointer to a cs_cdo_connect_t structure

Returns: a new allocated pointer to a cs_cdo_quantities_t structure

◆ cs_cdo_quantities_compute_dual_volumes()

void cs_cdo_quantities_compute_dual_volumes	(	const cs_cdo_quantities_t *	cdoq,
		const cs_adjacency_t *	c2v,
		cs_real_t *	dual_vol
	)

Compute the dual volume surrounding each vertex.

Parameters

[in]	cdoq	pointer to cs_cdo_quantities_t structure
[in]	c2v	pointer to the cell–>vertices connectivity
[in,out]	dual_vol	dual volumes related to each vertex

◆ cs_cdo_quantities_compute_wvf()

void cs_cdo_quantities_compute_wvf	(	const cs_cdo_connect_t *	connect,
		const cs_cdo_quantities_t *	cdoq,
		cs_lnum_t	bf_id,
		cs_real_t	wvf[]
	)

Compute the weight related to each vertex of a face. This weight ensures a 2nd order approximation if the face center is the face barycenter.

Parameters

[in]	connect	pointer to a cs_cdo_connect_t structure
[in]	cdoq	pointer to a cs_cdo_quantities_t structure
[in]	bf_id	border face id
[in,out]	wvf	quantities to compute (pre-allocated)

◆ cs_cdo_quantities_dump()

void cs_cdo_quantities_dump ( const cs_cdo_quantities_t * cdoq )

Dump a cs_cdo_quantities_t structure.

Parameters

[in] cdoq pointer to cs_cdo_quantities_t structure

◆ cs_cdo_quantities_free()

cs_cdo_quantities_t* cs_cdo_quantities_free ( cs_cdo_quantities_t * q )

Destroy a cs_cdo_quantities_t structure.

Parameters

[in] q pointer to the cs_cdo_quantities_t struct. to free

Returns: a NULL pointer

◆ cs_cdo_quantities_set_algo_ccenter()

void cs_cdo_quantities_set_algo_ccenter ( cs_cdo_quantities_algo_ccenter_t algo )

Set the type of algorithm to use for computing the cell center.

Parameters

[in] algo type of algorithm

◆ cs_cdo_quantities_summary()

void cs_cdo_quantities_summary ( const cs_cdo_quantities_t * quant )

Summarize generic information about the cdo mesh quantities.

Parameters

[in] quant pointer to cs_cdo_quantities_t structure

◆ cs_compute_area_from_quant()

double cs_compute_area_from_quant	(	const cs_quant_t	qa,
		const cs_real_t *	xb
	)

Compute the area of the triangle of base given by q (related to a segment) with apex located at xa.

Parameters

[in]	qa	pointer to a cs_quant_t structure related to a segment
[in]	xb	coordinates of the apex to consider

Returns: the value the area of the triangle

◆ cs_quant_dump()

void cs_quant_dump	(	FILE *	f,
		cs_lnum_t	num,
		const cs_quant_t	q
	)

Dump a cs_quant_t structure.

Parameters

[in]	f	FILE struct (stdout if NULL)
[in]	num	entity number related to this quantity struct.
[in]	q	cs_quant_t structure to dump

◆ cs_quant_get_face_center()

static const cs_real_t* cs_quant_get_face_center	(	cs_lnum_t	f_id,
		const cs_cdo_quantities_t *	cdoq
	)

inlinestatic

Retrieve the face center for a primal face (interior or border)

Parameters

[in]	f_id	id related to the face (f_id > n_i_face -> border face)
[in]	cdoq	pointer to a cs_cdo_quantities_t structure

Returns: a pointer to the face center coordinates

◆ cs_quant_get_face_vector_area()

static const cs_real_t* cs_quant_get_face_vector_area	(	cs_lnum_t	f_id,
		const cs_cdo_quantities_t *	cdoq
	)

inlinestatic

Retrieve the face vector which the face_area * face_normal for a primal face (interior or border)

Parameters

[in]	f_id	id related to the face (f_id > n_i_face -> border face)
[in]	cdoq	pointer to a cs_cdo_quantities_t structure

Returns: a pointer to the face vector

◆ cs_quant_set_dedge_nvec()

cs_nvec3_t cs_quant_set_dedge_nvec	(	cs_lnum_t	f_shift,
		const cs_cdo_quantities_t *	cdoq
	)

Get the two normalized vector associated to a dual edge.

Parameters

[in]	f_shift	position in c2f_idx
[in]	cdoq	pointer to a cs_cdo_quantities_t structure

Returns: a pointer to the dual edge normalized vector

◆ cs_quant_set_edge_nvec()

cs_nvec3_t cs_quant_set_edge_nvec	(	cs_lnum_t	e_id,
		const cs_cdo_quantities_t *	cdoq
	)

Get the two normalized vector associated to a primal edge.

Parameters

[in]	e_id	id related to the face (f_id > n_i_face -> border face)
[in]	cdoq	pointer to a cs_cdo_quantities_t structure

Returns: a pointer to the edge normalized vector

◆ cs_quant_set_face()

cs_quant_t cs_quant_set_face	(	cs_lnum_t	f_id,
		const cs_cdo_quantities_t *	cdoq
	)

Define a cs_quant_t structure for a primal face (interior or border)

Parameters

[in]	f_id	id related to the face (f_id > n_i_face -> border face)
[in]	cdoq	pointer to a cs_cdo_quantities_t structure

Returns: a initialize structure

◆ cs_quant_set_face_nvec()

cs_nvec3_t cs_quant_set_face_nvec	(	cs_lnum_t	f_id,
		const cs_cdo_quantities_t *	cdoq
	)

Retrieve the face surface and its unit normal vector for a primal face (interior or border)

Parameters

[in]	f_id	id related to the face (f_id > n_i_face -> border face)
[in]	cdoq	pointer to a cs_cdo_quantities_t structure

Returns: a pointer to the face normalized vector

Data Structures

Macros

Enumerations

Functions

Macro Definition Documentation

◆ CS_CDO_ORTHO

Enumeration Type Documentation

◆ cs_cdo_quantities_algo_ccenter_t

Function Documentation

◆ cs_cdo_quantities_build()

◆ cs_cdo_quantities_compute_dual_volumes()

◆ cs_cdo_quantities_compute_wvf()

◆ cs_cdo_quantities_dump()

◆ cs_cdo_quantities_free()

◆ cs_cdo_quantities_set_algo_ccenter()

◆ cs_cdo_quantities_summary()

◆ cs_compute_area_from_quant()

◆ cs_quant_dump()

◆ cs_quant_get_face_center()

◆ cs_quant_get_face_vector_area()

◆ cs_quant_set_dedge_nvec()

◆ cs_quant_set_edge_nvec()

◆ cs_quant_set_face()

◆ cs_quant_set_face_nvec()