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_time_step.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, const cs_time_step_t *time_step)
	Set shared pointers to main domain members. More...
void	cs_evaluate_density_by_analytic (cs_flag_t dof_flag, const cs_xdef_t *def, double 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, double 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, double 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, double retval[])
	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 attached to the given definition. More...
void	cs_evaluate_potential_by_value (cs_flag_t dof_flag, const cs_xdef_t *def, double retval[])
	Evaluate the quantity attached to a potential field for all the DoFs. More...
void	cs_evaluate_average_on_faces_by_value (cs_flag_t dof_flag, const cs_xdef_t *def, double retval[])
	Evaluate the average of a function on the faces. More...
void	cs_evaluate_average_on_faces_by_analytic (cs_flag_t dof_flag, const cs_xdef_t *def, double retval[])
	Evaluate the average of a function on the faces. More...
static void	cs_evaluate_average_on_faces (cs_flag_t dof_flag, const cs_xdef_t *def, double retval[])
	Evaluate the average of a function on the faces. More...
void	cs_evaluate_average_on_cells_by_value (cs_flag_t dof_flag, const cs_xdef_t *def, double retval[])
	Evaluate the average of a function on the cells. More...
void	cs_evaluate_average_on_cells_by_array (cs_flag_t dof_flag, const cs_xdef_t *def, double retval[])
	Evaluate the average of a function on the cells. More...
void	cs_evaluate_average_on_cells_by_analytic (cs_flag_t dof_flag, const cs_xdef_t *def, double retval[])
	Evaluate the average of a function on the cells. More...
static void	cs_evaluate_average_on_cells (cs_flag_t dof_flag, const cs_xdef_t *def, double 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 ( cs_flag_t  dof_flag, const cs_xdef_t *  def, double  retval[]  )

inlinestatic

Evaluate the average of a function on the cells.

Parameters

[in]	dof_flag	indicate where the evaluation has to be done
[in]	def	pointer to a cs_xdef_t pointer
[in,out]	retval	pointer to the computed values

cs_evaluate_average_on_cells_by_analytic()

void cs_evaluate_average_on_cells_by_analytic	(	cs_flag_t	dof_flag,
		const cs_xdef_t *	def,
		double	retval[]
	)

Evaluate the average of a function on the cells.

Parameters

[in]	dof_flag	indicate where the evaluation has to be done
[in]	def	pointer to a cs_xdef_t pointer
[in,out]	retval	pointer to the computed values

cs_evaluate_average_on_cells_by_array()

void cs_evaluate_average_on_cells_by_array	(	cs_flag_t	dof_flag,
		const cs_xdef_t *	def,
		double	retval[]
	)

Evaluate the average of a function on the cells.

Parameters

[in]	dof_flag	indicate where the evaluation has to be done
[in]	def	pointer to a cs_xdef_t pointer
[in,out]	retval	pointer to the computed values

cs_evaluate_average_on_cells_by_value()

void cs_evaluate_average_on_cells_by_value	(	cs_flag_t	dof_flag,
		const cs_xdef_t *	def,
		double	retval[]
	)

Evaluate the average of a function on the cells.

Parameters

[in]	dof_flag	indicate where the evaluation has to be done
[in]	def	pointer to a cs_xdef_t pointer
[in,out]	retval	pointer to the computed values

cs_evaluate_average_on_faces()

static void cs_evaluate_average_on_faces ( cs_flag_t  dof_flag, const cs_xdef_t *  def, double  retval[]  )

inlinestatic

Evaluate the average of a function on the faces.

Parameters

[in]	dof_flag	indicate where the evaluation has to be done
[in]	def	pointer to a cs_xdef_t pointer
[in,out]	retval	pointer to the computed values

cs_evaluate_average_on_faces_by_analytic()

void cs_evaluate_average_on_faces_by_analytic	(	cs_flag_t	dof_flag,
		const cs_xdef_t *	def,
		double	retval[]
	)

Evaluate the average of a function on the faces.

Parameters

[in]	dof_flag	indicate where the evaluation has to be done
[in]	def	pointer to a cs_xdef_t pointer
[in,out]	retval	pointer to the computed values

cs_evaluate_average_on_faces_by_value()

void cs_evaluate_average_on_faces_by_value	(	cs_flag_t	dof_flag,
		const cs_xdef_t *	def,
		double	retval[]
	)

Evaluate the average of a function on the faces.

Parameters

[in]	dof_flag	indicate where the evaluation has to be done
[in]	def	pointer to a cs_xdef_t pointer
[in,out]	retval	pointer 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,
		double	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_flag	indicate where the evaluation has to be done
[in]	def	pointer to a cs_xdef_t structure
[in,out]	retval	pointer 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,
		double	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_flag	indicate where the evaluation has to be done
[in]	def	pointer to a cs_xdef_t structure
[in,out]	retval	pointer 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,
		double	retval[]
	)

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

Parameters

[in]	dof_flag	indicate where the evaluation has to be done
[in]	def	pointer to a cs_xdef_t pointer
[in,out]	retval	pointer 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,
		double	retval[]
	)

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 attached to the given definition.

Parameters

[in]	dof_flag	indicate where the evaluation has to be done
[in]	def	pointer to a cs_xdef_t pointer
[in,out]	retval	pointer to the computed values

cs_evaluate_potential_by_value()

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

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

Parameters

[in]	dof_flag	indicate where the evaluation has to be done
[in]	def	pointer to a cs_xdef_t pointer
[in,out]	retval	pointer to the computed values

cs_evaluate_set_shared_pointers()

void cs_evaluate_set_shared_pointers	(	const cs_cdo_quantities_t *	quant,
		const cs_cdo_connect_t *	connect,
		const cs_time_step_t *	time_step
	)

Set shared pointers to main domain members.

Parameters

[in]	quant	additional mesh quantities struct.
[in]	connect	pointer to a cs_cdo_connect_t struct.
[in]	time_step	pointer to a time step structure