9.2
general documentation
cs_matrix_hypre_priv.h
Go to the documentation of this file.
1#ifndef CS_MATRIX_HYPRE_PRIV_H
2#define CS_MATRIX_HYPRE_PRIV_H
3
4/*============================================================================
5 * Private types for sparse matrix representation and operations using HYPRE.
6 *============================================================================*/
7
8/*
9 This file is part of code_saturne, a general-purpose CFD tool.
10
11 Copyright (C) 1998-2026 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 * HYPRE headers
32 *----------------------------------------------------------------------------*/
33
34#include <HYPRE.h>
35#include <HYPRE_IJ_mv.h>
36#include <HYPRE_parcsr_mv.h>
37#include <HYPRE_utilities.h>
38
39/*----------------------------------------------------------------------------
40 * Local headers
41 *----------------------------------------------------------------------------*/
42
43#include "base/cs_defs.h"
44
45#include "alge/cs_matrix_hypre.h"
46
47/*----------------------------------------------------------------------------*/
48
51/*============================================================================
52 * Macro definitions
53 *============================================================================*/
54
55/*============================================================================
56 * Global variables
57 *============================================================================*/
58
59extern const char cs_matrix_hypre_ij_type_name[];
60extern const char cs_matrix_hypre_ij_type_name_device[];
61
62/*============================================================================
63 * Type definitions
64 *============================================================================*/
65
66/* Note that most types are declared in cs_matrix_priv.h.
67 only those only handled here are declared here. */
68
69/* Adapter coefficients stucture for HYPRE */
70
71typedef struct _cs_matrix_coeffs_hypre_t {
72
73 HYPRE_BigInt l_range[2]; /* Local rows range
74 (block range if block size > 1) */
75 HYPRE_MemoryLocation memory_location; /* Memory location */
76
77 HYPRE_IJMatrix hm; /* HYPRE matrix */
78 HYPRE_IJVector hx; /* x (input) vector */
79 HYPRE_IJVector hy; /* y (output) vector */
80
81 int matrix_state; /* Matrix state:
82 0: not created
83 1: created and assembled */
84
85 HYPRE_Int max_chunk_size; /* Chunk size */
86 HYPRE_BigInt *row_buf; /* row ids buffer */
87 HYPRE_BigInt *col_buf; /* column ids buffer */
88 HYPRE_Real *val_buf; /* values ids buffer */
89
90
91} cs_matrix_coeffs_hypre_t;
92
93/*=============================================================================
94 * Semi-private function prototypes
95 *============================================================================*/
96
97/*----------------------------------------------------------------------------*/
105/*----------------------------------------------------------------------------*/
106
107extern "C" cs_matrix_coeffs_hypre_t *
108cs_matrix_hypre_get_coeffs(const cs_matrix_t *matrix);
109
112/*----------------------------------------------------------------------------*/
113
114#endif /* CS_MATRIX_HYPRE_PRIV_H */
cs_defs.h
cs_matrix_t
struct _cs_matrix_t cs_matrix_t
Definition: cs_matrix.h:108
cs_matrix_hypre.h