8.2
general documentation
cs_param_sles_setup.h
Go to the documentation of this file.
1 #ifndef __CS_PARAM_SLES_SETUP_H__
2 #define __CS_PARAM_SLES_SETUP_H__
3 
4 /*============================================================================
5  * Routines to handle the SLES settings relying on a cs_param_sles_t
6  *============================================================================*/
7 
8 /*
9  This file is part of code_saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2024 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 "cs_param_sles.h"
35 
36 /*----------------------------------------------------------------------------*/
37 
38 BEGIN_C_DECLS
39 
47 /*============================================================================
48  * Macro definitions
49  *============================================================================*/
50 
51 /*============================================================================
52  * Type definitions
53  *============================================================================*/
54 
55 /*============================================================================
56  * Global variables
57  *============================================================================*/
58 
59 /*============================================================================
60  * Public function prototypes
61  *============================================================================*/
62 
63 /*----------------------------------------------------------------------------*/
73 /*----------------------------------------------------------------------------*/
74 
75 int
76 cs_param_sles_setup(bool use_field_id,
77  cs_param_sles_t *slesp);
78 
79 /*----------------------------------------------------------------------------*/
91 /*----------------------------------------------------------------------------*/
92 
93 void
94 cs_param_sles_setup_cvg_param(bool use_field_id,
95  const cs_param_sles_t *slesp);
96 
97 #if defined(HAVE_PETSC)
98 /*----------------------------------------------------------------------------*/
107 /*----------------------------------------------------------------------------*/
108 
109 void
110 cs_param_sles_setup_petsc_cmd(bool use_prefix,
111  const char *prefix,
112  const char *keyword,
113  const char *keyval);
114 
115 /*----------------------------------------------------------------------------*/
124 /*----------------------------------------------------------------------------*/
125 
126 void
127 cs_param_sles_setup_petsc_ksp(const char *label,
128  cs_param_sles_t *slesp,
129  void *p_ksp);
130 
131 /*----------------------------------------------------------------------------*/
139 /*----------------------------------------------------------------------------*/
140 
141 void
142 cs_param_sles_setup_petsc_pc_amg(const char *prefix,
143  cs_param_sles_t *slesp,
144  void *p_pc);
145 #endif
146 
147 /*----------------------------------------------------------------------------*/
148 
149 END_C_DECLS
150 
151 #endif /* __CS_PARAM_SLES_SETUP_H__ */
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:528
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:529
cs_param_sles.h
Structure and routines handling the SLES ((Sparse Linear Equation Solver) settings stored inside a cs...
cs_param_sles_setup_cvg_param
void cs_param_sles_setup_cvg_param(bool use_field_id, const cs_param_sles_t *slesp)
Update the settings associated to a cs_sles_t structure and apply those defined in the given cs_param...
Definition: cs_param_sles_setup.c:2848
cs_param_sles_setup
int cs_param_sles_setup(bool use_field_id, cs_param_sles_t *slesp)
Define cs_sles_t structure in accordance with the settings of a cs_param_sles_t structure (SLES = Spa...
Definition: cs_param_sles_setup.c:2771
label
char * label
Definition: keywords.h:58
cs_param_sles_t
Structure storing all metadata related to the resolution of a linear system with an iterative solver.
Definition: cs_param_sles.h:64