programmer's 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-2018 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_param.h"
33 
34 /*----------------------------------------------------------------------------*/
35 
37 
38 /*============================================================================
39  * Macro definitions
40  *============================================================================*/
41 
42 /*============================================================================
43  * Type definitions
44  *============================================================================*/
45 
63 typedef enum {
64 
68 
70 
72 
88 typedef enum {
89 
93 
95 
97 
113 typedef enum {
114 
119 
121 
123 
129 typedef struct {
130 
135 
140 
146 
151 
156 
166 
171 
176 
182 
184 
214 typedef enum {
215 
222 
224 
226 
227 /*============================================================================
228  * Inline static public function prototypes
229  *============================================================================*/
230 
231 /*----------------------------------------------------------------------------*/
242 /*----------------------------------------------------------------------------*/
243 
244 static inline bool
246 {
247  if (nsp == NULL)
248  return true;
249 
251  return true;
252  else
253  return false;
254 }
255 
256 /*============================================================================
257  * Public function prototypes
258  *============================================================================*/
259 
260 /*----------------------------------------------------------------------------*/
271 /*----------------------------------------------------------------------------*/
272 
275  cs_navsto_param_time_state_t time_state,
276  cs_navsto_param_coupling_t algo_coupling);
277 
278 /*----------------------------------------------------------------------------*/
286 /*----------------------------------------------------------------------------*/
287 
290 
291 /*----------------------------------------------------------------------------*/
300 /*----------------------------------------------------------------------------*/
301 
302 void
304  cs_navsto_key_t key,
305  const char *keyval);
306 
307 /*----------------------------------------------------------------------------*/
313 /*----------------------------------------------------------------------------*/
314 
315 void
317 
318 /*----------------------------------------------------------------------------*/
319 
321 
322 #endif /* __CS_NAVSTO_PARAM_H__ */
Definition: cs_navsto_param.h:221
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:286
Definition: cs_navsto_param.h:223
Definition: cs_navsto_param.h:67
static bool cs_navsto_param_is_steady(cs_navsto_param_t *nsp)
Create a new structure to store all numerical parameters related to the resolution of the Navier-Stok...
Definition: cs_navsto_param.h:245
cs_navsto_param_coupling_t
Choice of algorithm for solving the system.
Definition: cs_navsto_param.h:113
Definition: cs_navsto_param.h:120
Definition: cs_navsto_param.h:66
Definition: cs_navsto_param.h:220
Definition: cs_navsto_param.h:90
cs_real_3_t gravity
Definition: cs_navsto_param.h:165
#define BEGIN_C_DECLS
Definition: cs_defs.h:461
Definition: cs_navsto_param.h:117
Definition: cs_navsto_param.h:92
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:181
Structure storing the parameters related to the resolution of the Navier-Stokes system.
Definition: cs_navsto_param.h:129
Definition: cs_navsto_param.h:94
double cs_real_t
Floating-point value.
Definition: cs_defs.h:297
cs_navsto_param_time_state_t
Status of the time for the Navier-Stokes system of equations.
Definition: cs_navsto_param.h:88
cs_navsto_key_t
List of available keys for setting the parameters of the Navier-Stokes system.
Definition: cs_navsto_param.h:214
bool has_gravity
Definition: cs_navsto_param.h:164
cs_param_time_scheme_t time_scheme
Definition: cs_navsto_param.h:144
Definition: cs_navsto_param.h:69
cs_navsto_param_model_t model
Definition: cs_navsto_param.h:155
cs_param_time_scheme_t
Definition: cs_param.h:177
cs_param_dof_reduction_t
Definition: cs_param.h:148
Definition: cs_navsto_param.h:216
Definition: cs_navsto_param.h:219
cs_real_t cs_real_3_t[3]
vector of 3 floating-point values
Definition: cs_defs.h:309
Definition: cs_navsto_param.h:65
Definition: cs_navsto_param.h:91
#define END_C_DECLS
Definition: cs_defs.h:462
Definition: cs_navsto_param.h:115
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:159
int verbosity
Definition: cs_navsto_param.h:134
cs_real_t ac_zeta_coef
Definition: cs_navsto_param.h:181
Definition: cs_navsto_param.h:118
Definition: cs_navsto_param.h:116
Definition: cs_navsto_param.h:218
cs_param_dof_reduction_t dof_reduction_mode
Definition: cs_navsto_param.h:139
cs_param_space_scheme_t
Type of numerical scheme for the discretization in space.
Definition: cs_param.h:122
cs_navsto_param_model_t
Modelling related to the Navier-Stokes system of equations.
Definition: cs_navsto_param.h:63
cs_navsto_param_t * cs_navsto_param_create(cs_navsto_param_model_t model, cs_navsto_param_time_state_t time_state, cs_navsto_param_coupling_t algo_coupling)
Create a new structure to store all numerical parameters related to the resolution of the Navier-Stok...
Definition: cs_navsto_param.c:122
Definition: cs_navsto_param.h:217
cs_real_t theta
Definition: cs_navsto_param.h:145
cs_navsto_param_time_state_t time_state
Definition: cs_navsto_param.h:170
cs_navsto_param_coupling_t coupling
Definition: cs_navsto_param.h:175
cs_param_space_scheme_t space_scheme
Definition: cs_navsto_param.h:150