1 #ifndef __CS_ADVECTION_FIELD_H__ 2 #define __CS_ADVECTION_FIELD_H__ 54 typedef struct _cs_adv_field_t cs_adv_field_t;
129 const char *ref_name);
275 const cs_adv_field_t *adv,
347 const cs_adv_field_t *adv,
397 const cs_adv_field_t *adv);
472 const cs_property_t *diff,
Definition: cs_advection_field.h:61
time step descriptor
Definition: cs_time_step.h:51
void cs_advection_field_update(cs_adv_field_t *adv)
Update the values of the related field(s)
Definition: cs_advection_field.c:1414
bool cs_advection_field_is_uniform(const cs_adv_field_t *adv)
returns true if the advection field is uniform, otherwise false
Definition: cs_advection_field.c:241
void cs_advection_field_at_cells(const cs_adv_field_t *adv, cs_real_t *cell_values)
Compute the value of the advection field at cell centers.
Definition: cs_advection_field.c:717
void cs_advection_field_get_at_xyz(const cs_adv_field_t *adv, const cs_real_3_t xyz, cs_nvec3_t *vect)
Compute the value of the advection field for a given face.
Definition: cs_advection_field.c:666
void cs_advection_get_peclet(const cs_adv_field_t *adv, const cs_property_t *diff, cs_real_t peclet[])
Compute the Peclet number in each cell.
Definition: cs_advection_field.c:1658
Definition: cs_advection_field.h:62
double cs_advection_field_get_cell_max(const cs_adv_field_t *adv)
Compute the max. value of the advection field among cells.
Definition: cs_advection_field.c:967
const char * cs_advection_field_get_name(const cs_adv_field_t *adv)
Retrieve the name of an advection field.
Definition: cs_advection_field.c:288
#define BEGIN_C_DECLS
Definition: cs_defs.h:448
void cs_advection_field_def_by_array(cs_adv_field_t *adv, cs_desc_t desc, const cs_real_t *array)
Define a cs_adv_field_t structure thanks to an array of values.
Definition: cs_advection_field.c:489
cs_advection_field_key_t
Definition: cs_advection_field.h:57
Definition: cs_advection_field.h:60
bool cs_advection_field_needs_post(const cs_adv_field_t *adv)
Check if additional predefined postprocessing is requested.
Definition: cs_advection_field.c:1456
Definition: cs_cdo_local.h:73
Definition: cs_cdo_connect.h:67
void cs_advection_field_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.
Definition: cs_advection_field.c:128
double cs_real_t
Floating-point value.
Definition: cs_defs.h:296
Definition: cs_cdo_quantities.h:100
cs_param_def_type_t cs_advection_field_get_deftype(const cs_adv_field_t *adv)
Retrieve the type of definition used to set the current advection field structure.
Definition: cs_advection_field.c:308
Definition: cs_param.h:218
void cs_advection_field_get_cell_vector(cs_lnum_t c_id, const cs_adv_field_t *adv, cs_nvec3_t *vect)
Compute the value of the advection field at the cell center.
Definition: cs_advection_field.c:583
void cs_advection_get_courant(const cs_adv_field_t *adv, double dt, cs_real_t courant[])
Compute the Courant number in each cell.
Definition: cs_advection_field.c:1704
void( cs_analytic_func_t)(cs_real_t time, const cs_real_3_t xyz, cs_get_t *retval)
Generic analytic function.
Definition: cs_cdo.h:154
Definition: cs_field_pointer.h:64
cs_real_t cs_advection_field_get_flux_svef(cs_lnum_t v_id, cs_lnum_t e_id, cs_lnum_t f_id, const cs_param_advection_t a_info, const cs_adv_field_t *adv)
Compute the value of the flux of the advection field across the triangle defined by a vertex...
Definition: cs_advection_field.c:1292
void cs_advection_field_summary(const cs_adv_field_t *adv)
Print a summary of a cs_adv_field_t structure.
Definition: cs_advection_field.c:325
cs_real_t cs_real_3_t[3]
vector of 3 floating-point values
Definition: cs_defs.h:308
Definition: cs_advection_field.h:59
Definition: cs_advection_field.h:63
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:292
void cs_advection_field_at_vertices(const cs_adv_field_t *adv, cs_real_t *vtx_values)
Compute the value of the advection field at vertices.
Definition: cs_advection_field.c:819
void cs_advection_field_def_by_value(cs_adv_field_t *adv, const char *val)
Define the value of a cs_adv_field_t structure.
Definition: cs_advection_field.c:445
void cs_advection_field_create_field(cs_adv_field_t *adv)
Create a cs_field_t structure related to an advection field.
Definition: cs_advection_field.c:515
void cs_advection_field_def_by_analytic(cs_adv_field_t *adv, cs_analytic_func_t *func)
Define a cs_adv_field_t structure thanks to an analytic function.
Definition: cs_advection_field.c:468
cs_adv_field_t * cs_advection_field_create(const char *name)
Create and initialize a new advection field structure.
Definition: cs_advection_field.c:149
#define END_C_DECLS
Definition: cs_defs.h:449
cs_real_t cs_advection_field_get_flux_tef(const cs_adv_field_t *adv, const cs_param_advection_t a_info, const cs_cell_mesh_t *cm, short int f, short int e, short int v1, short int v2)
Compute the value of the flux of the advection field across the triangle defined by the two vertices ...
Definition: cs_advection_field.c:1163
void cs_advection_field_set_option(cs_adv_field_t *adv, cs_advection_field_key_t key, const char *keyval)
Set optional parameters related to a cs_adv_field_t structure.
Definition: cs_advection_field.c:376
void cs_advection_field_extra_post(void *input, int mesh_id, int cat_id, int ent_flag[5], cs_lnum_t n_cells, cs_lnum_t n_i_faces, cs_lnum_t n_b_faces, const cs_lnum_t cell_list[], const cs_lnum_t i_face_list[], const cs_lnum_t b_face_list[], const cs_time_step_t *time_step)
Predefined post-processing output for advection fields. Prototype of this function is fixed since it ...
Definition: cs_advection_field.c:1494
bool cs_advection_field_is_cellwise(const cs_adv_field_t *adv)
returns true if the advection field is uniform in each cell otherwise false
Definition: cs_advection_field.c:264
cs_adv_field_t * cs_advection_field_free(cs_adv_field_t *adv)
Free a cs_adv_field_t structure.
Definition: cs_advection_field.c:186
void cs_advection_field_get_flux_dfaces(cs_lnum_t c_id, const cs_param_advection_t a_info, const cs_adv_field_t *adv, cs_real_t *fluxes)
Compute the value of the flux of the advection field across the the dual faces of a cell...
Definition: cs_advection_field.c:1021
cs_param_def_type_t
Definition: cs_param.h:82
bool cs_advection_field_check_name(const cs_adv_field_t *adv, const char *ref_name)
Check if the given advection field has the name ref_name.
Definition: cs_advection_field.c:211