My Project
programmer's documentation
Data Structures | Macros | Enumerations | Functions
cs_cdo_quantities.h File Reference
#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

static 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_tcs_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_tcs_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_i_tef (const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *cdoq, cs_lnum_t f_id, cs_real_t tef[])
 Compute the area of the triangles with basis each edge of the face and apex the face center. Case of interior faces. Storage in agreement with the bf2v adjacency structure. More...
 
void cs_cdo_quantities_compute_b_tef (const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *cdoq, cs_lnum_t bf_id, cs_real_t tef[])
 Compute the area of the triangles with basis each edge of the face and apex the face center. Case of boundary faces. Storage in agreement with the bf2v adjacency structure. More...
 
void cs_cdo_quantities_compute_i_wvf (const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *cdoq, cs_lnum_t f_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. Case of interior faces. More...
 
void cs_cdo_quantities_compute_b_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. Case of boundary faces. More...
 
static const cs_real_tcs_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_tcs_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 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

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]mpointer to a cs_mesh_t structure
[in]mqpointer to a cs_mesh_quantities_t structure
[in]topopointer to a cs_cdo_connect_t structure
Returns
a new allocated pointer to a cs_cdo_quantities_t structure

◆ cs_cdo_quantities_compute_b_tef()

void cs_cdo_quantities_compute_b_tef ( const cs_cdo_connect_t connect,
const cs_cdo_quantities_t cdoq,
cs_lnum_t  bf_id,
cs_real_t  tef[] 
)

Compute the area of the triangles with basis each edge of the face and apex the face center. Case of boundary faces. Storage in agreement with the bf2v adjacency structure.

Parameters
[in]connectpointer to a cs_cdo_connect_t structure
[in]cdoqpointer to a cs_cdo_quantities_t structure
[in]bf_idborder face id
[in,out]tefquantities to compute (pre-allocated)

◆ cs_cdo_quantities_compute_b_wvf()

void cs_cdo_quantities_compute_b_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. Case of boundary faces.

Parameters
[in]connectpointer to a cs_cdo_connect_t structure
[in]cdoqpointer to a cs_cdo_quantities_t structure
[in]bf_idborder face id
[in,out]wvfquantities to compute (pre-allocated)

◆ 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]cdoqpointer to cs_cdo_quantities_t structure
[in]c2vpointer to the cell-->vertices connectivity
[in,out]dual_voldual volumes related to each vertex

◆ cs_cdo_quantities_compute_i_tef()

void cs_cdo_quantities_compute_i_tef ( const cs_cdo_connect_t connect,
const cs_cdo_quantities_t cdoq,
cs_lnum_t  f_id,
cs_real_t  tef[] 
)

Compute the area of the triangles with basis each edge of the face and apex the face center. Case of interior faces. Storage in agreement with the bf2v adjacency structure.

Parameters
[in]connectpointer to a cs_cdo_connect_t structure
[in]cdoqpointer to a cs_cdo_quantities_t structure
[in]f_idinterior face id
[in,out]tefquantities to compute (pre-allocated)

Compute the area of the triangles with basis each edge of the face and apex the face center. Case of interior faces. Storage in agreement with the bf2v adjacency structure.

Parameters
[in]connectpointer to a cs_cdo_connect_t structure
[in]cdoqpointer to a cs_cdo_quantities_t structure
[in]f_idinterior face id
[in,out]tefquantities to compute (pre-allocated)

◆ cs_cdo_quantities_compute_i_wvf()

void cs_cdo_quantities_compute_i_wvf ( const cs_cdo_connect_t connect,
const cs_cdo_quantities_t cdoq,
cs_lnum_t  f_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. Case of interior faces.

Parameters
[in]connectpointer to a cs_cdo_connect_t structure
[in]cdoqpointer to a cs_cdo_quantities_t structure
[in]f_idinterior face id
[in,out]wvfquantities 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]cdoqpointer 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]qpointer 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]algotype 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]quantpointer to cs_cdo_quantities_t structure

◆ cs_compute_area_from_quant()

static double cs_compute_area_from_quant ( const cs_quant_t  qa,
const cs_real_t xb 
)
inlinestatic

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

Parameters
[in]qapointer to a cs_quant_t structure related to a segment
[in]xbcoordinates 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]fFILE struct (stdout if NULL)
[in]numentity number related to this quantity struct.
[in]qcs_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_idid related to the face (f_id > n_i_face -> border face)
[in]cdoqpointer 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_idid related to the face (f_id > n_i_face -> border face)
[in]cdoqpointer 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_shiftposition in c2f_idx
[in]cdoqpointer 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 normalized vector associated to a primal edge.

Parameters
[in]e_idid related to an edge
[in]cdoqpointer 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_idid related to the face (f_id > n_i_face -> border face)
[in]cdoqpointer 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_idid related to the face (f_id > n_i_face -> border face)
[in]cdoqpointer to a cs_cdo_quantities_t structure
Returns
a pointer to the face normalized vector