cs_cdo_quantities_t Struct Reference

#include <cs_cdo_quantities.h>

Collaboration diagram for cs_cdo_quantities_t:

Public Member Functions
cs_real_t	get_face_surf (const cs_lnum_t f_id) const
	Get the face surface for a primal face (interior or border) More...
cs_real_t	get_bface_surf (const cs_lnum_t bf_id) const
	Get the face surface for a border primal face. More...
const cs_nreal_t *	get_bface_normal (cs_lnum_t bf_id) const
	Get the unit normal for a border primal face. More...
const cs_real_t *	get_face_vector_area (cs_lnum_t f_id) const
	Get the face vector which the face_area * face_normal for a primal face (interior or border) More...
const cs_real_t *	get_face_center (cs_lnum_t f_id) const
	Get the face center for a primal face (interior or border) More...
cs_quant_t	get_face (cs_lnum_t f_id) const
	Get a cs_quant_t structure for a primal face (interior or border) More...
cs_nvec3_t	get_face_nvec (cs_lnum_t f_id) const
	Get the face surface and its unit normal vector for a primal face (interior or border) More...
cs_quant_t	get_edge_center (cs_lnum_t e_id, const cs_cdo_connect_t *topo) const
	Retrieve the edge center for a primal edge (interior or border) More...
cs_nvec3_t	get_edge_nvec (cs_lnum_t e_id) const
	Get the normalized vector associated to a primal edge. More...
cs_nvec3_t	get_dedge_nvec (cs_lnum_t shift) const
	Get the two normalized vector associated to a dual edge. More...
void	log_summary () const
	Summarize generic information about the cdo mesh quantities. More...
void	dump () const
	Dump a cs_cdo_quantities_t structure (for debugging purpose) More...
void	check (int verb, const cs_mesh_quantities_t *mq, const cs_cdo_connect_t *topo) const
	Check that global quantities are consistently computed. More...

Public Attributes
bool	remove_boundary_faces
double	vol_tot
cs_lnum_t	n_cells
cs_gnum_t	n_g_cells
cs_real_3_t *	cell_centers
cs_real_t *	cell_vol
cs_quant_info_t	cell_info
cs_lnum_t	n_faces
cs_lnum_t	n_i_faces
cs_lnum_t	n_b_faces
cs_gnum_t	n_g_faces
cs_nreal_3_t *	i_face_u_normal
cs_real_t *	i_face_normal
cs_real_t *	i_face_surf
cs_real_3_t *	i_face_center
const cs_real_t *	i_dist
cs_nreal_3_t *	b_face_u_normal
cs_real_t *	b_face_normal
cs_real_t *	b_face_surf
cs_real_3_t *	b_face_center
const cs_real_t *	b_dist
cs_flag_cartesian_axis_t *	face_axis
cs_real_t *	dedge_vector
cs_real_t *	pvol_fc
cs_quant_info_t	face_info
cs_lnum_t	n_edges
cs_gnum_t	n_g_edges
cs_real_t *	edge_vector
cs_real_t *	dface_normal
cs_real_t *	pvol_ec
cs_quant_info_t	edge_info
cs_lnum_t	n_vertices
cs_gnum_t	n_g_vertices
cs_real_t *	pvol_vc
const cs_real_t *	vtx_coord
cs_real_t *	dual_vol

Member Function Documentation

check()

void check	(	int	verb,
		const cs_mesh_quantities_t *	mq,
		const cs_cdo_connect_t *	topo
	)		const

Check that global quantities are consistently computed.

Parameters

[in]	verb	level of verbosity
[in]	mq	pointer to a cs_mesh_quantities_t structure
[in]	topo	pointer to a cs_cdo_connect_t structure

dump()

void dump

(

)

const

Dump a cs_cdo_quantities_t structure (for debugging purpose)

get_bface_normal()

const cs_nreal_t * get_bface_normal ( cs_lnum_t  bf_id ) const

inline

Get the unit normal for a border primal face.

Parameters

[in]

bf_id

id related to the border face

Returns

a pointer to the face normal

get_bface_surf()

cs_real_t get_bface_surf ( const cs_lnum_t  bf_id ) const

inline

Get the face surface for a border primal face.

