 |
6.3
general documentation
|
|
Go to the documentation of this file. 1 #ifndef __CS_NAVSTO_PARAM_H__
2 #define __CS_NAVSTO_PARAM_H__
50 #define CS_NAVSTO_STREAM_EQNAME "streamfunction_eq"
@ CS_NSKEY_ADVECTION_FORMULATION
Definition: cs_navsto_param.h:880
void cs_navsto_set_fixed_walls(cs_navsto_param_t *nsp)
Add the definition of boundary conditions related to a fixed wall into the set of parameters for the ...
Definition: cs_navsto_param.c:1549
cs_param_time_scheme_t time_scheme
Definition: cs_navsto_param.h:575
cs_real_t il_algo_atol
Definition: cs_navsto_param.h:394
@ CS_NSKEY_SPACE_SCHEME
Definition: cs_navsto_param.h:899
@ CS_NAVSTO_MODEL_CORIOLIS_EFFECTS
Definition: cs_navsto_param.h:135
int n_pressure_bc_defs
Definition: cs_navsto_param.h:734
@ CS_NSKEY_MAX_NL_ALGO_ITER
Definition: cs_navsto_param.h:890
cs_xdef_t * cs_navsto_add_pressure_ic_by_value(cs_navsto_param_t *nsp, const char *z_name, cs_real_t *val)
Define the initial condition for the pressure unknowns. This definition can be done on a specified me...
Definition: cs_navsto_param.c:1449
@ CS_NAVSTO_POST_VELOCITY_DIVERGENCE
Definition: cs_navsto_param.h:175
@ CS_NSKEY_ADVECTION_STRATEGY
Definition: cs_navsto_param.h:882
cs_xdef_t * cs_navsto_add_source_term_by_analytic(cs_navsto_param_t *nsp, const char *z_name, cs_analytic_func_t *ana, void *input)
Define a new source term structure defined by an analytical function.
Definition: cs_navsto_param.c:2123
cs_real_t il_algo_rtol
Definition: cs_navsto_param.h:388
@ CS_NSKEY_QUADRATURE
Definition: cs_navsto_param.h:897
cs_xdef_t ** velocity_ic_defs
Definition: cs_navsto_param.h:668
cs_navsto_param_post_bit_t
Bit values for additional generic postprocessing related to the Navier-Stokes module....
Definition: cs_navsto_param.h:173
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_NAVSTO_SLES_EQ_WITHOUT_BLOCK
Definition: cs_navsto_param.h:333
cs_xdef_t * cs_navsto_set_velocity_inlet_by_analytic(cs_navsto_param_t *nsp, const char *z_name, cs_analytic_func_t *ana, void *input)
Define the velocity field for an inlet boundary using an analytical function.
Definition: cs_navsto_param.c:1909
@ CS_NSKEY_SLES_STRATEGY
Definition: cs_navsto_param.h:898
@ CS_NSKEY_MAX_OUTER_ITER
Definition: cs_navsto_param.h:891
cs_xdef_t * cs_navsto_add_source_term_by_array(cs_navsto_param_t *nsp, const char *z_name, cs_flag_t loc, cs_real_t *array, bool is_owner, cs_lnum_t *index)
Define a new source term structure defined by an array.
Definition: cs_navsto_param.c:2187
@ CS_NAVSTO_COUPLING_MONOLITHIC
Definition: cs_navsto_param.h:475
cs_quadrature_type_t qtype
Definition: cs_navsto_param.h:604
Structure storing the parameters related to the resolution of the tubulence modelling....
Definition: cs_cdo_turbulence.h:63
@ CS_NAVSTO_SLES_MULTIPLICATIVE_GMRES_BY_BLOCK
Definition: cs_navsto_param.h:337
@ CS_NSKEY_MAX_IL_ALGO_ITER
Definition: cs_navsto_param.h:889
@ CS_NSKEY_IL_ALGO_VERBOSITY
Definition: cs_navsto_param.h:888
cs_xdef_t * cs_navsto_add_source_term_by_val(cs_navsto_param_t *nsp, const char *z_name, cs_real_t *val)
Define a new source term structure defined by a constant value.
Definition: cs_navsto_param.c:2157
Structure storing the parameters related to the resolution of the Navier-Stokes system.
Definition: cs_navsto_param.h:487
cs_navsto_param_model_t
Describe the system of equations related to the Navier-Stokes to be solved.
Definition: cs_navsto_param.h:80
@ CS_NSKEY_IL_ALGO_RTOL
Definition: cs_navsto_param.h:887
Structure storing information related to the "physical" boundaries associated with the computational ...
Definition: cs_boundary.h:151
@ CS_NSKEY_THERMAL_TOLERANCE
Definition: cs_navsto_param.h:900
@ CS_NAVSTO_MODEL_OSEEN
Definition: cs_navsto_param.h:83
const char * cs_navsto_param_get_coupling_name(cs_navsto_param_coupling_t coupling)
Retrieve the name of the coupling algorithm.
Definition: cs_navsto_param.c:1261
#define END_C_DECLS
Definition: cs_defs.h:493
@ CS_NSKEY_GD_SCALE_COEF
Definition: cs_navsto_param.h:884
cs_navsto_param_model_t model
Definition: cs_navsto_param.h:499
@ CS_NAVSTO_POST_VORTICITY
Definition: cs_navsto_param.h:177
const cs_boundary_t * boundaries
Definition: cs_navsto_param.h:699
cs_navsto_param_coupling_t coupling
Definition: cs_navsto_param.h:559
@ CS_NAVSTO_SLES_GKB_SATURNE
Definition: cs_navsto_param.h:336
@ CS_NAVSTO_POST_STREAM_FUNCTION
Definition: cs_navsto_param.h:179
cs_param_advection_strategy_t
Choice of how to handle the advection term in an equation.
Definition: cs_param_types.h:344
@ CS_NAVSTO_SLES_MUMPS
Definition: cs_navsto_param.h:338
@ CS_NSKEY_ADVECTION_EXTRAPOL
Definition: cs_navsto_param.h:879
cs_navsto_param_model_bit_t
Bit values for additional physical modelling related to the Navier-Stokes system of equations.
Definition: cs_navsto_param.h:131
double cs_real_t
Floating-point value.
Definition: cs_defs.h:304
@ CS_NSKEY_NL_ALGO_ATOL
Definition: cs_navsto_param.h:893
@ CS_NAVSTO_SLES_ADDITIVE_GMRES_BY_BLOCK
Definition: cs_navsto_param.h:329
#define BEGIN_C_DECLS
Definition: cs_defs.h:492
@ CS_NAVSTO_MODEL_GRAVITY_EFFECTS
Definition: cs_navsto_param.h:134
@ CS_NAVSTO_POST_HELICITY
Definition: cs_navsto_param.h:180
cs_lnum_t * solid_cell_ids
Definition: cs_navsto_param.h:762
bool pressure_ic_is_owner
Definition: cs_navsto_param.h:684
@ CS_NAVSTO_SLES_UZAWA_AL
Definition: cs_navsto_param.h:340
cs_real_t theta
Definition: cs_navsto_param.h:576
@ CS_NAVSTO_SLES_DIAG_SCHUR_GMRES
Definition: cs_navsto_param.h:332
@ CS_NAVSTO_MODEL_STEADY
Definition: cs_navsto_param.h:133
cs_real_t il_algo_dtol
Definition: cs_navsto_param.h:400
@ CS_NAVSTO_N_MODELS
Definition: cs_navsto_param.h:86
@ CS_NAVSTO_N_COUPLINGS
Definition: cs_navsto_param.h:478
cs_flag_t cs_navsto_param_post_flag_t
Definition: cs_navsto_param.h:57
cs_real_t nl_algo_verbosity
Definition: cs_navsto_param.h:452
cs_param_dof_reduction_t
Definition: cs_param_types.h:199
cs_xdef_t * cs_navsto_set_velocity_inlet_by_value(cs_navsto_param_t *nsp, const char *z_name, cs_real_t *values)
Define the velocity field for an inlet boundary using a uniform value.
Definition: cs_navsto_param.c:1847
@ CS_NAVSTO_SLES_BY_BLOCKS
Definition: cs_navsto_param.h:331
@ CS_NSKEY_NL_ALGO_DTOL
Definition: cs_navsto_param.h:894
bool velocity_ic_is_owner
Definition: cs_navsto_param.h:666
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
bool velocity_bc_is_owner
Definition: cs_navsto_param.h:716
cs_xdef_t * cs_navsto_add_pressure_ic_by_analytic(cs_navsto_param_t *nsp, const char *z_name, cs_analytic_func_t *analytic, void *input)
Define the initial condition for the pressure unknowns. This definition can be done on a specified me...
Definition: cs_navsto_param.c:1498
bool pressure_bc_is_owner
Definition: cs_navsto_param.h:733
cs_physical_constants_t * phys_constants
Definition: cs_navsto_param.h:521
int n_max_nl_algo_iter
Definition: cs_navsto_param.h:447
cs_param_time_scheme_t
Definition: cs_param_types.h:234
cs_navsto_param_t * cs_navsto_param_free(cs_navsto_param_t *param)
Free a cs_navsto_param_t structure.
Definition: cs_navsto_param.c:472
Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources.
Definition: cs_equation_param.h:201
cs_xdef_t ** pressure_bc_defs
Definition: cs_navsto_param.h:735
void cs_navsto_set_outlets(cs_navsto_param_t *nsp)
Add the definition of boundary conditions related to outlets into the set of parameters for the manag...
Definition: cs_navsto_param.c:1647
cs_real_t nl_algo_rtol
Definition: cs_navsto_param.h:429
cs_param_space_scheme_t space_scheme
Definition: cs_navsto_param.h:581
const char * cs_navsto_param_get_model_name(cs_navsto_param_model_t model)
Retrieve the name of the model system of equations.
Definition: cs_navsto_param.c:1232
@ CS_NAVSTO_MODEL_BOUSSINESQ
Definition: cs_navsto_param.h:137
@ CS_NAVSTO_NL_PICARD_ALGO
Definition: cs_navsto_param.h:359
cs_navsto_param_sles_t sles_param
Definition: cs_navsto_param.h:609
cs_property_t * mass_density
Definition: cs_navsto_param.h:528
void cs_navsto_param_transfer(const cs_navsto_param_t *nsp, cs_equation_param_t *eqp)
Apply the numerical settings defined for the Navier-Stokes system to an equation related to this syst...
Definition: cs_navsto_param.c:944
int n_velocity_ic_defs
Definition: cs_navsto_param.h:667
int n_velocity_bc_defs
Definition: cs_navsto_param.h:717
Structure storing the parameters for solving the Navier-Stokes system.
Definition: cs_navsto_param.h:369
int n_pressure_ic_defs
Definition: cs_navsto_param.h:685
cs_turbulence_param_t * turbulence
Definition: cs_navsto_param.h:510
@ CS_NAVSTO_MODEL_STOKES
Definition: cs_navsto_param.h:82
cs_navsto_key_t
List of available keys for setting the parameters of the Navier-Stokes system.
Definition: cs_navsto_param.h:877
void cs_navsto_set_reference_pressure(cs_navsto_param_t *nsp, cs_real_t pref)
Set the value to consider for the reference pressure.
Definition: cs_navsto_param.c:1289
cs_navsto_sles_t strategy
Definition: cs_navsto_param.h:374
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_flag_t cs_navsto_param_model_flag_t
Definition: cs_navsto_param.h:56
@ CS_NSKEY_NL_ALGO
Definition: cs_navsto_param.h:892
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:298
cs_param_advection_form_t adv_form
Definition: cs_navsto_param.h:595
cs_param_advection_scheme_t adv_scheme
Definition: cs_navsto_param.h:596
@ CS_NAVSTO_POST_KINETIC_ENERGY
Definition: cs_navsto_param.h:176
cs_param_advection_scheme_t
Definition: cs_param_types.h:311
cs_xdef_t * cs_navsto_set_pressure_bc_by_value(cs_navsto_param_t *nsp, const char *z_name, cs_real_t *values)
Set the pressure field on a boundary using a uniform value.
Definition: cs_navsto_param.c:1701
@ CS_NAVSTO_POST_VELOCITY_GRADIENT
Definition: cs_navsto_param.h:178
cs_param_space_scheme_t
Type of numerical scheme for the discretization in space.
Definition: cs_param_types.h:172
@ CS_NSKEY_DOF_REDUCTION
Definition: cs_navsto_param.h:883
@ CS_NAVSTO_SLES_GKB_GMRES
Definition: cs_navsto_param.h:335
@ CS_NSKEY_ADVECTION_SCHEME
Definition: cs_navsto_param.h:881
void cs_navsto_set_symmetries(cs_navsto_param_t *nsp)
Add the definition of boundary conditions related to a symmetry into the set of parameters for the ma...
Definition: cs_navsto_param.c:1597
void cs_navsto_param_set(cs_navsto_param_t *nsp, cs_navsto_key_t key, const char *keyval)
Set a parameter attached to a keyname in a cs_navsto_param_t structure.
Definition: cs_navsto_param.c:552
cs_navsto_param_model_flag_t model_flag
Definition: cs_navsto_param.h:504
cs_real_t gd_scale_coef
Definition: cs_navsto_param.h:566
cs_property_t * lam_viscosity
Definition: cs_navsto_param.h:542
@ CS_NSKEY_IL_ALGO_ATOL
Definition: cs_navsto_param.h:885
cs_property_t * tot_viscosity
Definition: cs_navsto_param.h:536
void cs_navsto_add_oseen_field(cs_navsto_param_t *nsp, cs_adv_field_t *adv_fld)
Add a advection field for the Oseen problem.
Definition: cs_navsto_param.c:2213
@ CS_NSKEY_VERBOSITY
Definition: cs_navsto_param.h:903
cs_xdef_t * cs_navsto_set_velocity_wall_by_value(cs_navsto_param_t *nsp, const char *z_name, cs_real_t *values)
Define the velocity field for a sliding wall boundary using a uniform value.
Definition: cs_navsto_param.c:1787
int n_max_il_algo_iter
Definition: cs_navsto_param.h:405
@ CS_NSKEY_N_KEYS
Definition: cs_navsto_param.h:905
cs_navsto_nl_algo_t
Type of algorithm used to tackle the non-linearity arising from the Navier-Stokes system.
Definition: cs_navsto_param.h:357
@ CS_NAVSTO_MODEL_SOLIDIFICATION_BOUSSINESQ
Definition: cs_navsto_param.h:138
@ CS_NSKEY_TIME_SCHEME
Definition: cs_navsto_param.h:901
unsigned short int cs_flag_t
Definition: cs_defs.h:306
cs_xdef_t ** pressure_ic_defs
Definition: cs_navsto_param.h:686
cs_real_t reference_pressure
Definition: cs_navsto_param.h:747
cs_lnum_t n_solid_cells
Definition: cs_navsto_param.h:761
@ CS_NAVSTO_MODEL_PASSIVE_THERMAL_TRACER
Definition: cs_navsto_param.h:136
int verbosity
Definition: cs_navsto_param.h:633
cs_xdef_t * cs_navsto_add_velocity_ic_by_value(cs_navsto_param_t *nsp, const char *z_name, cs_real_t *val)
Define the initial condition for the velocity unknowns. This definition can be done on a specified me...
Definition: cs_navsto_param.c:1315
cs_equation_param_t * cs_navsto_param_get_velocity_param(const cs_navsto_param_t *nsp)
Retrieve the cs_equation_param_t structure related to the velocity equation (momentum equation in mos...
Definition: cs_navsto_param.c:1196
cs_xdef_t ** velocity_bc_defs
Definition: cs_navsto_param.h:718
cs_navsto_param_coupling_t
Choice of algorithm for solving the system.
Definition: cs_navsto_param.h:472
cs_navsto_param_post_flag_t post_flag
Definition: cs_navsto_param.h:638
@ CS_NSKEY_NL_ALGO_RTOL
Definition: cs_navsto_param.h:895
Structure and routines handling the specific settings related to a cs_equation_t structure.
cs_param_advection_extrapol_t adv_extrapol
Definition: cs_navsto_param.h:598
@ CS_NAVSTO_MODEL_INCOMPRESSIBLE_NAVIER_STOKES
Definition: cs_navsto_param.h:84
cs_real_t delta_thermal_tolerance
Definition: cs_navsto_param.h:615
cs_xdef_t * cs_navsto_set_velocity_inlet_by_dof_func(cs_navsto_param_t *nsp, const char *z_name, cs_dof_func_t *func, void *func_input)
Define the velocity field for an inlet boundary using a DoF function.
Definition: cs_navsto_param.c:2053
void cs_navsto_param_log(const cs_navsto_param_t *nsp)
Summary of the main cs_navsto_param_t structure.
Definition: cs_navsto_param.c:1003
cs_quadrature_type_t
Definition: cs_quadrature.h:52
cs_xdef_t * cs_navsto_add_velocity_ic_by_analytic(cs_navsto_param_t *nsp, const char *z_name, cs_analytic_func_t *analytic, void *input)
Define the initial condition for the velocity unknowns. This definition can be done on a specified me...
Definition: cs_navsto_param.c:1378
@ CS_NSKEY_TIME_THETA
Definition: cs_navsto_param.h:902
Definition: cs_advection_field.h:149
cs_xdef_t * cs_navsto_set_velocity_inlet_by_array(cs_navsto_param_t *nsp, const char *z_name, cs_flag_t loc, cs_real_t *array, bool is_owner, cs_lnum_t *index)
Define the velocity field for an inlet boundary using an array of values.
Definition: cs_navsto_param.c:1983
@ CS_NAVSTO_SLES_GKB_PETSC
Definition: cs_navsto_param.h:334
Physical constants descriptor.
Definition: cs_physical_constants.h:51
cs_param_advection_strategy_t adv_strategy
Definition: cs_navsto_param.h:597
cs_real_t il_algo_verbosity
Definition: cs_navsto_param.h:410
@ CS_NAVSTO_COUPLING_PROJECTION
Definition: cs_navsto_param.h:476
@ CS_NAVSTO_COUPLING_ARTIFICIAL_COMPRESSIBILITY
Definition: cs_navsto_param.h:474
cs_real_t nl_algo_atol
Definition: cs_navsto_param.h:435
cs_param_dof_reduction_t dof_reduction_mode
Definition: cs_navsto_param.h:554
cs_navsto_sles_t
High-level information about the way of settings the SLES for solving the Navier-Stokes system....
Definition: cs_navsto_param.h:327
@ CS_NAVSTO_SLES_BLOCK_MULTIGRID_CG
Definition: cs_navsto_param.h:330
@ CS_NAVSTO_POST_ENSTROPHY
Definition: cs_navsto_param.h:181
int n_max_outer_iter
Definition: cs_navsto_param.h:623
cs_navsto_nl_algo_t nl_algo
Definition: cs_navsto_param.h:423
cs_param_advection_form_t
Definition: cs_param_types.h:267
@ CS_NAVSTO_SLES_N_TYPES
Definition: cs_navsto_param.h:342
cs_navsto_param_t * cs_navsto_param_create(const cs_boundary_t *boundaries, cs_navsto_param_model_t model, cs_navsto_param_model_flag_t model_flag, cs_navsto_param_coupling_t algo_coupling, cs_navsto_param_post_flag_t post_flag)
Create a new structure to store all numerical parameters related to the resolution of the Navier-Stok...
Definition: cs_navsto_param.c:299
@ CS_NAVSTO_NL_ALGO_TYPES
Definition: cs_navsto_param.h:361
@ CS_NSKEY_IL_ALGO_DTOL
Definition: cs_navsto_param.h:886
cs_real_t nl_algo_dtol
Definition: cs_navsto_param.h:441
@ CS_NSKEY_NL_ALGO_VERBOSITY
Definition: cs_navsto_param.h:896
@ CS_NAVSTO_SLES_UPPER_SCHUR_GMRES
Definition: cs_navsto_param.h:339