programmer's documentation
Functions
cs_evaluate.h File Reference
#include "cs_base.h"
#include "cs_time_step.h"
#include "cs_cdo.h"
#include "cs_cdo_quantities.h"
#include "cs_quadrature.h"
#include "cs_param.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_from_analytic (cs_flag_t dof_flag, int ml_id, cs_analytic_func_t *ana, cs_quadra_type_t quad_type, 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_from_value (cs_flag_t dof_flag, int ml_id, cs_get_t get, double retval[])
 Compute the value related to each DoF in the case of a density field Accessor to the value is by unit of volume. More...
 
void cs_evaluate_potential_from_analytic (cs_flag_t dof_flag, int ml_id, cs_analytic_func_t *ana, double retval[])
 Compute the contribution related to a quantity defined by analytic function for all the degrees of freedom. More...
 
void cs_evaluate_potential_from_qov (cs_flag_t dof_flag, int ml_id, cs_get_t get, 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 ml_id. More...
 
void cs_evaluate_potential_from_value (cs_flag_t dof_flag, int ml_id, cs_get_t get, double retval[])
 Store the value related to each DoF in the case of a potential field. More...
 

Function Documentation

§ cs_evaluate_density_from_analytic()

void cs_evaluate_density_from_analytic ( cs_flag_t  dof_flag,
int  ml_id,
cs_analytic_func_t ana,
cs_quadra_type_t  quad_type,
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_flagindicate where the evaluation has to be done
[in]ml_idid related to a cs_mesh_location_t structure
[in]anaaccessor to values thanks to a function pointer
[in]quad_typetype of quadrature (not always used)
[in,out]retvalpointer to the computed values

§ cs_evaluate_density_from_value()

void cs_evaluate_density_from_value ( cs_flag_t  dof_flag,
int  ml_id,
cs_get_t  get,
double  retval[] 
)

Compute the value related to each DoF in the case of a density field Accessor to the value is by unit of volume.

Parameters
[in]dof_flagindicate where the evaluation has to be done
[in]ml_idid related to a cs_mesh_location_t structure
[in]getaccessor to the constant value to set
[in,out]retvalpointer to the computed values

§ cs_evaluate_potential_from_analytic()

void cs_evaluate_potential_from_analytic ( cs_flag_t  dof_flag,
int  ml_id,
cs_analytic_func_t ana,
double  retval[] 
)

Compute the contribution related to a quantity defined by analytic function for all the degrees of freedom.

Parameters
[in]dof_flagindicate where the evaluation has to be done
[in]ml_idid related to a cs_mesh_location_t structure
[in]anaaccessor to values thanks to a function pointer
[in,out]retvalpointer to the computed values

§ cs_evaluate_potential_from_qov()

void cs_evaluate_potential_from_qov ( cs_flag_t  dof_flag,
int  ml_id,
cs_get_t  get,
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 ml_id.

Parameters
[in]dof_flagindicate where the evaluation has to be done
[in]ml_idid related to a cs_mesh_location_t structure
[in]getaccessor to the constant value related to the quantity to put in the volume spanned by ml_id
[in,out]retvalpointer to the computed values

§ cs_evaluate_potential_from_value()

void cs_evaluate_potential_from_value ( cs_flag_t  dof_flag,
int  ml_id,
cs_get_t  get,
double  retval[] 
)

Store the value related to each DoF in the case of a potential field.

Parameters
[in]dof_flagindicate where the evaluation has to be done
[in]ml_idid related to a cs_mesh_location_t structure
[in]getaccessor to the constant value to set
[in,out]retvalpointer 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]quantadditional mesh quantities struct.
[in]connectpointer to a cs_cdo_connect_t struct.
[in]time_steppointer to a time step structure