7.0
general documentation
cs_navsto_sles.h
Go to the documentation of this file.
1 #ifndef __CS_NAVSTO_SLES_H__
2 #define __CS_NAVSTO_SLES_H__
3 
4 /*============================================================================
5  * Routines to handle SLES structure and PETSc interfaces for solving the
6  * Navier-Stokes system of equations
7  *============================================================================*/
8 
9 /*
10  This file is part of Code_Saturne, a general-purpose CFD tool.
11 
12  Copyright (C) 1998-2021 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 #if defined(HAVE_PETSC)
34 #include <petscksp.h>
35 #endif
36 
37 /*----------------------------------------------------------------------------*/
38 
39 BEGIN_C_DECLS
40 
41 /*============================================================================
42  * Macro definitions
43  *============================================================================*/
44 
45 /*============================================================================
46  * Type definitions
47  *============================================================================*/
48 
49 /*============================================================================
50  * Public function prototypes
51  *============================================================================*/
52 
53 #if defined(HAVE_PETSC)
54 /*----------------------------------------------------------------------------
55  * \brief Function pointer: setup hook for setting PETSc solver and
56  * preconditioner.
57  * Case of multiplicative block preconditioner for a CG
58  *
59  * \param[in, out] context pointer to optional (untyped) value or structure
60  * \param[in, out] ksp pointer to PETSc KSP context
61  *----------------------------------------------------------------------------*/
62 
63 void
64 cs_navsto_sles_amg_block_hook(void *context,
65  KSP ksp);
66 #endif
67 
68 /*----------------------------------------------------------------------------*/
69 
70 END_C_DECLS
71 
72 #endif /* __CS_NAVSTO_SLES_H__ */
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:495
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:496