 |
6.3
general documentation
|
|
Go to the documentation of this file. 1 #ifndef __CS_EQUATION_PARAM_H__
2 #define __CS_EQUATION_PARAM_H__
91 #define CS_EQUATION_LOCKED (1 << 0)
92 #define CS_EQUATION_UNSTEADY (1 << 1)
93 #define CS_EQUATION_CONVECTION (1 << 2)
94 #define CS_EQUATION_DIFFUSION (1 << 3)
95 #define CS_EQUATION_CURLCURL (1 << 4)
96 #define CS_EQUATION_GRADDIV (1 << 5)
97 #define CS_EQUATION_REACTION (1 << 6)
98 #define CS_EQUATION_FORCE_VALUES (1 << 7)
99 #define CS_EQUATION_USER_HOOK (1 << 8)
120 #define CS_EQUATION_POST_BALANCE (1 << 0)
121 #define CS_EQUATION_POST_PECLET (1 << 1)
122 #define CS_EQUATION_POST_UPWIND_COEF (1 << 2)
123 #define CS_EQUATION_POST_NORMAL_FLUX (1 << 3)
142 #define CS_EQUATION_ENFORCE_BY_CELLS (1 << 0)
143 #define CS_EQUATION_ENFORCE_BY_DOFS (1 << 1)
144 #define CS_EQUATION_ENFORCE_BY_REFERENCE_VALUE (1 << 2)
1126 assert(eqp != NULL);
1143 assert(eqp != NULL);
1163 assert(eqp != NULL);
1183 assert(eqp != NULL);
1203 assert(eqp != NULL);
1223 assert(eqp != NULL);
1243 assert(eqp != NULL);
1263 assert(eqp != NULL);
1284 assert(eqp != NULL);
1305 assert(eqp != NULL);
1331 assert(eqp != NULL);
1357 if (eqp->
name == NULL)
1359 if (strcmp(eqp->
name, name) == 0)
1448 const char *keyval);
1697 const char *z_name);
1715 const char *z_name);
1730 const char *z_name);
@ CS_EQKEY_HODGE_REAC_ALGO
Definition: cs_equation_param.h:1091
cs_hodge_param_t time_hodgep
Definition: cs_equation_param.h:568
@ CS_EQKEY_SPACE_SCHEME
Definition: cs_equation_param.h:1100
@ CS_EQKEY_BC_WEAK_PENA_COEFF
Definition: cs_equation_param.h:1084
@ CS_EQKEY_ADV_FORMULATION
Definition: cs_equation_param.h:1076
void cs_equation_add_time(cs_equation_param_t *eqp, cs_property_t *property)
Associate a new term related to the time derivative operator for the equation associated to the given...
Definition: cs_equation_param.c:3526
cs_xdef_t * cs_equation_add_source_term_by_analytic(cs_equation_param_t *eqp, const char *z_name, cs_analytic_func_t *func, void *input)
Add a new source term by initializing a cs_xdef_t structure. Case of a definition by an analytical fu...
Definition: cs_equation_param.c:3688
cs_equation_param_t * cs_equation_free_param(cs_equation_param_t *eqp)
Free a cs_equation_param_t.
Definition: cs_equation_param.c:2308
int imligr
Definition: cs_equation_param.h:466
cs_xdef_t ** ic_defs
Definition: cs_equation_param.h:536
cs_xdef_t * cs_equation_find_bc(cs_equation_param_t *eqp, const char *z_name)
Return pointer to existing boundary condition definition structure for the given equation param struc...
Definition: cs_equation_param.c:3321
void cs_equation_add_curlcurl(cs_equation_param_t *eqp, cs_property_t *property, int inversion)
Associate a new term related to the curl-curl operator for the equation associated to the given cs_eq...
Definition: cs_equation_param.c:3469
@ CS_EQKEY_PRECOND
Definition: cs_equation_param.h:1097
int iwgrec
Definition: cs_equation_param.h:468
@ CS_EQUATION_TYPE_USER
Definition: cs_equation_param.h:188
Structure storing medata for defining a quantity in a very flexible way.
Definition: cs_xdef.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 elt_ids is optional....
Definition: cs_param_types.h:94
cs_param_advection_strategy_t adv_strategy
Definition: cs_equation_param.h:660
void cs_equation_add_xdef_bc(cs_equation_param_t *eqp, cs_xdef_t *xdef)
Set a boundary condition from an existing cs_xdef_t structure The lifecycle of the cs_xdef_t structur...
Definition: cs_equation_param.c:2996
cs_param_bc_enforce_t
Definition: cs_param_types.h:469
cs_param_advection_form_t adv_formulation
Definition: cs_equation_param.h:658
cs_real_t theta
Definition: cs_equation_param.h:571
cs_flag_t process_flag
Definition: cs_equation_param.h:234
int ndircl
Definition: cs_equation_param.h:455
cs_equation_param_t * cs_equation_create_param(const char *name, cs_equation_type_t type, int dim, cs_param_bc_type_t default_bc)
Create a cs_equation_param_t structure.
Definition: cs_equation_param.c:1853
#define CS_EQUATION_FORCE_VALUES
Add an algebraic manipulation to set the value of a given set of interior degrees of freedom.
Definition: cs_equation_param.h:98
#define restrict
Definition: cs_defs.h:124
void cs_equation_add_diffusion(cs_equation_param_t *eqp, cs_property_t *property)
Associate a new term related to the Laplacian operator for the equation associated to the given cs_eq...
Definition: cs_equation_param.c:3443
cs_flag_t flag
Definition: cs_equation_param.h:228
cs_param_space_scheme_t space_scheme
Definition: cs_equation_param.h:237
double epsilo
Definition: cs_equation_param.h:473
void cs_equation_add_advection(cs_equation_param_t *eqp, cs_adv_field_t *adv_field)
Associate a new term related to the advection operator for the equation associated to the given cs_eq...
Definition: cs_equation_param.c:3551
int space_poly_degree
Definition: cs_equation_param.h:243
@ CS_EQKEY_ADV_EXTRAPOL
Definition: cs_equation_param.h:1075
cs_equation_type_t type
Definition: cs_equation_param.h:208
double epsrgr
Definition: cs_equation_param.h:475
int verbosity
Definition: cs_equation_param.h:220
#define CS_EQUATION_USER_HOOK
Activate a user hook to get a fine control of the discretization process during the cellwise building...
Definition: cs_equation_param.h:99
@ CS_EQUATION_TYPE_MAXWELL
Definition: cs_equation_param.h:183
#define END_C_DECLS
Definition: cs_defs.h:493
@ CS_EQKEY_N_KEYS
Definition: cs_equation_param.h:1105
cs_param_time_scheme_t time_scheme
Definition: cs_equation_param.h:570
@ CS_EQUATION_TYPE_NAVSTO
Definition: cs_equation_param.h:184
cs_param_dof_reduction_t dof_reduction
Definition: cs_equation_param.h:238
@ CS_EQKEY_BC_ENFORCEMENT
Definition: cs_equation_param.h:1081
cs_real_t upwind_portion
Definition: cs_equation_param.h:662
cs_real_t * enforcement_ref_value
Definition: cs_equation_param.h:767
@ CS_EQKEY_ADV_UPWIND_PORTION
Definition: cs_equation_param.h:1079
cs_property_t ** reaction_properties
Definition: cs_equation_param.h:687
cs_param_advection_strategy_t
Choice of how to handle the advection term in an equation.
Definition: cs_param_types.h:344
int istat
Definition: cs_equation_param.h:453
cs_xdef_t ** volume_mass_injections
Definition: cs_equation_param.h:724
double cs_real_t
Floating-point value.
Definition: cs_defs.h:304
@ CS_EQKEY_SOLVER_FAMILY
Definition: cs_equation_param.h:1099
void cs_equation_enforce_vertex_dofs(cs_equation_param_t *eqp, cs_lnum_t n_elts, const cs_lnum_t elt_ids[], const cs_real_t ref_value[], const cs_real_t elt_values[])
Add an enforcement of the value of degrees of freedom located at mesh vertices. The spatial discretiz...
Definition: cs_equation_param.c:4021
@ CS_EQKEY_BC_QUADRATURE
Definition: cs_equation_param.h:1082
cs_real_t weak_pena_bc_coeff
Definition: cs_equation_param.h:521
#define BEGIN_C_DECLS
Definition: cs_defs.h:492
@ CS_EQUATION_TYPE_GROUNDWATER
Definition: cs_equation_param.h:182
cs_param_advection_extrapol_t adv_extrapol
Definition: cs_equation_param.h:661
cs_property_t * curlcurl_property
Definition: cs_equation_param.h:602
@ CS_EQKEY_OMP_ASSEMBLY_STRATEGY
Definition: cs_equation_param.h:1096
@ CS_EQKEY_HODGE_DIFF_COEF
Definition: cs_equation_param.h:1089
cs_lnum_t * enforced_cell_ids
Definition: cs_equation_param.h:770
Structure storing all metadata/parameters related to the usage of a discrete Hodge operator.
Definition: cs_hodge.h:165
int imrgra
Definition: cs_equation_param.h:465
cs_real_t strong_pena_bc_coeff
Definition: cs_equation_param.h:520
@ CS_EQKEY_BC_STRONG_PENA_COEFF
Definition: cs_equation_param.h:1083
void cs_equation_enforce_value_on_cell_selection(cs_equation_param_t *eqp, cs_lnum_t n_elts, const cs_lnum_t elt_ids[], const cs_real_t ref_value[], const cs_real_t elt_values[])
Add an enforcement of the value related to the degrees of freedom associated to the list of selected ...
Definition: cs_equation_param.c:4100
@ CS_EQKEY_VERBOSITY
Definition: cs_equation_param.h:1103
cs_param_dof_reduction_t
Definition: cs_param_types.h:199
#define CS_EQUATION_GRADDIV
The term related to the grad-div operator is needed.
Definition: cs_equation_param.h:96
cs_xdef_t ** source_terms
Definition: cs_equation_param.h:704
int n_volume_mass_injections
Definition: cs_equation_param.h:723
void cs_equation_param_copy_from(const cs_equation_param_t *ref, cs_equation_param_t *dst, bool copy_fid)
Copy the settings from one cs_equation_param_t structure to another one. The name is not copied.
Definition: cs_equation_param.c:2044
cs_property_t * time_property
Definition: cs_equation_param.h:569
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:119
double climgr
Definition: cs_equation_param.h:476
#define CS_EQUATION_UNSTEADY
Unsteady term is needed.
Definition: cs_equation_param.h:92
void cs_equation_add_graddiv(cs_equation_param_t *eqp, cs_property_t *property)
Associate a new term related to the grad-div operator for the equation associated to the given cs_equ...
Definition: cs_equation_param.c:3500
#define CS_EQUATION_CONVECTION
Convection term is needed.
Definition: cs_equation_param.h:93
cs_param_time_scheme_t
Definition: cs_param_types.h:234
@ CS_EQKEY_ADV_SCHEME
Definition: cs_equation_param.h:1077
Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources.
Definition: cs_equation_param.h:201
cs_flag_t enforcement_type
Definition: cs_equation_param.h:766
int cs_equation_add_reaction(cs_equation_param_t *eqp, cs_property_t *property)
Associate a new term related to the reaction operator for the equation associated to the given cs_equ...
Definition: cs_equation_param.c:3601
double thetav
Definition: cs_equation_param.h:470
cs_property_t * adv_scaling_property
Definition: cs_equation_param.h:664
@ CS_EQKEY_ITSOL_EPS
Definition: cs_equation_param.h:1093
cs_real_t * enforced_cell_values
Definition: cs_equation_param.h:771
void cs_equation_param_clear(cs_equation_param_t *eqp)
Free the contents of a cs_equation_param_t.
Definition: cs_equation_param.c:2228
int icoupl
Definition: cs_equation_param.h:469
int iconv
Definition: cs_equation_param.h:452
cs_xdef_t * cs_equation_add_source_term_by_dof_func(cs_equation_param_t *eqp, const char *z_name, cs_flag_t loc_flag, cs_dof_func_t *func, void *input)
Add a new source term by initializing a cs_xdef_t structure. Case of a definition by a DoF function.
Definition: cs_equation_param.c:3745
int n_ic_defs
Definition: cs_equation_param.h:535
cs_param_assemble_omp_strategy_t
Definition: cs_param_cdo.h:91
char *restrict name
Definition: cs_equation_param.h:207
@ CS_EQUATION_TYPE_THERMAL
Definition: cs_equation_param.h:186
cs_property_t * diffusion_property
Definition: cs_equation_param.h:586
int ischcv
Definition: cs_equation_param.h:460
@ CS_EQKEY_DO_LUMPING
Definition: cs_equation_param.h:1085
cs_xdef_t * 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:2950
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, bool is_owner, cs_lnum_t *index)
Add a new source term by initializing a cs_xdef_t structure. Case of a definition by an array.
Definition: cs_equation_param.c:3806
int idircl
Definition: cs_equation_param.h:454
double blend_st
Definition: cs_equation_param.h:472
@ CS_EQKEY_DOF_REDUCTION
Definition: cs_equation_param.h:1086
cs_lnum_t * enforced_dof_ids
Definition: cs_equation_param.h:774
int dim
Definition: cs_equation_param.h:209
@ CS_EQKEY_ITSOL_RESNORM_TYPE
Definition: cs_equation_param.h:1095
int isstpc
Definition: cs_equation_param.h:462
int ircflu
Definition: cs_equation_param.h:467
int nswrgr
Definition: cs_equation_param.h:463
cs_param_assemble_omp_strategy_t omp_assembly_choice
Definition: cs_equation_param.h:800
cs_param_advection_extrapol_t
Choice of how to extrapolate the advection field in the advection term.
Definition: cs_param_types.h:378
Structure associated to the definition of a property relying on the cs_xdef_t structure.
cs_param_bc_enforce_t default_enforcement
Definition: cs_equation_param.h:519
@ CS_PARAM_ADVECTION_IMPLICIT_LINEARIZED
Definition: cs_param_types.h:347
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:298
double blencv
Definition: cs_equation_param.h:471
void cs_equation_remove_bc(cs_equation_param_t *eqp, const char *z_name)
Remove boundary condition from the given equation param structure for a given zone.
Definition: cs_equation_param.c:3358
@ CS_EQUATION_TYPE_SOLIDIFICATION
Definition: cs_equation_param.h:187
int idften
Definition: cs_equation_param.h:458
cs_xdef_t * 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:3164
cs_property_t * graddiv_property
Definition: cs_equation_param.h:618
int iwarni
Definition: cs_equation_param.h:221
int n_source_terms
Definition: cs_equation_param.h:703
@ CS_EQKEY_AMG_TYPE
Definition: cs_equation_param.h:1080
cs_param_advection_scheme_t
Definition: cs_param_types.h:311
@ CS_EQKEY_ITSOL_MAX_ITER
Definition: cs_equation_param.h:1094
int ibdtso
Definition: cs_equation_param.h:461
cs_param_sles_t sles_param
Definition: cs_equation_param.h:789
cs_xdef_t * cs_equation_add_volume_mass_injection_by_qov(cs_equation_param_t *eqp, const char *z_name, double *quantity)
Add a new volume mass injection definition source term by initializing a cs_xdef_t structure,...
Definition: cs_equation_param.c:3916
int iswdyn
Definition: cs_equation_param.h:459
cs_param_space_scheme_t
Type of numerical scheme for the discretization in space.
Definition: cs_param_types.h:172
int n_bc_defs
Definition: cs_equation_param.h:516
void cs_equation_summary_param(const cs_equation_param_t *eqp)
Summary of a cs_equation_param_t structure.
Definition: cs_equation_param.c:2518
cs_lnum_t n_enforced_dofs
Definition: cs_equation_param.h:773
bool do_lumping
Definition: cs_equation_param.h:550
void cs_equation_param_last_stage(cs_equation_param_t *eqp)
Last modification of the cs_equation_param_t structure before launching the computation.
Definition: cs_equation_param.c:2486
cs_hodge_param_t curlcurl_hodgep
Definition: cs_equation_param.h:601
cs_xdef_t * cs_equation_add_volume_mass_injection_by_value(cs_equation_param_t *eqp, const char *z_name, double *val)
Add a new volume mass injection definition source term by initializing a cs_xdef_t structure,...
Definition: cs_equation_param.c:3868
cs_lnum_t n_enforced_cells
Definition: cs_equation_param.h:769
int nswrsm
Definition: cs_equation_param.h:464
double relaxv
Definition: cs_equation_param.h:478
cs_param_bc_type_t
Definition: cs_param_types.h:426
@ CS_EQKEY_ADV_STRATEGY
Definition: cs_equation_param.h:1078
int n_reaction_terms
Definition: cs_equation_param.h:686
#define CS_EQUATION_REACTION
Reaction term is needed.
Definition: cs_equation_param.h:97
int idifft
Definition: cs_equation_param.h:457
#define CS_EQUATION_DIFFUSION
Diffusion term is needed. A scalar-/vector-valued Laplacian with div .grad.
Definition: cs_equation_param.h:94
cs_param_advection_scheme_t adv_scheme
Definition: cs_equation_param.h:659
cs_xdef_t ** bc_defs
Definition: cs_equation_param.h:517
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:2332
int idiff
Definition: cs_equation_param.h:456
void cs_equation_add_sliding_condition(cs_equation_param_t *eqp, const char *z_name)
Define and initialize a new structure to set a sliding boundary condition related to the given equati...
Definition: cs_equation_param.c:3402
unsigned short int cs_flag_t
Definition: cs_defs.h:306
@ CS_EQKEY_HODGE_DIFF_ALGO
Definition: cs_equation_param.h:1088
cs_xdef_t * cs_equation_add_bc_by_dof_func(cs_equation_param_t *eqp, const cs_param_bc_type_t bc_type, const char *z_name, cs_flag_t loc_flag, cs_dof_func_t *func, void *input)
Define and initialize a new structure to set a boundary condition related to the given cs_equation_pa...
Definition: cs_equation_param.c:3244
cs_param_bc_type_t default_bc
Definition: cs_equation_param.h:515
cs_equation_key_t
List of available keys for setting the parameters of an equation.
Definition: cs_equation_param.h:1073
cs_equation_type_t
Type of equations managed by the solver.
Definition: cs_equation_param.h:180
cs_xdef_t * cs_equation_add_volume_mass_injection_by_analytic(cs_equation_param_t *eqp, const char *z_name, cs_analytic_func_t *func, void *input)
Add a new volume mass injection definition source term by initializing a cs_xdef_t structure,...
Definition: cs_equation_param.c:3964
@ CS_EQUATION_TYPE_PREDEFINED
Definition: cs_equation_param.h:185
cs_hodge_param_t diffusion_hodgep
Definition: cs_equation_param.h:585
@ CS_EQKEY_HODGE_TIME_ALGO
Definition: cs_equation_param.h:1090
void cs_equation_param_set_sles(cs_equation_param_t *eqp)
Set parameters for initializing SLES structures used for the resolution of the linear system....
Definition: cs_equation_param.c:2368
double extrag
Definition: cs_equation_param.h:477
cs_hodge_param_t reaction_hodgep
Definition: cs_equation_param.h:685
Definition: cs_advection_field.h:149
Structure storing all metadata related to the resolution of a linear system with an iterative solver.
Definition: cs_param_types.h:736
double epsrsm
Definition: cs_equation_param.h:474
cs_xdef_t * 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:2903
@ CS_EQKEY_ITSOL
Definition: cs_equation_param.h:1092
cs_xdef_t * cs_equation_add_source_term_by_val(cs_equation_param_t *eqp, const char *z_name, cs_real_t *val)
Add a new source term by initializing a cs_xdef_t structure. Case of a definition by a constant value...
Definition: cs_equation_param.c:3639
cs_xdef_t * 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:3024
cs_adv_field_t * adv_field
Definition: cs_equation_param.h:663
@ CS_EQKEY_TIME_THETA
Definition: cs_equation_param.h:1102
@ CS_PARAM_ADVECTION_IMPLICIT_FULL
Definition: cs_param_types.h:346
@ CS_EQUATION_N_TYPES
Definition: cs_equation_param.h:190
@ CS_EQKEY_SLES_VERBOSITY
Definition: cs_equation_param.h:1098
#define CS_EQUATION_CURLCURL
The term related to the curl-curl operator is needed.
Definition: cs_equation_param.h:95
cs_xdef_t * 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:2855
cs_param_advection_form_t
Definition: cs_param_types.h:267
@ CS_EQKEY_EXTRA_OP
Definition: cs_equation_param.h:1087
bool cs_equation_param_has_robin_bc(const cs_equation_param_t *eqp)
Ask if the parameter settings of the equation has requested the treatment of Robin boundary condition...
Definition: cs_equation_param.c:2824
@ CS_EQKEY_TIME_SCHEME
Definition: cs_equation_param.h:1101
void cs_equation_add_advection_scaling_property(cs_equation_param_t *eqp, cs_property_t *property)
Associate a scaling property to the advection.
Definition: cs_equation_param.c:3575
cs_xdef_t * 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, bool is_owner, 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:3085
cs_hodge_param_t graddiv_hodgep
Definition: cs_equation_param.h:617
cs_real_t * enforced_dof_values
Definition: cs_equation_param.h:775