My Project
programmer's documentation
Functions
cs_evaluate.h File Reference
#include "cs_base.h"
#include "cs_cdo_connect.h"
#include "cs_cdo_local.h"
#include "cs_cdo_quantities.h"
#include "cs_param.h"
#include "cs_xdef.h"
Include dependency graph for cs_evaluate.h:

Go to the source code of this file.

Functions

void cs_evaluate_set_shared_pointers (const cs_cdo_quantities_t *quant, const cs_cdo_connect_t *connect)
 Set shared pointers to main domain members. More...
 
void cs_evaluate_density_by_analytic (cs_flag_t dof_flag, const cs_xdef_t *def, cs_real_t time_eval, cs_real_t retval[])
 Compute the value related to each DoF in the case of a density field The value defined by the analytic function is by unity of volume. More...
 
void cs_evaluate_density_by_value (cs_flag_t dof_flag, const cs_xdef_t *def, cs_real_t retval[])
 Evaluate the quantity defined by a value in the case of a density field for all the degrees of freedom Accessor to the value is by unit of volume. More...
 
void cs_evaluate_potential_by_analytic (cs_flag_t dof_flag, const cs_xdef_t *def, cs_real_t time_eval, cs_real_t retval[])
 Evaluate the quantity attached to a potential field for all the DoFs when the definition relies on an analytic expression. More...
 
void cs_evaluate_potential_by_qov (cs_flag_t dof_flag, const cs_xdef_t *def, cs_real_t vvals[], cs_real_t wvals[])
 Define a value to each DoF in the case of a potential field in order to put a given quantity inside the volume associated to the zone related to the given definition wvals may be NULL. More...
 
void cs_evaluate_potential_by_value (cs_flag_t dof_flag, const cs_xdef_t *def, cs_real_t retval[])
 Evaluate the quantity attached to a potential field for all the DoFs. More...
 
void cs_evaluate_average_on_faces_by_value (const cs_xdef_t *def, cs_real_t retval[])
 Evaluate the average of a function on the faces. More...
 
void cs_evaluate_average_on_faces_by_analytic (const cs_xdef_t *def, cs_real_t time_eval, cs_real_t retval[])
 Evaluate the average of a function on the faces Warning: retval has to be initialize before calling this function. More...
 
void cs_evaluate_average_on_cells_by_value (const cs_xdef_t *def, cs_real_t retval[])
 Evaluate the average of a function on the cells. More...
 
void cs_evaluate_average_on_cells_by_array (const cs_xdef_t *def, cs_real_t retval[])
 Evaluate the average of a function on the cells. More...
 
void cs_evaluate_average_on_cells_by_analytic (const cs_xdef_t *def, cs_real_t time_eval, cs_real_t retval[])
 Evaluate the average of a function on the cells Warning: retval has to be initialize before calling this function. More...
 
cs_real_t cs_evaluate_scal_domain_integral_by_array (cs_flag_t array_loc, const cs_real_t *array_val)
 Evaluate the integral over the full computational domain of a quantity defined by an array. More...
 
static void cs_evaluate_average_on_faces (const cs_xdef_t *def, cs_real_t time_eval, cs_real_t retval[])
 Evaluate the average of a function on the faces. More...
 
static void cs_evaluate_average_on_cells (const cs_xdef_t *def, cs_real_t time_eval, cs_real_t retval[])
 Evaluate the average of a function on the cells. More...
 

Function Documentation

◆ cs_evaluate_average_on_cells()

static void cs_evaluate_average_on_cells ( const cs_xdef_t def,
cs_real_t  time_eval,
cs_real_t  retval[] 
)
inlinestatic

Evaluate the average of a function on the cells.

Parameters
[in]defpointer to a cs_xdef_t pointer
[in]time_evalphysical time at which one evaluates the term
[in,out]retvalpointer to the computed values

◆ cs_evaluate_average_on_cells_by_analytic()

void cs_evaluate_average_on_cells_by_analytic ( const cs_xdef_t def,
cs_real_t  time_eval,
cs_real_t  retval[] 
)

Evaluate the average of a function on the cells Warning: retval has to be initialize before calling this function.

Parameters
[in]defpointer to a cs_xdef_t pointer
[in]time_evalphysical time at which one evaluates the term
[in,out]retvalpointer to the computed values

Evaluate the average of a function on the cells Warning: retval has to be initialize before calling this function.

Parameters
[in]defpointer to a cs_xdef_t pointer
[in]time_evalphysical time at which one evaluates the term
[in,out]retvalpointer to the computed values

◆ cs_evaluate_average_on_cells_by_array()

void cs_evaluate_average_on_cells_by_array ( const cs_xdef_t def,
cs_real_t  retval[] 
)

Evaluate the average of a function on the cells.

Parameters
[in]defpointer to a cs_xdef_t pointer
[in,out]retvalpointer to the computed values

◆ cs_evaluate_average_on_cells_by_value()

