6.3
general documentation
cs_navsto_param.h
Go to the documentation of this file.
1 #ifndef __CS_NAVSTO_PARAM_H__
2 #define __CS_NAVSTO_PARAM_H__
3 
4 /*============================================================================
5  * Routines to handle cs_navsto_param_t structure
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2020 EDF S.A.
12 
13  This program is free software; you can redistribute it and/or modify it under
14  the terms of the GNU General Public License as published by the Free Software
15  Foundation; either version 2 of the License, or (at your option) any later
16  version.
17 
18  This program is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
20  FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
21  details.
22 
23  You should have received a copy of the GNU General Public License along with
24  this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
25  Street, Fifth Floor, Boston, MA 02110-1301, USA.
26 */
27 
28 /*----------------------------------------------------------------------------
29  * Local headers
30  *----------------------------------------------------------------------------*/
31 
32 #include "cs_boundary.h"
33 #include "cs_cdo_turbulence.h"
34 #include "cs_equation_param.h"
35 #include "cs_math.h"
36 #include "cs_physical_constants.h"
37 
38 /*----------------------------------------------------------------------------*/
39 
41 
42 /*============================================================================
43  * Macro definitions
44  *============================================================================*/
45 
46 /* Manage the naming of properties, variables and equations related to the
47  * Navier-Stokes module
48  */
49 
50 #define CS_NAVSTO_STREAM_EQNAME "streamfunction_eq"
51 
52 /*============================================================================
53  * Type definitions
54  *============================================================================*/
55 
58 
80 typedef enum {
81 
85 
87 
89 
131 typedef enum {
132 
133  CS_NAVSTO_MODEL_STEADY = 1<<0, /* = 1 */
137  CS_NAVSTO_MODEL_BOUSSINESQ = 1<<4, /* = 16 */
139 
141 
173 typedef enum {
174 
176  CS_NAVSTO_POST_KINETIC_ENERGY = 1<< 1, /* = 2 */
177  CS_NAVSTO_POST_VORTICITY = 1<< 2, /* = 4 */
179  CS_NAVSTO_POST_STREAM_FUNCTION = 1<< 4, /* = 16 */
180  CS_NAVSTO_POST_HELICITY = 1<< 5, /* = 32 */
181  CS_NAVSTO_POST_ENSTROPHY = 1<< 6, /* = 64 */
182 
184 
327 typedef enum {
328 
341 
343 
345 
357 typedef enum {
358 
360 
362 
364 
369 typedef struct {
370 
375 
389 
395 
401 
406 
411 
424 
430 
436 
442 
448 
453 
457 
472 typedef enum {
473 
477 
479 
481 
487 typedef struct {
488 
500 
505 
511 
522 
529 
537 
543 
555 
560 
567 
577 
582 
599 
605 
610 
616 
624 
634 
639 
669 
687 
696  /* \var boundaries
697  * Pointer to a \ref cs_boundary_t structure shared with the domain
698  */
700 
719 
736 
748 
763 
767 
877 typedef enum {
878 
904 
906 
908 
909 /*============================================================================
910  * Inline static public function prototypes
911  *============================================================================*/
912 
913 /*----------------------------------------------------------------------------*/
922 /*----------------------------------------------------------------------------*/
923 
924 static inline bool
925 cs_navsto_param_is_steady(const cs_navsto_param_t *nsp)
926 {
927  if (nsp == NULL)
928  return true;
929 
931  return true;
932  else
933  return false;
934 }
935 
936 /*============================================================================
937  * Public function prototypes
938  *============================================================================*/
939 
940 /*----------------------------------------------------------------------------*/
953 /*----------------------------------------------------------------------------*/
954 
956 cs_navsto_param_create(const cs_boundary_t *boundaries,
958  cs_navsto_param_model_flag_t model_flag,
959  cs_navsto_param_coupling_t algo_coupling,
960  cs_navsto_param_post_flag_t post_flag);
961 
962 /*----------------------------------------------------------------------------*/
970 /*----------------------------------------------------------------------------*/
971 
974 
975 /*----------------------------------------------------------------------------*/
984 /*----------------------------------------------------------------------------*/
985 
986 void
988  cs_navsto_key_t key,
989  const char *keyval);
990 
991 /*----------------------------------------------------------------------------*/
999 /*----------------------------------------------------------------------------*/
1000 
1001 void
1003  cs_equation_param_t *eqp);
1004 
1005 /*----------------------------------------------------------------------------*/
1011 /*----------------------------------------------------------------------------*/
1012 
1013 void
1015 
1016 /*----------------------------------------------------------------------------*/
1025 /*----------------------------------------------------------------------------*/
1026 
1029 
1030 /*----------------------------------------------------------------------------*/
1038 /*----------------------------------------------------------------------------*/
1039 
1040 const char *
1042 
1043 /*----------------------------------------------------------------------------*/
1051 /*----------------------------------------------------------------------------*/
1052 
1053 const char *
1055 
1056 /*----------------------------------------------------------------------------*/
1063 /*----------------------------------------------------------------------------*/
1064 
1065 void
1067  cs_real_t pref);
1068 
1069 /*----------------------------------------------------------------------------*/
1083 /*----------------------------------------------------------------------------*/
1084 
1085 cs_xdef_t *
1087  const char *z_name,
1088  cs_real_t *val);
1089 
1090 /*----------------------------------------------------------------------------*/
1105 /*----------------------------------------------------------------------------*/
1106 
1107 cs_xdef_t *
1109  const char *z_name,
1110  cs_analytic_func_t *analytic,
1111  void *input);
1112 
1113 /*----------------------------------------------------------------------------*/
1127 /*----------------------------------------------------------------------------*/
1128 
1129 cs_xdef_t *
1131  const char *z_name,
1132  cs_real_t *val);
1133 
1134 /*----------------------------------------------------------------------------*/
1149 /*----------------------------------------------------------------------------*/
1150 
1151 cs_xdef_t *
1153  const char *z_name,
1154  cs_analytic_func_t *analytic,
1155  void *input);
1156 
1157 /*----------------------------------------------------------------------------*/
1165 /*----------------------------------------------------------------------------*/
1166 
1167 void
1169 
1170 /*----------------------------------------------------------------------------*/
1178 /*----------------------------------------------------------------------------*/
1179 
1180 void
1182 
1183 /*----------------------------------------------------------------------------*/
1191 /*----------------------------------------------------------------------------*/
1192 
1193 void
1195 
1196 /*----------------------------------------------------------------------------*/
1207 /*----------------------------------------------------------------------------*/
1208 
1209 cs_xdef_t *
1211  const char *z_name,
1212  cs_real_t *values);
1213 
1214 /*----------------------------------------------------------------------------*/
1226 /*----------------------------------------------------------------------------*/
1227 
1228 cs_xdef_t *
1230  const char *z_name,
1231  cs_real_t *values);
1232 
1233 /*----------------------------------------------------------------------------*/
1245 /*----------------------------------------------------------------------------*/
1246 
1247 cs_xdef_t *
1249  const char *z_name,
1250  cs_real_t *values);
1251 
1252 /*----------------------------------------------------------------------------*/
1265 /*----------------------------------------------------------------------------*/
1266 
1267 cs_xdef_t *
1269  const char *z_name,
1270  cs_analytic_func_t *ana,
1271  void *input);
1272 
1273 /*----------------------------------------------------------------------------*/
1289 /*----------------------------------------------------------------------------*/
1290 
1291 cs_xdef_t *
1293  const char *z_name,
1294  cs_flag_t loc,
1295  cs_real_t *array,
1296  bool is_owner,
1297  cs_lnum_t *index);
1298 
1299 /*----------------------------------------------------------------------------*/
1311 /*----------------------------------------------------------------------------*/
1312 
1313 cs_xdef_t *
1315  const char *z_name,
1316  cs_dof_func_t *func,
1317  void *func_input);
1318 
1319 /*----------------------------------------------------------------------------*/
1331 /*----------------------------------------------------------------------------*/
1332 
1333 cs_xdef_t *
1335  const char *z_name,
1336  cs_analytic_func_t *ana,
1337  void *input);
1338 
1339 /*----------------------------------------------------------------------------*/
1350 /*----------------------------------------------------------------------------*/
1351 
1352 cs_xdef_t *
1354  const char *z_name,
1355  cs_real_t *val);
1356 
1357 /*----------------------------------------------------------------------------*/
1372 /*----------------------------------------------------------------------------*/
1373 
1374 cs_xdef_t *
1376  const char *z_name,
1377  cs_flag_t loc,
1378  cs_real_t *array,
1379  bool is_owner,
1380  cs_lnum_t *index);
1381 
1382 /*----------------------------------------------------------------------------*/
1389 /*----------------------------------------------------------------------------*/
1390 
1391 void
1393  cs_adv_field_t *adv_fld);
1394 
1395 /*----------------------------------------------------------------------------*/
1396 
1398 
1399 #endif /* __CS_NAVSTO_PARAM_H__ */
CS_NSKEY_ADVECTION_FORMULATION
@ CS_NSKEY_ADVECTION_FORMULATION
Definition: cs_navsto_param.h:880
cs_navsto_set_fixed_walls
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_navsto_param_t::time_scheme
cs_param_time_scheme_t time_scheme
Definition: cs_navsto_param.h:575
cs_navsto_param_sles_t::il_algo_atol
cs_real_t il_algo_atol
Definition: cs_navsto_param.h:394
CS_NSKEY_SPACE_SCHEME
@ CS_NSKEY_SPACE_SCHEME
Definition: cs_navsto_param.h:899
CS_NAVSTO_MODEL_CORIOLIS_EFFECTS
@ CS_NAVSTO_MODEL_CORIOLIS_EFFECTS
Definition: cs_navsto_param.h:135
cs_navsto_param_t::n_pressure_bc_defs
int n_pressure_bc_defs
Definition: cs_navsto_param.h:734
CS_NSKEY_MAX_NL_ALGO_ITER
@ CS_NSKEY_MAX_NL_ALGO_ITER
Definition: cs_navsto_param.h:890
cs_navsto_add_pressure_ic_by_value
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
@ CS_NAVSTO_POST_VELOCITY_DIVERGENCE
Definition: cs_navsto_param.h:175
CS_NSKEY_ADVECTION_STRATEGY
@ CS_NSKEY_ADVECTION_STRATEGY
Definition: cs_navsto_param.h:882
cs_navsto_add_source_term_by_analytic
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_navsto_param_sles_t::il_algo_rtol
cs_real_t il_algo_rtol
Definition: cs_navsto_param.h:388
CS_NSKEY_QUADRATURE
@ CS_NSKEY_QUADRATURE
Definition: cs_navsto_param.h:897
cs_navsto_param_t::velocity_ic_defs
cs_xdef_t ** velocity_ic_defs
Definition: cs_navsto_param.h:668
cs_navsto_param_post_bit_t
cs_navsto_param_post_bit_t
Bit values for additional generic postprocessing related to the Navier-Stokes module....
Definition: cs_navsto_param.h:173
cs_xdef_t
Structure storing medata for defining a quantity in a very flexible way.
Definition: cs_xdef.h:154
cs_analytic_func_t
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
@ CS_NAVSTO_SLES_EQ_WITHOUT_BLOCK
Definition: cs_navsto_param.h:333
cs_navsto_set_velocity_inlet_by_analytic
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
@ CS_NSKEY_SLES_STRATEGY
Definition: cs_navsto_param.h:898
CS_NSKEY_MAX_OUTER_ITER
@ CS_NSKEY_MAX_OUTER_ITER
Definition: cs_navsto_param.h:891
cs_navsto_add_source_term_by_array
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
@ CS_NAVSTO_COUPLING_MONOLITHIC
Definition: cs_navsto_param.h:475
cs_navsto_param_t::qtype
cs_quadrature_type_t qtype
Definition: cs_navsto_param.h:604
cs_turbulence_param_t
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
@ CS_NAVSTO_SLES_MULTIPLICATIVE_GMRES_BY_BLOCK
Definition: cs_navsto_param.h:337
CS_NSKEY_MAX_IL_ALGO_ITER
@ CS_NSKEY_MAX_IL_ALGO_ITER
Definition: cs_navsto_param.h:889
CS_NSKEY_IL_ALGO_VERBOSITY
@ CS_NSKEY_IL_ALGO_VERBOSITY
Definition: cs_navsto_param.h:888
cs_navsto_add_source_term_by_val
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
cs_navsto_param_t
Structure storing the parameters related to the resolution of the Navier-Stokes system.
Definition: cs_navsto_param.h:487
cs_navsto_param_model_t
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
@ CS_NSKEY_IL_ALGO_RTOL
Definition: cs_navsto_param.h:887
cs_boundary_t
Structure storing information related to the "physical" boundaries associated with the computational ...
Definition: cs_boundary.h:151
CS_NSKEY_THERMAL_TOLERANCE
@ CS_NSKEY_THERMAL_TOLERANCE
Definition: cs_navsto_param.h:900
CS_NAVSTO_MODEL_OSEEN
@ CS_NAVSTO_MODEL_OSEEN
Definition: cs_navsto_param.h:83
cs_navsto_param_get_coupling_name
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
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:493
CS_NSKEY_GD_SCALE_COEF
@ CS_NSKEY_GD_SCALE_COEF
Definition: cs_navsto_param.h:884
cs_navsto_param_t::model
cs_navsto_param_model_t model
Definition: cs_navsto_param.h:499
CS_NAVSTO_POST_VORTICITY
@ CS_NAVSTO_POST_VORTICITY
Definition: cs_navsto_param.h:177
cs_navsto_param_t::boundaries
const cs_boundary_t * boundaries
Definition: cs_navsto_param.h:699
cs_navsto_param_t::coupling
cs_navsto_param_coupling_t coupling
Definition: cs_navsto_param.h:559
CS_NAVSTO_SLES_GKB_SATURNE
@ CS_NAVSTO_SLES_GKB_SATURNE
Definition: cs_navsto_param.h:336
CS_NAVSTO_POST_STREAM_FUNCTION
@ CS_NAVSTO_POST_STREAM_FUNCTION
Definition: cs_navsto_param.h:179
cs_param_advection_strategy_t
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
@ CS_NAVSTO_SLES_MUMPS
Definition: cs_navsto_param.h:338
CS_NSKEY_ADVECTION_EXTRAPOL
@ CS_NSKEY_ADVECTION_EXTRAPOL
Definition: cs_navsto_param.h:879
cs_navsto_param_model_bit_t
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
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:304
CS_NSKEY_NL_ALGO_ATOL
@ CS_NSKEY_NL_ALGO_ATOL
Definition: cs_navsto_param.h:893
CS_NAVSTO_SLES_ADDITIVE_GMRES_BY_BLOCK
@ CS_NAVSTO_SLES_ADDITIVE_GMRES_BY_BLOCK
Definition: cs_navsto_param.h:329
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:492
CS_NAVSTO_MODEL_GRAVITY_EFFECTS
@ CS_NAVSTO_MODEL_GRAVITY_EFFECTS
Definition: cs_navsto_param.h:134
CS_NAVSTO_POST_HELICITY
@ CS_NAVSTO_POST_HELICITY
Definition: cs_navsto_param.h:180
cs_navsto_param_t::solid_cell_ids
cs_lnum_t * solid_cell_ids
Definition: cs_navsto_param.h:762
cs_navsto_param_t::pressure_ic_is_owner
bool pressure_ic_is_owner
Definition: cs_navsto_param.h:684
CS_NAVSTO_SLES_UZAWA_AL
@ CS_NAVSTO_SLES_UZAWA_AL
Definition: cs_navsto_param.h:340
cs_navsto_param_t::theta
cs_real_t theta
Definition: cs_navsto_param.h:576
CS_NAVSTO_SLES_DIAG_SCHUR_GMRES
@ CS_NAVSTO_SLES_DIAG_SCHUR_GMRES
Definition: cs_navsto_param.h:332
CS_NAVSTO_MODEL_STEADY
@ CS_NAVSTO_MODEL_STEADY
Definition: cs_navsto_param.h:133
cs_navsto_param_sles_t::il_algo_dtol
cs_real_t il_algo_dtol
Definition: cs_navsto_param.h:400
CS_NAVSTO_N_MODELS
@ CS_NAVSTO_N_MODELS
Definition: cs_navsto_param.h:86
CS_NAVSTO_N_COUPLINGS
@ CS_NAVSTO_N_COUPLINGS
Definition: cs_navsto_param.h:478
cs_navsto_param_post_flag_t
cs_flag_t cs_navsto_param_post_flag_t
Definition: cs_navsto_param.h:57
cs_navsto_param_sles_t::nl_algo_verbosity
cs_real_t nl_algo_verbosity
Definition: cs_navsto_param.h:452
cs_param_dof_reduction_t
cs_param_dof_reduction_t
Definition: cs_param_types.h:199
cs_navsto_set_velocity_inlet_by_value
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
@ CS_NAVSTO_SLES_BY_BLOCKS
Definition: cs_navsto_param.h:331
CS_NSKEY_NL_ALGO_DTOL
@ CS_NSKEY_NL_ALGO_DTOL
Definition: cs_navsto_param.h:894
cs_navsto_param_t::velocity_ic_is_owner
bool velocity_ic_is_owner
Definition: cs_navsto_param.h:666
cs_dof_func_t
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
cs_navsto_param_t::velocity_bc_is_owner
bool velocity_bc_is_owner
Definition: cs_navsto_param.h:716
cs_navsto_add_pressure_ic_by_analytic
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
cs_navsto_param_t::pressure_bc_is_owner
bool pressure_bc_is_owner
Definition: cs_navsto_param.h:733
cs_navsto_param_t::phys_constants
cs_physical_constants_t * phys_constants
Definition: cs_navsto_param.h:521
cs_navsto_param_sles_t::n_max_nl_algo_iter
int n_max_nl_algo_iter
Definition: cs_navsto_param.h:447
cs_param_time_scheme_t
cs_param_time_scheme_t
Definition: cs_param_types.h:234
cs_navsto_param_free
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
cs_equation_param_t
Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources.
Definition: cs_equation_param.h:201
cs_navsto_param_t::pressure_bc_defs
cs_xdef_t ** pressure_bc_defs
Definition: cs_navsto_param.h:735
cs_physical_constants.h
cs_navsto_set_outlets
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_navsto_param_sles_t::nl_algo_rtol
cs_real_t nl_algo_rtol
Definition: cs_navsto_param.h:429
cs_math.h
cs_navsto_param_t::space_scheme
cs_param_space_scheme_t space_scheme
Definition: cs_navsto_param.h:581
cs_navsto_param_get_model_name
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
@ CS_NAVSTO_MODEL_BOUSSINESQ
Definition: cs_navsto_param.h:137
CS_NAVSTO_NL_PICARD_ALGO
@ CS_NAVSTO_NL_PICARD_ALGO
Definition: cs_navsto_param.h:359
cs_navsto_param_t::sles_param
cs_navsto_param_sles_t sles_param
Definition: cs_navsto_param.h:609
cs_navsto_param_t::mass_density
cs_property_t * mass_density
Definition: cs_navsto_param.h:528
cs_navsto_param_transfer
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
cs_navsto_param_t::n_velocity_ic_defs
int n_velocity_ic_defs
Definition: cs_navsto_param.h:667
cs_navsto_param_t::n_velocity_bc_defs
int n_velocity_bc_defs
Definition: cs_navsto_param.h:717
cs_navsto_param_sles_t
Structure storing the parameters for solving the Navier-Stokes system.
Definition: cs_navsto_param.h:369
cs_navsto_param_t::n_pressure_ic_defs
int n_pressure_ic_defs
Definition: cs_navsto_param.h:685
cs_navsto_param_t::turbulence
cs_turbulence_param_t * turbulence
Definition: cs_navsto_param.h:510
CS_NAVSTO_MODEL_STOKES
@ CS_NAVSTO_MODEL_STOKES
Definition: cs_navsto_param.h:82
cs_navsto_key_t
cs_navsto_key_t
List of available keys for setting the parameters of the Navier-Stokes system.
Definition: cs_navsto_param.h:877
cs_navsto_set_reference_pressure
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_param_sles_t::strategy
cs_navsto_sles_t strategy
Definition: cs_navsto_param.h:374
cs_param_advection_extrapol_t
cs_param_advection_extrapol_t
Choice of how to extrapolate the advection field in the advection term.
Definition: cs_param_types.h:378
cs_property_t
Structure associated to the definition of a property relying on the cs_xdef_t structure.
cs_navsto_param_model_flag_t
cs_flag_t cs_navsto_param_model_flag_t
Definition: cs_navsto_param.h:56
CS_NSKEY_NL_ALGO
@ CS_NSKEY_NL_ALGO
Definition: cs_navsto_param.h:892
cs_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:298
cs_navsto_param_t::adv_form
cs_param_advection_form_t adv_form
Definition: cs_navsto_param.h:595
cs_navsto_param_t::adv_scheme
cs_param_advection_scheme_t adv_scheme
Definition: cs_navsto_param.h:596
CS_NAVSTO_POST_KINETIC_ENERGY
@ CS_NAVSTO_POST_KINETIC_ENERGY
Definition: cs_navsto_param.h:176
cs_param_advection_scheme_t
cs_param_advection_scheme_t
Definition: cs_param_types.h:311
cs_navsto_set_pressure_bc_by_value
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
@ CS_NAVSTO_POST_VELOCITY_GRADIENT
Definition: cs_navsto_param.h:178
cs_param_space_scheme_t
cs_param_space_scheme_t
Type of numerical scheme for the discretization in space.
Definition: cs_param_types.h:172
CS_NSKEY_DOF_REDUCTION
@ CS_NSKEY_DOF_REDUCTION
Definition: cs_navsto_param.h:883
CS_NAVSTO_SLES_GKB_GMRES
@ CS_NAVSTO_SLES_GKB_GMRES
Definition: cs_navsto_param.h:335
CS_NSKEY_ADVECTION_SCHEME
@ CS_NSKEY_ADVECTION_SCHEME
Definition: cs_navsto_param.h:881
cs_navsto_set_symmetries
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
cs_navsto_param_set
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_t::model_flag
cs_navsto_param_model_flag_t model_flag
Definition: cs_navsto_param.h:504
cs_navsto_param_t::gd_scale_coef
cs_real_t gd_scale_coef
Definition: cs_navsto_param.h:566
cs_navsto_param_t::lam_viscosity
cs_property_t * lam_viscosity
Definition: cs_navsto_param.h:542
CS_NSKEY_IL_ALGO_ATOL
@ CS_NSKEY_IL_ALGO_ATOL
Definition: cs_navsto_param.h:885
cs_navsto_param_t::tot_viscosity
cs_property_t * tot_viscosity
Definition: cs_navsto_param.h:536
cs_navsto_add_oseen_field
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
@ CS_NSKEY_VERBOSITY
Definition: cs_navsto_param.h:903
cs_navsto_set_velocity_wall_by_value
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
cs_navsto_param_sles_t::n_max_il_algo_iter
int n_max_il_algo_iter
Definition: cs_navsto_param.h:405
CS_NSKEY_N_KEYS
@ CS_NSKEY_N_KEYS
Definition: cs_navsto_param.h:905
cs_navsto_nl_algo_t
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
@ CS_NAVSTO_MODEL_SOLIDIFICATION_BOUSSINESQ
Definition: cs_navsto_param.h:138
CS_NSKEY_TIME_SCHEME
@ CS_NSKEY_TIME_SCHEME
Definition: cs_navsto_param.h:901
cs_flag_t
unsigned short int cs_flag_t
Definition: cs_defs.h:306
cs_navsto_param_t::pressure_ic_defs
cs_xdef_t ** pressure_ic_defs
Definition: cs_navsto_param.h:686
cs_navsto_param_t::reference_pressure
cs_real_t reference_pressure
Definition: cs_navsto_param.h:747
cs_navsto_param_t::n_solid_cells
cs_lnum_t n_solid_cells
Definition: cs_navsto_param.h:761
CS_NAVSTO_MODEL_PASSIVE_THERMAL_TRACER
@ CS_NAVSTO_MODEL_PASSIVE_THERMAL_TRACER
Definition: cs_navsto_param.h:136
cs_navsto_param_t::verbosity
int verbosity
Definition: cs_navsto_param.h:633
cs_navsto_add_velocity_ic_by_value
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_navsto_param_get_velocity_param
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_navsto_param_t::velocity_bc_defs
cs_xdef_t ** velocity_bc_defs
Definition: cs_navsto_param.h:718
cs_navsto_param_coupling_t
cs_navsto_param_coupling_t
Choice of algorithm for solving the system.
Definition: cs_navsto_param.h:472
cs_navsto_param_t::post_flag
cs_navsto_param_post_flag_t post_flag
Definition: cs_navsto_param.h:638
CS_NSKEY_NL_ALGO_RTOL
@ CS_NSKEY_NL_ALGO_RTOL
Definition: cs_navsto_param.h:895
cs_equation_param.h
Structure and routines handling the specific settings related to a cs_equation_t structure.
cs_navsto_param_t::adv_extrapol
cs_param_advection_extrapol_t adv_extrapol
Definition: cs_navsto_param.h:598
CS_NAVSTO_MODEL_INCOMPRESSIBLE_NAVIER_STOKES
@ CS_NAVSTO_MODEL_INCOMPRESSIBLE_NAVIER_STOKES
Definition: cs_navsto_param.h:84
cs_navsto_param_t::delta_thermal_tolerance
cs_real_t delta_thermal_tolerance
Definition: cs_navsto_param.h:615
cs_navsto_set_velocity_inlet_by_dof_func
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
cs_navsto_param_log
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
cs_quadrature_type_t
Definition: cs_quadrature.h:52
cs_navsto_add_velocity_ic_by_analytic
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
@ CS_NSKEY_TIME_THETA
Definition: cs_navsto_param.h:902
cs_adv_field_t
Definition: cs_advection_field.h:149
cs_navsto_set_velocity_inlet_by_array
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
@ CS_NAVSTO_SLES_GKB_PETSC
Definition: cs_navsto_param.h:334
cs_physical_constants_t
Physical constants descriptor.
Definition: cs_physical_constants.h:51
cs_navsto_param_t::adv_strategy
cs_param_advection_strategy_t adv_strategy
Definition: cs_navsto_param.h:597
cs_navsto_param_sles_t::il_algo_verbosity
cs_real_t il_algo_verbosity
Definition: cs_navsto_param.h:410
CS_NAVSTO_COUPLING_PROJECTION
@ CS_NAVSTO_COUPLING_PROJECTION
Definition: cs_navsto_param.h:476
CS_NAVSTO_COUPLING_ARTIFICIAL_COMPRESSIBILITY
@ CS_NAVSTO_COUPLING_ARTIFICIAL_COMPRESSIBILITY
Definition: cs_navsto_param.h:474
cs_cdo_turbulence.h
cs_navsto_param_sles_t::nl_algo_atol
cs_real_t nl_algo_atol
Definition: cs_navsto_param.h:435
cs_navsto_param_t::dof_reduction_mode
cs_param_dof_reduction_t dof_reduction_mode
Definition: cs_navsto_param.h:554
cs_boundary.h
cs_navsto_sles_t
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
@ CS_NAVSTO_SLES_BLOCK_MULTIGRID_CG
Definition: cs_navsto_param.h:330
CS_NAVSTO_POST_ENSTROPHY
@ CS_NAVSTO_POST_ENSTROPHY
Definition: cs_navsto_param.h:181
cs_navsto_param_t::n_max_outer_iter
int n_max_outer_iter
Definition: cs_navsto_param.h:623
cs_navsto_param_sles_t::nl_algo
cs_navsto_nl_algo_t nl_algo
Definition: cs_navsto_param.h:423
cs_param_advection_form_t
cs_param_advection_form_t
Definition: cs_param_types.h:267
CS_NAVSTO_SLES_N_TYPES
@ CS_NAVSTO_SLES_N_TYPES
Definition: cs_navsto_param.h:342
cs_navsto_param_create
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
@ CS_NAVSTO_NL_ALGO_TYPES
Definition: cs_navsto_param.h:361
CS_NSKEY_IL_ALGO_DTOL
@ CS_NSKEY_IL_ALGO_DTOL
Definition: cs_navsto_param.h:886
cs_navsto_param_sles_t::nl_algo_dtol
cs_real_t nl_algo_dtol
Definition: cs_navsto_param.h:441
CS_NSKEY_NL_ALGO_VERBOSITY
@ CS_NSKEY_NL_ALGO_VERBOSITY
Definition: cs_navsto_param.h:896
CS_NAVSTO_SLES_UPPER_SCHUR_GMRES
@ CS_NAVSTO_SLES_UPPER_SCHUR_GMRES
Definition: cs_navsto_param.h:339