8.0
general documentation
cs_matrix_petsc_priv.h
Go to the documentation of this file.
1 #ifndef __CS_MATRIX_PETSC_PRIV_H__
2 #define __CS_MATRIX_PETSC_PRIV_H__
3 
4 /*============================================================================
5  * Private types for sparse matrix representation and operations using PETSc.
6  *============================================================================*/
7 
8 /*
9  This file is part of code_saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2023 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  * PETSc headers
32  *----------------------------------------------------------------------------*/
33 
34 #include <petscvec.h>
35 #include <petscmat.h>
36 
37 /*----------------------------------------------------------------------------
38  * Local headers
39  *----------------------------------------------------------------------------*/
40 
41 #include "cs_defs.h"
42 
43 #include "cs_matrix_petsc.h"
44 
45 /*----------------------------------------------------------------------------*/
46 
47 BEGIN_C_DECLS
48 
51 /*============================================================================
52  * Macro definitions
53  *============================================================================*/
54 
55 /*============================================================================
56  * Type definitions
57  *============================================================================*/
58 
59 /* Note that most types are declared in cs_matrix_priv.h.
60  only those only handled here are declared here. */
61 
62 /* Adapter coefficients stucture for PETSc */
63 
64 typedef struct _cs_matrix_coeffs_petsc_t {
65 
66  PetscInt l_range[2]; /* Local rows range
67  (block range if block size > 1) */
68 
69  Mat hm; /* PETSc matrix */
70  Vec hx; /* x (input) vector */
71  Vec hy; /* y (output) vector */
72 
73  int matrix_state; /* Matrix state:
74  0: not created
75  1: created and assembled */
76 
77  char *matype_r; /* requested PETSc matrix type */
78  MatType matype; /* actual PETSc matrix type */
79 
80 } cs_matrix_coeffs_petsc_t;
81 
82 /*=============================================================================
83  * Semi-private function prototypes
84  *============================================================================*/
85 
86 /*----------------------------------------------------------------------------*/
94 /*----------------------------------------------------------------------------*/
95 
96 cs_matrix_coeffs_petsc_t *
97 cs_matrix_petsc_get_coeffs(const cs_matrix_t *matrix);
98 
101 /*----------------------------------------------------------------------------*/
102 
103 END_C_DECLS
104 
105 #endif /* __CS_MATRIX_PETSC_PRIV_H__ */
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:509
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:510
cs_matrix_t
struct _cs_matrix_t cs_matrix_t
Definition: cs_matrix.h:110
matrix
void matrix(const int *iconvp, const int *idiffp, const int *ndircp, const int *isym, const cs_real_t *thetap, const int *imucpp, const cs_real_t coefbp[], const cs_real_t cofbfp[], const cs_real_t rovsdt[], const cs_real_t i_massflux[], const cs_real_t b_massflux[], const cs_real_t i_visc[], const cs_real_t b_visc[], const cs_real_t xcpp[], cs_real_t da[], cs_real_t xa[])
Definition: cs_matrix_building.c:111
cs_matrix_petsc.h