void cs_evaluate_average_on_cells_by_value ( const cs_xdef_t def,
cs_real_t  retval[] 
)

Evaluate the average of a function on the cells.

Parameters
[in]defpointer to a cs_xdef_t pointer
[in,out]retvalpointer to the computed values

◆ cs_evaluate_average_on_faces()

static void cs_evaluate_average_on_faces ( const cs_xdef_t def,
cs_real_t  time_eval,
cs_real_t  retval[] 
)
inlinestatic

Evaluate the average of a function on the faces.

Parameters
[in]defpointer to a cs_xdef_t pointer
[in]time_evalphysical time at which one evaluates the term
[in,out]retvalpointer to the computed values

◆ cs_evaluate_average_on_faces_by_analytic()

void cs_evaluate_average_on_faces_by_analytic ( const cs_xdef_t def,
cs_real_t  time_eval,
cs_real_t  retval[] 
)

Evaluate the average of a function on the faces Warning: retval has to be initialize before calling this function.

Parameters
[in]defpointer to a cs_xdef_t pointer
[in]time_evalphysical time at which one evaluates the term
[in,out]retvalpointer to the computed values

Evaluate the average of a function on the faces Warning: retval has to be initialize before calling this function.

Parameters
[in]defpointer to a cs_xdef_t pointer
[in]time_evalphysical time at which one evaluates the term
[in,out]retvalpointer to the computed values

◆ cs_evaluate_average_on_faces_by_value()

void cs_evaluate_average_on_faces_by_value ( const cs_xdef_t def,
cs_real_t  retval[] 
)

Evaluate the average of a function on the faces.

Parameters
[in]defpointer to a cs_xdef_t pointer
[in,out]retvalpointer to the computed values

◆ cs_evaluate_density_by_analytic()

void cs_evaluate_density_by_analytic ( cs_flag_t  dof_flag,
const cs_xdef_t def,
cs_real_t  time_eval,
cs_real_t  retval[] 
)

Compute the value related to each DoF in the case of a density field The value defined by the analytic function is by unity of volume.

Parameters
[in]dof_flagindicate where the evaluation has to be done
[in]defpointer to a cs_xdef_t structure
[in]time_evalphysical time at which one evaluates the term
[in,out]retvalpointer to the computed values

◆ cs_evaluate_density_by_value()

void cs_evaluate_density_by_value ( cs_flag_t  dof_flag,
const cs_xdef_t def,
cs_real_t  retval[] 
)

Evaluate the quantity defined by a value in the case of a density field for all the degrees of freedom Accessor to the value is by unit of volume.

Parameters
[in]dof_flagindicate where the evaluation has to be done
[in]defpointer to a cs_xdef_t structure
[in,out]retvalpointer to the computed values

◆ cs_evaluate_potential_by_analytic()

void cs_evaluate_potential_by_analytic ( cs_flag_t  dof_flag,
const cs_xdef_t def,
cs_real_t  time_eval,
cs_real_t  retval[] 
)

Evaluate the quantity attached to a potential field for all the DoFs when the definition relies on an analytic expression.

Parameters
[in]dof_flagindicate where the evaluation has to be done
[in]defpointer to a cs_xdef_t pointer
[in]time_evalphysical time at which one evaluates the term
[in,out]retvalpointer to the computed values

◆ cs_evaluate_potential_by_qov()

void cs_evaluate_potential_by_qov ( cs_flag_t  dof_flag,
const cs_xdef_t def,
cs_real_t  vvals[],
cs_real_t  wvals[] 
)

Define a value to each DoF in the case of a potential field in order to put a given quantity inside the volume associated to the zone related to the given definition wvals may be NULL.

Parameters
[in]dof_flagindicate where the evaluation has to be done
[in]defpointer to a cs_xdef_t pointer
[in,out]vvalspointer to the first array of computed values
[in,out]wvalspointer to the second array of computed values

◆ cs_evaluate_potential_by_value()

void cs_evaluate_potential_by_value ( cs_flag_t  dof_flag,
const cs_xdef_t def,
cs_real_t  retval[] 
)

Evaluate the quantity attached to a potential field for all the DoFs.

Parameters
[in]dof_flagindicate where the evaluation has to be done
[in]defpointer to a cs_xdef_t pointer
[in,out]retvalpointer to the computed values

◆ cs_evaluate_scal_domain_integral_by_array()

cs_real_t cs_evaluate_scal_domain_integral_by_array ( cs_flag_t  array_loc,
const cs_real_t array_val 
)

Evaluate the integral over the full computational domain of a quantity defined by an array.

Parameters
[in]array_locflag indicating where are located values
[in]array_valarray of values
Returns
the value of the integration

◆ cs_evaluate_set_shared_pointers()

void cs_evaluate_set_shared_pointers ( const cs_cdo_quantities_t quant,
const cs_cdo_connect_t connect 
)

Set shared pointers to main domain members.

Parameters
[in]quantadditional mesh quantities struct.
[in]connectpointer to a cs_cdo_connect_t struct.