1 #ifndef __CS_EQUATION_PARAM_H__ 2 #define __CS_EQUATION_PARAM_H__ 74 #define CS_EQUATION_LOCKED (1 << 0) // 1 75 #define CS_EQUATION_UNSTEADY (1 << 1) // 2 76 #define CS_EQUATION_CONVECTION (1 << 2) // 4 77 #define CS_EQUATION_DIFFUSION (1 << 3) // 8 78 #define CS_EQUATION_REACTION (1 << 4) // 16 93 #define CS_EQUATION_POST_PECLET (1 << 0) // 1 94 #define CS_EQUATION_POST_UPWIND_COEF (1 << 1) // 2 cs_xdef_t * cs_equation_add_source_term_by_analytic(cs_equation_param_t *eqp, const char *z_name, cs_analytic_func_t *ana, void *input)
Define a new source term structure and initialize it by an analytical function.
Definition: cs_equation_param.c:1751
Definition: cs_equation_param.h:549
cs_adv_field_t * adv_field
Definition: cs_equation_param.h:304
Definition: cs_equation_param.h:543
Definition: cs_equation_param.h:557
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 compact, void *input, cs_real_t *retval)
Generic function pointer for an analytic function elt_ids is optional. If not NULL, it enables to access in coords at the right location and the same thing to fill retval if compact is set to false.
Definition: cs_param.h:66
Definition: cs_equation_param.h:141
cs_real_t theta
Definition: cs_equation_param.h:253
Definition: cs_equation_param.h:556
Definition: cs_advection_field.h:59
cs_flag_t flag
Definition: cs_equation_param.h:166
cs_equation_solver_class_t solver_class
Definition: cs_equation_param.h:224
cs_flag_t process_flag
Definition: cs_equation_param.h:172
cs_xdef_t ** ic_defs
Definition: cs_equation_param.h:269
cs_param_advection_form_t adv_formulation
Definition: cs_equation_param.h:302
Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources...
Definition: cs_equation_param.h:150
Definition: cs_equation_param.h:551
cs_param_hodge_t time_hodge
Definition: cs_equation_param.h:250
cs_equation_type_t type
Definition: cs_equation_param.h:157
void cs_equation_add_bc_by_array(cs_equation_param_t *eqp, const cs_param_bc_type_t bc_type, const char *z_name, cs_flag_t loc, cs_real_t *array, cs_lnum_t *index)
Define and initialize a new structure to set a boundary condition related to the given equation struc...
Definition: cs_equation_param.c:1494
Definition: cs_equation_param.h:565
cs_param_advection_scheme_t
Definition: cs_param.h:236
static bool cs_equation_param_has_time(const cs_equation_param_t *eqp)
Ask if the parameters of the equation needs an unsteady term.
Definition: cs_equation_param.h:647
cs_param_dof_reduction_t dof_reduction
Definition: cs_equation_param.h:176
cs_param_hodge_t diffusion_hodge
Definition: cs_equation_param.h:283
cs_param_space_scheme_t space_scheme
Definition: cs_equation_param.h:175
#define BEGIN_C_DECLS
Definition: cs_defs.h:461
static bool cs_equation_param_has_diffusion(const cs_equation_param_t *eqp)
Ask if the parameters of the equation needs a diffusion term.
Definition: cs_equation_param.h:584
int space_poly_degree
Definition: cs_equation_param.h:181
cs_property_t ** reaction_properties
Definition: cs_equation_param.h:327
void cs_equation_add_bc_by_analytic(cs_equation_param_t *eqp, const cs_param_bc_type_t bc_type, const char *z_name, cs_analytic_func_t *analytic, void *input)
Define and initialize a new structure to set a boundary condition related to the given equation param...
Definition: cs_equation_param.c:1553
Definition: cs_equation_param.h:546
Definition: cs_equation_param.h:545
cs_xdef_t * cs_equation_add_source_term_by_val(cs_equation_param_t *eqp, const char *z_name, cs_real_t *val)
Define a new source term structure and initialize it by value.
Definition: cs_equation_param.c:1703
cs_param_time_scheme_t time_scheme
Definition: cs_equation_param.h:252
cs_param_advection_form_t
Definition: cs_param.h:205
Definition: cs_equation_param.h:550
cs_equation_param_t * cs_equation_create_param(cs_equation_type_t type, int dim, cs_param_bc_type_t default_bc)
Create a cs_equation_param_t.
Definition: cs_equation_param.c:370
void cs_equation_param_set_sles(const char *eqname, cs_equation_param_t *eqp, int field_id)
Set parameters for initializing SLES structures used for the resolution of the linear system...
Definition: cs_equation_param.c:886
double cs_real_t
Floating-point value.
Definition: cs_defs.h:297
#define CS_EQUATION_UNSTEADY
Unsteady term is needed.
Definition: cs_equation_param.h:75
Definition: cs_equation_param.h:561
cs_property_t * time_property
Definition: cs_equation_param.h:251
Definition: cs_equation_param.h:140
Definition: cs_equation_param.h:563
void cs_equation_add_bc_by_value(cs_equation_param_t *eqp, const cs_param_bc_type_t bc_type, const char *z_name, cs_real_t *values)
Define and initialize a new structure to set a boundary condition related to the given equation struc...
Definition: cs_equation_param.c:1449
Definition: cs_equation_param.h:564
cs_xdef_t ** source_terms
Definition: cs_equation_param.h:344
#define CS_EQUATION_CONVECTION
Convection term is needed.
Definition: cs_equation_param.h:76
Definition: cs_equation_param.h:562
cs_param_itsol_t itsol_info
Definition: cs_equation_param.h:225
void cs_equation_add_ic_by_analytic(cs_equation_param_t *eqp, const char *z_name, cs_analytic_func_t *analytic, void *input)
Define the initial condition for the unknown related to this equation. This definition can be done on...
Definition: cs_equation_param.c:1405
Definition: cs_equation_param.h:544
Definition: cs_equation_param.h:553
int cs_equation_add_reaction(cs_equation_param_t *eqp, cs_property_t *property)
Define and initialize a new structure to store parameters related to a reaction term.
Definition: cs_equation_param.c:1670
Definition: cs_equation_param.h:547
Definition: cs_equation_param.h:554
int dim
Definition: cs_equation_param.h:158
Definition: cs_equation_param.h:559
Definition: cs_equation_param.h:542
cs_property_t * diffusion_property
Definition: cs_equation_param.h:284
Definition: cs_equation_param.h:555
cs_param_time_scheme_t
Definition: cs_param.h:177
cs_param_dof_reduction_t
Definition: cs_param.h:148
Definition: cs_equation_param.h:548
int n_ic_defs
Definition: cs_equation_param.h:268
Structure storing medata for defining a quantity in a very flexible way.
Definition: cs_xdef.h:122
int n_source_terms
Definition: cs_equation_param.h:343
cs_equation_key_t
List of available keys for setting the parameters of an equation.
Definition: cs_equation_param.h:540
Definition: cs_equation_param.h:119
cs_equation_type_t
Type of equations managed by the solver.
Definition: cs_equation_param.h:116
cs_param_bc_type_t
Definition: cs_param.h:273
void cs_equation_add_ic_by_value(cs_equation_param_t *eqp, const char *z_name, cs_real_t *val)
Define the initial condition for the unknown related to this equation This definition can be done on ...
Definition: cs_equation_param.c:1318
void cs_equation_add_time(cs_equation_param_t *eqp, cs_property_t *property)
Define and initialize a new structure to store parameters related to an unsteady term.
Definition: cs_equation_param.c:1624
Definition: cs_equation_param.h:139
void cs_equation_add_advection(cs_equation_param_t *eqp, cs_adv_field_t *adv_field)
Define and initialize a new structure to store parameters related to an advection term...
Definition: cs_equation_param.c:1646
int verbosity
Definition: cs_equation_param.h:159
Definition: cs_equation_param.h:118
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:293
int sles_verbosity
Definition: cs_equation_param.h:160
int n_reaction_terms
Definition: cs_equation_param.h:326
cs_param_advection_scheme_t adv_scheme
Definition: cs_equation_param.h:303
int n_bc_defs
Definition: cs_equation_param.h:206
Definition: cs_equation_param.h:121
#define END_C_DECLS
Definition: cs_defs.h:462
cs_xdef_t * cs_equation_add_source_term_by_array(cs_equation_param_t *eqp, const char *z_name, cs_flag_t loc, cs_real_t *array, cs_lnum_t *index)
Define a new source term defined by an array.
Definition: cs_equation_param.c:1806
unsigned short int cs_flag_t
Definition: cs_defs.h:299
cs_param_bc_enforce_t enforcement
Definition: cs_equation_param.h:205
void cs_equation_set_param(cs_equation_param_t *eqp, cs_equation_key_t key, const char *keyval)
Set a parameter attached to a keyname in a cs_equation_param_t structure.
Definition: cs_equation_param.c:519
cs_equation_solver_class_t
Class of iterative solvers to consider for solver the linear system.
Definition: cs_equation_param.h:137
bool do_lumping
Definition: cs_equation_param.h:254
cs_param_bc_type_t default_bc
Definition: cs_equation_param.h:204
cs_xdef_t ** bc_defs
Definition: cs_equation_param.h:207
Definition: cs_equation_param.h:552
cs_equation_param_t * cs_equation_free_param(cs_equation_param_t *eqp)
Free a cs_equation_param_t.
Definition: cs_equation_param.c:461
cs_param_hodge_t reaction_hodge
Definition: cs_equation_param.h:325
#define CS_EQUATION_REACTION
Reaction term is needed.
Definition: cs_equation_param.h:78
#define CS_EQUATION_DIFFUSION
Diffusion term is needed.
Definition: cs_equation_param.h:77
Definition: cs_equation_param.h:560
cs_param_space_scheme_t
Type of numerical scheme for the discretization in space.
Definition: cs_param.h:122
Definition: cs_param_cdo.h:97
static bool cs_equation_param_has_reaction(const cs_equation_param_t *eqp)
Ask if the parameters of the equation needs a reaction term.
Definition: cs_equation_param.h:626
Definition: cs_equation_param.h:558
static bool cs_equation_param_has_sourceterm(const cs_equation_param_t *eqp)
Ask if the parameters of the equation needs a source term.
Definition: cs_equation_param.h:668
void cs_equation_summary_param(const char *eqname, const cs_equation_param_t *eqp)
Summary of a cs_equation_param_t structure.
Definition: cs_equation_param.c:1075
Definition: cs_property.h:63
cs_param_bc_enforce_t
Definition: cs_param.h:310
void cs_equation_add_ic_by_qov(cs_equation_param_t *eqp, const char *z_name, double quantity)
Define the initial condition for the unknown related to this equation This definition can be done on ...
Definition: cs_equation_param.c:1362
void cs_equation_add_diffusion(cs_equation_param_t *eqp, cs_property_t *property)
Define and initialize a new structure to store parameters related to a diffusion term.
Definition: cs_equation_param.c:1597
Structure storing all metadata related to the resolution of a linear system with an iterative solver...
Definition: cs_param.h:372
Definition: cs_equation_param.h:120
static bool cs_equation_param_has_convection(const cs_equation_param_t *eqp)
Ask if the parameters of the equation needs a convection term.
Definition: cs_equation_param.h:605