1#ifndef __CS_ADVECTION_FIELD_H__
2#define __CS_ADVECTION_FIELD_H__
62#define CS_ADVECTION_FIELD_POST_COURANT (1 << 0)
306static inline const char *
387 " %s: Invalid mesh location type %d.\n"
388 " Stop retrieving the advection field.\n",
503 const char *ref_name);
void bft_error(const char *const file_name, const int line_num, const int sys_error_code, const char *const format,...)
Calls the error handler (set by bft_error_handler_set() or default).
Definition: bft_error.cpp:193
void cs_advection_field_macb_dface_flux(const cs_macfb_builder_t *macb, const cs_adv_field_t *adv, cs_real_t time_eval, cs_real_t *fluxes)
Compute the value of the flux of the advection field across the the dual faces of a cell MAC face-bas...
Definition: cs_advection_field.cpp:3066
cs_advection_field_status_bit_t
Bit values for specifying the definition/behavior of an advection field.
Definition: cs_advection_field.h:122
@ CS_ADVECTION_FIELD_STEADY
Definition: cs_advection_field.h:140
@ CS_ADVECTION_FIELD_DEFINE_AT_VERTICES
Definition: cs_advection_field.h:142
@ CS_ADVECTION_FIELD_GWF
Definition: cs_advection_field.h:128
@ CS_ADVECTION_FIELD_DEFINE_AT_BOUNDARY_FACES
Definition: cs_advection_field.h:143
@ CS_ADVECTION_FIELD_USER
Definition: cs_advection_field.h:129
@ CS_ADVECTION_FIELD_NAVSTO
Definition: cs_advection_field.h:127
@ CS_ADVECTION_FIELD_LEGACY_FV
Definition: cs_advection_field.h:141
@ CS_ADVECTION_FIELD_TYPE_VELOCITY_VECTOR
Definition: cs_advection_field.h:134
@ CS_ADVECTION_FIELD_TYPE_SCALAR_FLUX
Definition: cs_advection_field.h:135
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.cpp:1349
static 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.h:281
void cs_advection_field_cw_boundary_f2v_flux(const cs_cell_mesh_t *cm, const cs_adv_field_t *adv, short int f, cs_real_t time_eval, cs_real_t *fluxes)
Compute the value of the normal flux of the advection field across the closure of the dual cell relat...
Definition: cs_advection_field.cpp:2384
cs_adv_field_t * cs_advection_field_add_user(const char *name)
Add and initialize a new user-defined advection field structure.
Definition: cs_advection_field.cpp:440
static cs_field_t * cs_advection_field_get_field(const cs_adv_field_t *adv, cs_mesh_location_type_t ml_type)
Get a cs_field_t structure related to an advection field and a mesh location.
Definition: cs_advection_field.h:348
void cs_advection_field_destroy_all(void)
Free all alllocated cs_adv_field_t structures and its related array.
Definition: cs_advection_field.cpp:546
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.cpp:588
void cs_advection_field_init_sharing(const cs_cdo_quantities_t *quant, const cs_cdo_connect_t *connect)
Set shared pointers to main domain members.
Definition: cs_advection_field.cpp:355
void cs_advection_field_update(cs_real_t t_eval, bool cur2prev)
For each cs_adv_field_t structures, update the values of the related field(s)
Definition: cs_advection_field.cpp:3159
cs_xdef_t * cs_advection_field_def_by_array(cs_adv_field_t *adv, cs_flag_t val_location, cs_real_t *array, bool is_owner)
Define a cs_adv_field_t structure thanks to an array of values. If an advanced usage of the definitio...
Definition: cs_advection_field.cpp:846
void cs_advection_field_in_cells(const cs_adv_field_t *adv, cs_real_t time_eval, cs_real_t *cell_values)
Compute the mean-value of the vector-valued field related to the advection field inside each cell.
Definition: cs_advection_field.cpp:1527
cs_adv_field_t * cs_advection_field_add(const char *name, cs_advection_field_status_t status)
Add and initialize a new advection field structure.
Definition: cs_advection_field.cpp:457
cs_real_t * cs_advection_field_divergence_at_vertices(const cs_adv_field_t *adv, cs_real_t t_eval)
Compute the divergence of the advection field at vertices Useful for CDO Vertex-based schemes.
Definition: cs_advection_field.cpp:3329
void cs_advection_field_def_by_dof_func(cs_adv_field_t *adv, cs_flag_t dof_location, cs_dof_func_t *func, void *input)
Define a cs_adv_field_t structure using a cs_dof_func_t.
Definition: cs_advection_field.cpp:804
void cs_advection_field_def_by_analytic(cs_adv_field_t *adv, cs_analytic_func_t *func, void *input)
Define a cs_adv_field_t structure thanks to an analytic function.
Definition: cs_advection_field.cpp:768
void cs_advection_field_set_postprocess(cs_adv_field_t *adv, cs_flag_t post_flag)
Set optional post-processings.
Definition: cs_advection_field.cpp:720
void cs_advection_get_courant(const cs_adv_field_t *adv, cs_real_t dt_cur, cs_real_t courant[])
Compute the Courant number in each cell.
Definition: cs_advection_field.cpp:3286
void cs_advection_field_cw_face_flux(const cs_cell_mesh_t *cm, const cs_adv_field_t *adv, cs_real_t time_eval, cs_real_t *fluxes)
Compute the value of the flux of the advection field across the the (primal) faces of a cell.
Definition: cs_advection_field.cpp:2606
void cs_advection_field_def_boundary_flux_by_field(cs_adv_field_t *adv, cs_field_t *field)
Define the value of the boundary normal flux for the given cs_adv_field_t structure using a field str...
Definition: cs_advection_field.cpp:1103
void cs_advection_get_peclet(const cs_adv_field_t *adv, const cs_property_t *diff, cs_real_t t_eval, cs_real_t peclet[])
Compute the Peclet number in each cell.
Definition: cs_advection_field.cpp:3238
static 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.h:258
void cs_advection_field_def_boundary_flux_by_analytic(cs_adv_field_t *adv, const char *zname, cs_analytic_func_t *func, void *input)
Define the value of the boundary normal flux for the given cs_adv_field_t structure using an analytic...
Definition: cs_advection_field.cpp:982
cs_real_t cs_advection_field_cw_boundary_face_flux(const cs_real_t time_eval, const short int f, const cs_cell_mesh_t *cm, const cs_adv_field_t *adv)
Compute the value of the normal flux of the advection field across a boundary face f (cellwise versio...
Definition: cs_advection_field.cpp:2151
void cs_advection_field_cw_dface_flux(const cs_cell_mesh_t *cm, const cs_adv_field_t *adv, cs_real_t time_eval, 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.cpp:2781
cs_flag_t cs_advection_field_status_t
Definition: cs_advection_field.h:70
static void cs_advection_field_set_status(cs_adv_field_t *adv, cs_advection_field_status_t status)
Set a new status for the given advection field structure.
Definition: cs_advection_field.h:238
void cs_advection_field_create_fields(void)
Create all needed cs_field_t structures related to an advection field.
Definition: cs_advection_field.cpp:1144
int cs_advection_field_get_n_fields(void)
Get the number of allocated cs_adv_field_t structures.
Definition: cs_advection_field.cpp:373
cs_xdef_t * cs_advection_field_def_boundary_flux_by_array(cs_adv_field_t *adv, const char *zname, cs_flag_t val_loc, cs_real_t *array, bool is_owner, bool full_length)
Define the value of the boundary normal flux for the given cs_adv_field_t structure using an array of...
Definition: cs_advection_field.cpp:1030
cs_adv_field_t * cs_advection_field_by_name(const char *name)
Search in the array of advection field structures which one has the name given in argument.
Definition: cs_advection_field.cpp:390
void cs_advection_field_def_by_value(cs_adv_field_t *adv, cs_real_t vector[3])
Define the value of a cs_adv_field_t structure.
static cs_xdef_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.h:327
static const char * cs_advection_field_get_name(const cs_adv_field_t *adv)
Retrieve the name of an advection field.
Definition: cs_advection_field.h:307
void cs_advection_field_finalize_setup(void)
Last stage of the definition of an advection field based on several definitions (i....
Definition: cs_advection_field.cpp:1259
void cs_advection_field_cw_eval_at_xyz(const cs_adv_field_t *adv, const cs_cell_mesh_t *cm, const cs_real_3_t xyz, cs_real_t time_eval, cs_nvec3_t *eval)
Compute the vector-valued interpolation of the advection field at a given location inside a cell.
Definition: cs_advection_field.cpp:1381
void cs_advection_field_at_vertices(const cs_adv_field_t *adv, cs_real_t time_eval, cs_real_t *vtx_values)
Compute the value of the advection field at vertices.
Definition: cs_advection_field.cpp:1719
void cs_advection_field_log_setup(void)
Print all setup information related to cs_adv_field_t structures.
Definition: cs_advection_field.cpp:614
void cs_advection_field_def_by_field(cs_adv_field_t *adv, cs_field_t *field)
Define a cs_adv_field_t structure thanks to a field structure.
Definition: cs_advection_field.cpp:907
void cs_advection_field_def_boundary_flux_by_value(cs_adv_field_t *adv, const char *zname, cs_real_t normal_flux)
Define the value of the boundary normal flux for the given cs_adv_field_t structure.
Definition: cs_advection_field.cpp:946
cs_adv_field_t * cs_advection_field_by_id(int id)
Search in the array of advection field structures which one has the id given in argument.
Definition: cs_advection_field.cpp:417
void cs_advection_field_across_boundary(const cs_adv_field_t *adv, cs_real_t time_eval, cs_real_t *flx_values)
Compute the value of the normal flux of the advection field across the boundary faces.
Definition: cs_advection_field.cpp:1834
#define restrict
Definition: cs_defs.h:145
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
double cs_real_t
Floating-point value.
Definition: cs_defs.h:342
cs_real_t cs_real_3_t[3]
vector of 3 floating-point values
Definition: cs_defs.h:359
#define END_C_DECLS
Definition: cs_defs.h:543
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:335
unsigned short int cs_flag_t
Definition: cs_defs.h:344
cs_field_t * cs_field_by_id(int id)
Return a pointer to a field based on its id.
Definition: cs_field.cpp:2465
#define CS_FLAG_STATE_CELLWISE
Definition: cs_flag.h:104
#define CS_FLAG_STATE_UNIFORM
Definition: cs_flag.h:103
cs_mesh_location_type_t
Definition: cs_mesh_location.h:60
@ CS_MESH_LOCATION_CELLS
Definition: cs_mesh_location.h:63
@ CS_MESH_LOCATION_INTERIOR_FACES
Definition: cs_mesh_location.h:64
@ CS_MESH_LOCATION_VERTICES
Definition: cs_mesh_location.h:66
@ CS_MESH_LOCATION_BOUNDARY_FACES
Definition: cs_mesh_location.h:65
void() cs_dof_func_t(cs_lnum_t n_elts, const cs_lnum_t *elt_ids, bool dense_output, void *input, cs_real_t *retval)
Generic function pointer for computing a quantity at predefined locations such as degrees of freedom ...
Definition: cs_param_types.h:154
void() cs_analytic_func_t(cs_real_t time, cs_lnum_t n_elts, const cs_lnum_t *elt_ids, const cs_real_t *coords, bool dense_output, void *input, cs_real_t *retval)
Generic function pointer for an evaluation relying on an analytic function.
Definition: cs_param_types.h:127
cs_xdef_type_t cs_xdef_get_type(const cs_xdef_t *d)
Retrieve the flag dedicated to the state.
Definition: cs_xdef.cpp:863
cs_xdef_type_t
Definition: cs_xdef.h:114
@ CS_N_XDEF_TYPES
Definition: cs_xdef.h:126
Definition: cs_advection_field.h:151
cs_advection_field_status_t status
Definition: cs_advection_field.h:199
cs_xdef_t ** bdy_flux_defs
Definition: cs_advection_field.h:215
int cell_field_id
Definition: cs_advection_field.h:203
int bdy_field_id
Definition: cs_advection_field.h:204
int int_field_id
Definition: cs_advection_field.h:205
cs_xdef_t * definition
Definition: cs_advection_field.h:210
cs_flag_t post_flag
Definition: cs_advection_field.h:200
int n_bdy_flux_defs
Definition: cs_advection_field.h:214
char *restrict name
Definition: cs_advection_field.h:198
int vtx_field_id
Definition: cs_advection_field.h:202
short int * bdy_def_ids
Definition: cs_advection_field.h:216
int id
Definition: cs_advection_field.h:197
Definition: cs_cdo_connect.h:61
Definition: cs_cdo_quantities.h:139
Set of local quantities and connectivities related to a mesh cell.
Definition: cs_cdo_local.h:203
Field descriptor.
Definition: cs_field.h:131
Definition: cs_macfb_builder.h:54
Definition: cs_defs.h:400
Structure associated to the definition of a property relying on the cs_xdef_t structure.
Structure storing medata for defining a quantity in a very flexible way.
Definition: cs_xdef.h:160
cs_flag_t state
Definition: cs_xdef.h:199