Parameters

[in]

bf_id

id related to the border face

Returns

the value of the border face surface

get_dedge_nvec()

cs_nvec3_t get_dedge_nvec

(

cs_lnum_t

shift

)

const

Get the two normalized vector associated to a dual edge.

Parameters

[in]

shift

position in c2f_idx

Returns

a pointer to the dual edge normalized vector

get_edge_center()

cs_quant_t get_edge_center	(	cs_lnum_t	e_id,
		const cs_cdo_connect_t *	topo
	)		const

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

Get the edge center for a primal edge (interior or border)

Parameters

[in]	e_id	id related to the edfe
[in]	topo	pointer to a cs_cdo_connect_t structure

Returns

a pointer to the edge center coordinates

get_edge_nvec()

cs_nvec3_t get_edge_nvec

(

cs_lnum_t

e_id

)

const

Get the normalized vector associated to a primal edge.

Parameters

[in]

e_id

id related to an edge

Returns

a pointer to the edge normalized vector

get_face()

cs_quant_t get_face

(

cs_lnum_t

f_id

)

const

Get 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)

Returns

a initialize structure

get_face_center()

const cs_real_t * get_face_center ( cs_lnum_t  f_id ) const

inline

Get 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)

Returns

a pointer to the face center coordinates

get_face_nvec()

cs_nvec3_t get_face_nvec

(

cs_lnum_t

f_id

)

const

Get 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

Returns

a pointer to the face normalized vector

Parameters

[in]

f_id

id related to the face (f_id > n_i_face -> border face)

Returns

a pointer to the face normalized vector

get_face_surf()

cs_real_t get_face_surf ( const cs_lnum_t  f_id ) const

inline

Get the face surface for a primal face (interior or border)

Parameters

[in]

f_id

id related to the face (f_id > n_i_face -> border face)

Returns

the value of the face surface

get_face_vector_area()

const cs_real_t * get_face_vector_area ( cs_lnum_t  f_id ) const

inline

Get 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)

Returns

a pointer to the face vector

log_summary()

void log_summary

(

)

const

Summarize generic information about the cdo mesh quantities.

Member Data Documentation

b_dist

const cs_real_t* b_dist

b_face_center

cs_real_3_t* b_face_center

b_face_normal

cs_real_t* b_face_normal

b_face_surf

cs_real_t* b_face_surf

b_face_u_normal

cs_nreal_3_t* b_face_u_normal

cell_centers

cs_real_3_t* cell_centers

cell_info

cs_quant_info_t cell_info

cell_vol

cs_real_t* cell_vol

dedge_vector

cs_real_t* dedge_vector

dface_normal

cs_real_t* dface_normal

dual_vol

cs_real_t* dual_vol

edge_info

cs_quant_info_t edge_info

edge_vector

cs_real_t* edge_vector

face_axis

cs_flag_cartesian_axis_t* face_axis

face_info

cs_quant_info_t face_info

i_dist

const cs_real_t* i_dist

i_face_center

cs_real_3_t* i_face_center

i_face_normal

cs_real_t* i_face_normal

i_face_surf

cs_real_t* i_face_surf

i_face_u_normal

cs_nreal_3_t* i_face_u_normal

n_b_faces

cs_lnum_t n_b_faces

n_cells

cs_lnum_t n_cells

n_edges

cs_lnum_t n_edges

n_faces

cs_lnum_t n_faces

n_g_cells

cs_gnum_t n_g_cells

n_g_edges

cs_gnum_t n_g_edges

n_g_faces

cs_gnum_t n_g_faces

n_g_vertices

cs_gnum_t n_g_vertices

n_i_faces

cs_lnum_t n_i_faces

n_vertices

cs_lnum_t n_vertices

pvol_ec

cs_real_t* pvol_ec

pvol_fc

cs_real_t* pvol_fc

pvol_vc

cs_real_t* pvol_vc

remove_boundary_faces

bool remove_boundary_faces

vol_tot

double vol_tot

vtx_coord

const cs_real_t* vtx_coord

---

The documentation for this struct was generated from the following files:

• src/cdo/cs_cdo_quantities.h
• src/cdo/cs_cdo_quantities.cpp