9.0
general documentation
Loading...
Searching...
No Matches
cs_param_types.h
Go to the documentation of this file.
1#ifndef __CS_PARAM_TYPES_H__
2#define __CS_PARAM_TYPES_H__
3
4/*============================================================================
5 * Set of definitions of structures and types used for setting a case
6 *============================================================================*/
7
8/*
9 This file is part of code_saturne, a general-purpose CFD tool.
10
11 Copyright (C) 1998-2025 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
30/*----------------------------------------------------------------------------
31 * Local headers
32 *----------------------------------------------------------------------------*/
33
34#include "base/cs_defs.h"
35
36/*----------------------------------------------------------------------------*/
37
39
40/*============================================================================
41 * Macro definitions
42 *============================================================================*/
43
56
57#define CS_DOF_VTX_SCAL 0
58#define CS_DOF_VTX_VECT 1
59#define CS_DOF_FACE_SCAL 2
60#define CS_DOF_FACE_VECT 3
61#define CS_DOF_FACE_SCAP1 3
62#define CS_DOF_FACE_SCAP2 4
63#define CS_DOF_FACE_VECP0 3
64#define CS_DOF_FACE_VECP1 5
65#define CS_DOF_FACE_VECP2 6
66#define CS_DOF_EDGE_SCAL 7
67
68#define CS_N_DOF_CASES 8
69
76
77/*
78 * Field property type
79 */
80
82
83#define CS_ISOTROPIC_DIFFUSION (1 << 0)
84
86
87#define CS_ORTHOTROPIC_DIFFUSION (1 << 1)
88
90
91#define CS_ANISOTROPIC_LEFT_DIFFUSION (1 << 2)
92
94
95#define CS_ANISOTROPIC_RIGHT_DIFFUSION (1 << 3)
96
98
99#define CS_ANISOTROPIC_DIFFUSION ((1 << 2) + (1 << 3))
100
102
103/*============================================================================
104 * Type definitions
105 *============================================================================*/
106
107/*----------------------------------------------------------------------------*/
124/*----------------------------------------------------------------------------*/
125
126typedef void
128 cs_lnum_t n_elts,
129 const cs_lnum_t *elt_ids,
130 const cs_real_t *coords,
131 bool dense_output,
132 void *input,
133 cs_real_t *retval);
134
135/*----------------------------------------------------------------------------*/
151/*----------------------------------------------------------------------------*/
152
153typedef void
154(cs_dof_func_t) (cs_lnum_t n_elts,
155 const cs_lnum_t *elt_ids,
156 bool dense_output,
157 void *input,
158 cs_real_t *retval);
159
160/*----------------------------------------------------------------------------*/
169/*----------------------------------------------------------------------------*/
170
171typedef void
172(cs_time_func_t) (double time,
173 void *input,
174 cs_real_t *retval);
175
214
231
243
252
278
291
311
321
364
381
400
410
435
445
492
512
513/* Compatibility macros */
514
515#define CS_PARAM_BC_HMG_DIRICHLET CS_BC_HMG_DIRICHLET
516#define CS_PARAM_BC_DIRICHLET CS_BC_DIRICHLET
517#define CS_PARAM_BC_HMG_NEUMANN CS_BC_SYMMETRY
518#define CS_PARAM_BC_NEUMANN CS_BC_NEUMANN
519#define CS_PARAM_BC_NEUMANN_FULL CS_BC_NEUMANN_FULL
520#define CS_PARAM_BC_ROBIN CS_BC_ROBIN
521#define CS_PARAM_BC_SLIDING CS_BC_SYMMETRY
522#define CS_PARAM_BC_CIRCULATION CS_BC_CIRCULATION
523#define CS_PARAM_BC_WALL_PRECRIBED CS_BC_WALL_MODELLED
524
553
564
569
570typedef struct {
571
586
587 double atol;
588 double rtol;
589 double dtol;
591
593
617
627
633
654
665
689
701
766
789
847
870
876
890
895
904
908
909/*============================================================================
910 * Global variables
911 *============================================================================*/
912
913/* Separation lines: header1, header2 (compatible with markdown), other */
914
915extern const char cs_sep_h1[80];
916extern const char cs_sep_h2[80];
917extern const char cs_sepline[80];
918extern const char cs_med_sepline[50];
919
920/*============================================================================
921 * Public function prototypes
922 *============================================================================*/
923
924/*----------------------------------------------------------------------------*/
933/*----------------------------------------------------------------------------*/
934
935bool
937
938/*----------------------------------------------------------------------------*/
946/*----------------------------------------------------------------------------*/
947
948const char *
950
951/*----------------------------------------------------------------------------*/
959/*----------------------------------------------------------------------------*/
960
961const char *
963
964/*----------------------------------------------------------------------------*/
972/*----------------------------------------------------------------------------*/
973
974const char *
976
977/*----------------------------------------------------------------------------*/
985/*----------------------------------------------------------------------------*/
986
987const char *
989
990/*----------------------------------------------------------------------------*/
998/*----------------------------------------------------------------------------*/
999
1000const char *
1002
1003/*----------------------------------------------------------------------------*/
1012/*----------------------------------------------------------------------------*/
1013
1014const char *
1016
1017/*----------------------------------------------------------------------------*/
1025/*----------------------------------------------------------------------------*/
1026
1027const char *
1029
1030/*----------------------------------------------------------------------------*/
1038/*----------------------------------------------------------------------------*/
1039
1040const char *
1042
1043/*----------------------------------------------------------------------------*/
1051/*----------------------------------------------------------------------------*/
1052
1053const char *
1055
1056/*----------------------------------------------------------------------------*/
1064/*----------------------------------------------------------------------------*/
1065
1066const char *
1068
1069/*----------------------------------------------------------------------------*/
1077/*----------------------------------------------------------------------------*/
1078
1079const char *
1081
1082/*----------------------------------------------------------------------------*/
1090/*----------------------------------------------------------------------------*/
1091
1092const char *
1094
1095/*----------------------------------------------------------------------------*/
1103/*----------------------------------------------------------------------------*/
1104
1105const char *
1107
1108/*----------------------------------------------------------------------------*/
1116/*----------------------------------------------------------------------------*/
1117
1118const char *
1120
1121/*----------------------------------------------------------------------------*/
1122
1124
1125#endif /* __CS_PARAM_TYPES_H__ */
#define BEGIN_C_DECLS
Definition cs_defs.h:542
double cs_real_t
Floating-point value.
Definition cs_defs.h:342
#define END_C_DECLS
Definition cs_defs.h:543
int cs_lnum_t
local mesh entity id
Definition cs_defs.h:335
const char cs_sep_h2[80]
Definition cs_param_types.cpp:68
const char cs_sepline[80]
Definition cs_param_types.cpp:70
const char cs_med_sepline[50]
Definition cs_param_types.cpp:72
const char cs_sep_h1[80]
Definition cs_param_types.cpp:66
cs_param_space_scheme_t
Type of numerical scheme for the discretization in space.
Definition cs_param_types.h:215
@ CS_SPACE_SCHEME_MACFB
Definition cs_param_types.h:226
@ CS_SPACE_SCHEME_CDOEB
Definition cs_param_types.h:220
@ CS_SPACE_SCHEME_CDOVB
Definition cs_param_types.h:218
@ CS_SPACE_SCHEME_HHO_P0
Definition cs_param_types.h:223
@ CS_SPACE_SCHEME_CDOCB
Definition cs_param_types.h:222
@ CS_SPACE_SCHEME_HHO_P1
Definition cs_param_types.h:224
@ CS_SPACE_SCHEME_HHO_P2
Definition cs_param_types.h:225
@ CS_SPACE_SCHEME_LEGACY
Definition cs_param_types.h:217
@ CS_SPACE_SCHEME_CDOFB
Definition cs_param_types.h:221
@ CS_SPACE_SCHEME_CDOVCB
Definition cs_param_types.h:219
@ CS_SPACE_N_SCHEMES
Definition cs_param_types.h:228
cs_param_advection_form_t
Definition cs_param_types.h:312
@ CS_PARAM_ADVECTION_FORM_SKEWSYM
Definition cs_param_types.h:316
@ CS_PARAM_ADVECTION_FORM_NONCONS
Definition cs_param_types.h:315
@ CS_PARAM_ADVECTION_FORM_CONSERV
Definition cs_param_types.h:314
@ CS_PARAM_N_ADVECTION_FORMULATIONS
Definition cs_param_types.h:318
void cs_time_func_t(double time, void *input, cs_real_t *retval)
Function which defines the evolution of a quantity according to the current time and any structure gi...
Definition cs_param_types.h:172
cs_param_resnorm_type_t
Definition cs_param_types.h:877
@ CS_PARAM_RESNORM_FILTERED_RHS
Definition cs_param_types.h:884
@ CS_PARAM_N_RESNORM_TYPES
Definition cs_param_types.h:887
@ CS_PARAM_RESNORM_NORM2_RHS
Definition cs_param_types.h:880
@ CS_PARAM_RESNORM_WEIGHTED_RHS
Definition cs_param_types.h:882
@ CS_PARAM_RESNORM_NONE
Definition cs_param_types.h:879
const char * cs_param_get_time_scheme_name(cs_param_time_scheme_t scheme)
Get the name of the time discretization scheme.
Definition cs_param_types.cpp:252
cs_param_solver_class_t
Class of iterative solvers to consider for solver the linear system.
Definition cs_param_types.h:655
@ CS_PARAM_SOLVER_CLASS_HYPRE
Definition cs_param_types.h:658
@ CS_PARAM_SOLVER_CLASS_MUMPS
Definition cs_param_types.h:659
@ CS_PARAM_SOLVER_CLASS_PETSC
Definition cs_param_types.h:660
@ CS_PARAM_SOLVER_CLASS_CS
Definition cs_param_types.h:657
@ CS_PARAM_N_SOLVER_CLASSES
Definition cs_param_types.h:662
const char * cs_param_get_bc_enforcement_name(cs_param_bc_enforce_t type)
Get the name of the type of enforcement of the boundary condition.
Definition cs_param_types.cpp:431
cs_param_bc_type_t
Definition cs_param_types.h:493
@ CS_PARAM_N_BC_TYPES
Definition cs_param_types.h:509
@ CS_BC_GENERALIZED_SYM
Definition cs_param_types.h:506
@ CS_BC_IMPOSED_EXCHANGE_COEF
Definition cs_param_types.h:507
@ CS_BC_SYMMETRY
Definition cs_param_types.h:499
@ CS_BC_CIRCULATION
Definition cs_param_types.h:504
@ CS_BC_NEUMANN
Definition cs_param_types.h:498
@ CS_BC_HMG_DIRICHLET
Definition cs_param_types.h:495
@ CS_BC_WALL_MODELLED
Definition cs_param_types.h:500
@ CS_BC_IMPOSED_TOT_FLUX
Definition cs_param_types.h:505
@ CS_BC_NEUMANN_FULL
Definition cs_param_types.h:502
@ CS_BC_RADIATIVE_OUTLET
Definition cs_param_types.h:497
@ CS_BC_ROBIN
Definition cs_param_types.h:503
@ CS_BC_DIRICHLET
Definition cs_param_types.h:496
@ CS_BC_ROUGH_WALL_MODELLED
Definition cs_param_types.h:501
const char * cs_param_get_precond_block_name(cs_param_precond_block_t type)
Get the name of the type of block preconditioning.
Definition cs_param_types.cpp:669
cs_param_precond_type_t
Definition cs_param_types.h:767
@ CS_PARAM_PRECOND_BJACOB_SGS
Definition cs_param_types.h:773
@ CS_PARAM_PRECOND_DIAG
Definition cs_param_types.h:774
@ CS_PARAM_PRECOND_POLY2
Definition cs_param_types.h:783
@ CS_PARAM_PRECOND_ICC0
Definition cs_param_types.h:779
@ CS_PARAM_PRECOND_GKB_GMRES
Definition cs_param_types.h:776
@ CS_PARAM_PRECOND_NONE
Definition cs_param_types.h:769
@ CS_PARAM_PRECOND_ILU0
Definition cs_param_types.h:778
@ CS_PARAM_PRECOND_LU
Definition cs_param_types.h:777
@ CS_PARAM_PRECOND_HPDDM
Definition cs_param_types.h:781
@ CS_PARAM_PRECOND_GKB_CG
Definition cs_param_types.h:775
@ CS_PARAM_PRECOND_BJACOB_ILU0
Definition cs_param_types.h:772
@ CS_PARAM_PRECOND_AMG
Definition cs_param_types.h:771
@ CS_PARAM_PRECOND_POLY1
Definition cs_param_types.h:782
@ CS_PARAM_N_PRECOND_TYPES
Definition cs_param_types.h:786
@ CS_PARAM_PRECOND_SSOR
Definition cs_param_types.h:784
@ CS_PARAM_PRECOND_MUMPS
Definition cs_param_types.h:780
cs_param_advection_extrapol_t
Choice of how to extrapolate the advection field in the advection term.
Definition cs_param_types.h:436
@ CS_PARAM_ADVECTION_EXTRAPOL_TAYLOR_2
Definition cs_param_types.h:439
@ CS_PARAM_ADVECTION_EXTRAPOL_NONE
Definition cs_param_types.h:438
@ CS_PARAM_N_ADVECTION_EXTRAPOLATIONS
Definition cs_param_types.h:442
@ CS_PARAM_ADVECTION_EXTRAPOL_ADAMS_BASHFORTH_2
Definition cs_param_types.h:440
cs_param_precond_block_t
Definition cs_param_types.h:690
@ CS_PARAM_PRECOND_BLOCK_DIAG
Definition cs_param_types.h:693
@ CS_PARAM_PRECOND_BLOCK_LOWER_TRIANGULAR
Definition cs_param_types.h:694
@ CS_PARAM_PRECOND_BLOCK_SYM_GAUSS_SEIDEL
Definition cs_param_types.h:695
@ CS_PARAM_N_PCD_BLOCK_TYPES
Definition cs_param_types.h:698
@ CS_PARAM_PRECOND_BLOCK_UPPER_TRIANGULAR
Definition cs_param_types.h:696
@ CS_PARAM_PRECOND_BLOCK_NONE
Definition cs_param_types.h:692
const char * cs_param_get_nl_algo_label(cs_param_nl_algo_t algo)
Get the label (short name) of the non-linear algorithm.
Definition cs_param_types.cpp:481
cs_param_bc_enforce_t
Definition cs_param_types.h:554
@ CS_PARAM_BC_ENFORCE_WEAK_SYM
Definition cs_param_types.h:559
@ CS_PARAM_BC_ENFORCE_WEAK_NITSCHE
Definition cs_param_types.h:558
@ CS_PARAM_BC_ENFORCE_PENALIZED
Definition cs_param_types.h:557
@ CS_PARAM_BC_ENFORCE_ALGEBRAIC
Definition cs_param_types.h:556
@ CS_PARAM_N_BC_ENFORCEMENTS
Definition cs_param_types.h:561
bool cs_param_space_scheme_is_face_based(cs_param_space_scheme_t scheme)
Return true if the space scheme has degrees of freedom on faces, otherwise false.
Definition cs_param_types.cpp:200
cs_param_time_scheme_t
Definition cs_param_types.h:279
@ CS_TIME_SCHEME_EULER_IMPLICIT
Definition cs_param_types.h:282
@ CS_TIME_SCHEME_BDF2
Definition cs_param_types.h:286
@ CS_TIME_SCHEME_STEADY
Definition cs_param_types.h:281
@ CS_TIME_N_SCHEMES
Definition cs_param_types.h:288
@ CS_TIME_SCHEME_CRANKNICO
Definition cs_param_types.h:284
@ CS_TIME_SCHEME_THETA
Definition cs_param_types.h:285
@ CS_TIME_SCHEME_EULER_EXPLICIT
Definition cs_param_types.h:283
const char * cs_param_get_advection_form_name(cs_param_advection_form_t adv_form)
Get the label associated to the advection formulation.
Definition cs_param_types.cpp:279
cs_param_nl_algo_t
Class of non-linear iterative algorithm.
Definition cs_param_types.h:618
@ CS_PARAM_NL_ALGO_NONE
Definition cs_param_types.h:620
@ CS_PARAM_N_NL_ALGOS
Definition cs_param_types.h:624
@ CS_PARAM_NL_ALGO_PICARD
Definition cs_param_types.h:621
@ CS_PARAM_NL_ALGO_ANDERSON
Definition cs_param_types.h:623
@ CS_PARAM_NL_ALGO_MODIFIED_PICARD
Definition cs_param_types.h:622
const char * cs_param_get_advection_extrapol_name(cs_param_advection_extrapol_t extrapol)
Get the label associated to the extrapolation used for the advection field.
Definition cs_param_types.cpp:359
const char * cs_param_get_space_scheme_name(cs_param_space_scheme_t scheme)
Get the name of the space discretization scheme.
Definition cs_param_types.cpp:221
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
const char * cs_param_get_nl_algo_name(cs_param_nl_algo_t algo)
Get the name of the non-linear algorithm.
Definition cs_param_types.cpp:456
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
const char * cs_param_get_solver_name(cs_param_solver_type_t solver)
Get the name of the solver.
Definition cs_param_types.cpp:529
cs_param_advection_scheme_t
Definition cs_param_types.h:365
@ CS_PARAM_ADVECTION_SCHEME_SAMARSKII
Definition cs_param_types.h:371
@ CS_PARAM_ADVECTION_SCHEME_SG
Definition cs_param_types.h:372
@ CS_PARAM_ADVECTION_SCHEME_HYBRID_CENTERED_UPWIND
Definition cs_param_types.h:370
@ CS_PARAM_N_ADVECTION_SCHEMES
Definition cs_param_types.h:378
@ CS_PARAM_ADVECTION_SCHEME_UPWIND_V8
Definition cs_param_types.h:376
@ CS_PARAM_ADVECTION_SCHEME_CIP_CW
Definition cs_param_types.h:369
@ CS_PARAM_ADVECTION_SCHEME_UPWIND
Definition cs_param_types.h:373
@ CS_PARAM_ADVECTION_SCHEME_CENTERED
Definition cs_param_types.h:367
@ CS_PARAM_ADVECTION_SCHEME_CIP
Definition cs_param_types.h:368
@ CS_PARAM_ADVECTION_SCHEME_CENTERED_V8
Definition cs_param_types.h:375
@ CS_PARAM_ADVECTION_SCHEME_CENTERED_DDE
Definition cs_param_types.h:374
const char * cs_param_get_precond_name(cs_param_precond_type_t precond)
Get the name of the preconditioner.
Definition cs_param_types.cpp:599
cs_param_solver_type_t
Definition cs_param_types.h:848
@ CS_PARAM_SOLVER_CR3
Definition cs_param_types.h:856
@ CS_PARAM_SOLVER_SYM_GAUSS_SEIDEL
Definition cs_param_types.h:864
@ CS_PARAM_SOLVER_GMRES
Definition cs_param_types.h:861
@ CS_PARAM_SOLVER_GAUSS_SEIDEL
Definition cs_param_types.h:859
@ CS_PARAM_SOLVER_FGMRES
Definition cs_param_types.h:858
@ CS_PARAM_SOLVER_USER_DEFINED
Definition cs_param_types.h:865
@ CS_PARAM_SOLVER_NONE
Definition cs_param_types.h:850
@ CS_PARAM_N_SOLVER_TYPES
Definition cs_param_types.h:867
@ CS_PARAM_SOLVER_FCG
Definition cs_param_types.h:857
@ CS_PARAM_SOLVER_MUMPS
Definition cs_param_types.h:863
@ CS_PARAM_SOLVER_AMG
Definition cs_param_types.h:852
@ CS_PARAM_SOLVER_BICGS2
Definition cs_param_types.h:854
@ CS_PARAM_SOLVER_BICGS
Definition cs_param_types.h:853
@ CS_PARAM_SOLVER_JACOBI
Definition cs_param_types.h:862
@ CS_PARAM_SOLVER_GCR
Definition cs_param_types.h:860
@ CS_PARAM_SOLVER_CG
Definition cs_param_types.h:855
cs_param_dof_reduction_t
Definition cs_param_types.h:244
@ CS_PARAM_N_REDUCTIONS
Definition cs_param_types.h:249
@ CS_PARAM_REDUCTION_DERHAM
Definition cs_param_types.h:246
@ CS_PARAM_REDUCTION_AVERAGE
Definition cs_param_types.h:247
const char * cs_param_get_advection_strategy_name(cs_param_advection_strategy_t adv_stra)
Get the label associated to the advection strategy.
Definition cs_param_types.cpp:334
const char * cs_param_get_advection_scheme_name(cs_param_advection_scheme_t scheme)
Get the label of the advection scheme.
Definition cs_param_types.cpp:303
const char * cs_param_get_dotprod_type_name(cs_param_dotprod_type_t dp_type)
Get the name of the type of dot product to apply.
Definition cs_param_types.cpp:506
const char * cs_param_get_bc_name(cs_param_bc_type_t bc)
Get the name of the type of boundary condition.
Definition cs_param_types.cpp:383
cs_param_advection_strategy_t
Choice of how to handle the advection term in an equation.
Definition cs_param_types.h:401
@ CS_PARAM_N_ADVECTION_STRATEGIES
Definition cs_param_types.h:407
@ CS_PARAM_ADVECTION_IMPLICIT_FULL
Definition cs_param_types.h:403
@ CS_PARAM_ADVECTION_IMPLICIT_LINEARIZED
Definition cs_param_types.h:404
@ CS_PARAM_ADVECTION_EXPLICIT
Definition cs_param_types.h:405
cs_param_dotprod_type_t
Definition cs_param_types.h:896
@ CS_PARAM_DOTPROD_CDO
Definition cs_param_types.h:899
@ CS_PARAM_DOTPROD_EUCLIDEAN
Definition cs_param_types.h:898
@ CS_PARAM_N_DOTPROD_TYPES
Definition cs_param_types.h:901
char * algo
Definition field_names.h:102
Set of parameters to check the convergence (or the divergence) of an iterative process (tolerances or...
Definition cs_param_types.h:570
double dtol
Definition cs_param_types.h:589
double rtol
Definition cs_param_types.h:588
double atol
Definition cs_param_types.h:587
int n_max_iter
Definition cs_param_types.h:590