7.2
general documentation
cs_equation_system_sles.h
Go to the documentation of this file.
1 #ifndef __CS_EQUATION_SYSTEM_SLES_H__
2 #define __CS_EQUATION_SYSTEM_SLES_H__
3 
4 /*============================================================================
5  * Functions to handle the solving step of systems of equations hinging on the
6  * cs_equation_system_t structure
7  *============================================================================*/
8 
9 /*
10  This file is part of code_saturne, a general-purpose CFD tool.
11 
12  Copyright (C) 1998-2022 EDF S.A.
13 
14  This program is free software; you can redistribute it and/or modify it under
15  the terms of the GNU General Public License as published by the Free Software
16  Foundation; either version 2 of the License, or (at your option) any later
17  version.
18 
19  This program is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
21  FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
22  details.
23 
24  You should have received a copy of the GNU General Public License along with
25  this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
26  Street, Fifth Floor, Boston, MA 02110-1301, USA.
27 */
28 
29 /*----------------------------------------------------------------------------
30  * Local headers
31  *----------------------------------------------------------------------------*/
32 
33 #include "cs_equation.h"
34 #include "cs_equation_system_param.h"
35 
36 /*----------------------------------------------------------------------------*/
37 
38 BEGIN_C_DECLS
39 
40 /*============================================================================
41  * Macro definitions
42  *============================================================================*/
43 
44 /*============================================================================
45  * Type definitions
46  *============================================================================*/
47 
48 /*============================================================================
49  * Public function prototypes
50  *============================================================================*/
51 
52 /*----------------------------------------------------------------------------*/
60 /*----------------------------------------------------------------------------*/
61 
62 void
63 cs_equation_system_sles_init(int n_eqs,
64  cs_equation_system_param_t *sysp,
65  cs_equation_core_t **blocks);
66 
67 /*----------------------------------------------------------------------------*/
68 
69 END_C_DECLS
70 
71 #endif /* __CS_EQUATION_SYSTEM_SLES_H__ */
cs_equation_system_param.h
cs_equation_system_sles_init
void cs_equation_system_sles_init(int n_eqs, cs_equation_system_param_t *sysp, cs_equation_core_t **blocks)
Set the SLES associated to a system of equation.
Definition: cs_equation_system_sles.c:152
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:510
cs_equation.h
cs_equation_system_param_t
Main structure storing the parameter settings.
Definition: cs_equation_system_param.h:71
cs_equation_core_t
Main structures composiing an equation structure.
Definition: cs_equation.h:82
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:511