8.3
general documentation
cs_matrix_petsc.h
Go to the documentation of this file.
1#ifndef __CS_MATRIX_PETSC_H__
2#define __CS_MATRIX_PETSC_H__
3
4/*============================================================================
5 * Sparse Matrix Representation and Operations using PETSc library.
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_defs.h"
35
36#include "cs_matrix.h"
37
38/*----------------------------------------------------------------------------*/
39
40BEGIN_C_DECLS
41
42/*============================================================================
43 * Macro definitions
44 *============================================================================*/
45
46/*============================================================================
47 * Type definitions
48 *============================================================================*/
49
50/*============================================================================
51 * Global variables
52 *============================================================================*/
53
54/*=============================================================================
55 * Public function prototypes
56 *============================================================================*/
57
58/*----------------------------------------------------------------------------
59 * Initialize PETSc if needed
60 *----------------------------------------------------------------------------*/
61
62void
63cs_matrix_petsc_ensure_init(void);
64
65/*----------------------------------------------------------------------------
66 * Finalize PETSc
67 *----------------------------------------------------------------------------*/
68
69void
70cs_matrix_petsc_finalize(void);
71
72/*----------------------------------------------------------------------------*/
83/*----------------------------------------------------------------------------*/
84
85void
86cs_matrix_set_type_petsc(cs_matrix_t *matrix,
87 const char *type_name);
88
89/*----------------------------------------------------------------------------*/
90
91END_C_DECLS
92
93#endif /* __CS_MATRIX_PETSC_H__ */
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:543
cs_matrix.h
cs_matrix_t
struct _cs_matrix_t cs_matrix_t
Definition: cs_matrix.h:110
cs_matrix_petsc_ensure_init
void cs_matrix_petsc_ensure_init(void)
cs_matrix_petsc_finalize
void cs_matrix_petsc_finalize(void)
cs_matrix_set_type_petsc
void cs_matrix_set_type_petsc(cs_matrix_t *matrix, const char *type_name)
Switch matrix type to PETSc.
Definition: cs_matrix_petsc.cpp:1579