programmer's documentation
cs_navsto_coupling.h
Go to the documentation of this file.
1 #ifndef __CS_NAVSTO_COUPLING_H__
2 #define __CS_NAVSTO_COUPLING_H__
3 
4 /*============================================================================
5  * Routines to handle structures used as a context when solving the
6  * Navier-Stokes equations. Structures are cast on-the-fly according to the
7  * type of coupling.
8  *============================================================================*/
9 
10 /*
11  This file is part of Code_Saturne, a general-purpose CFD tool.
12 
13  Copyright (C) 1998-2018 EDF S.A.
14 
15  This program is free software; you can redistribute it and/or modify it under
16  the terms of the GNU General Public License as published by the Free Software
17  Foundation; either version 2 of the License, or (at your option) any later
18  version.
19 
20  This program is distributed in the hope that it will be useful, but WITHOUT
21  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
22  FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
23  details.
24 
25  You should have received a copy of the GNU General Public License along with
26  this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
27  Street, Fifth Floor, Boston, MA 02110-1301, USA.
28 */
29 
30 /*----------------------------------------------------------------------------
31  * Local headers
32  *----------------------------------------------------------------------------*/
33 
34 #include "cs_equation.h"
35 #include "cs_field.h"
36 #include "cs_param.h"
37 #include "cs_mesh.h"
38 #include "cs_navsto_param.h"
39 #include "cs_time_step.h"
40 #include "cs_xdef.h"
41 
42 /*----------------------------------------------------------------------------*/
43 
45 
54 /*============================================================================
55  * Macro definitions
56  *============================================================================*/
57 
58 /*============================================================================
59  * Type definitions
60  *============================================================================*/
61 
62 /* Predefined context structures depending on the settings */
63 /* ======================================================= */
64 
73 typedef struct {
74 
80 
88 typedef struct {
89 
96 
104 typedef struct {
105 
116 
124 typedef struct {
125 
132 
133 /*============================================================================
134  * Public function prototypes
135  *============================================================================*/
136 
137 /*----------------------------------------------------------------------------*/
138 
140 
141 #endif /* __CS_NAVSTO_COUPLING_H__ */
cs_property_t * zeta
Definition: cs_navsto_coupling.h:111
cs_equation_t * correction
Definition: cs_navsto_coupling.h:128
cs_equation_t * momentum
Definition: cs_navsto_coupling.h:106
#define BEGIN_C_DECLS
Definition: cs_defs.h:461
cs_property_t * zeta
Definition: cs_navsto_coupling.h:92
cs_equation_t * graddiv
Definition: cs_navsto_coupling.h:107
cs_equation_t * energy
Definition: cs_navsto_coupling.h:77
cs_equation_t * momentum
Definition: cs_navsto_coupling.h:75
cs_equation_t * mass
Definition: cs_navsto_coupling.h:76
Set of parameters specific for solving the Navier-Stokes system with the "artificial compressibility"...
Definition: cs_navsto_coupling.h:104
Set of parameters specific for solving the Navier-Stokes system with an incremental projection algori...
Definition: cs_navsto_coupling.h:124
#define END_C_DECLS
Definition: cs_defs.h:462
cs_equation_t * momentum
Definition: cs_navsto_coupling.h:90
Set of parameters specific for solving the Navier-Stokes system with the "artificial compressibility"...
Definition: cs_navsto_coupling.h:88
Main structure to handle the discretization and the resolution of an equation.
cs_equation_t * prediction
Definition: cs_navsto_coupling.h:126
Definition: cs_property.h:63
Set of parameters specific for solving the Navier-Stokes system with a fully coupled algorithm using ...
Definition: cs_navsto_coupling.h:73