8.3
general documentation
cs_benchmark_matrix.h
Go to the documentation of this file.
1#ifndef __CS_BENCHMARK_MATRIX_H__
2#define __CS_BENCHMARK_MATRIX_H__
3
4/*============================================================================
5 * Sparse Matrix Representation and Operations
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_halo.h"
37#include "cs_numbering.h"
38#include "cs_halo_perio.h"
39
40/*----------------------------------------------------------------------------*/
41
43
44/*============================================================================
45 * Macro definitions
46 *============================================================================*/
47
48/*============================================================================
49 * Type definitions
50 *============================================================================*/
51
52/*============================================================================
53 * Global variables
54 *============================================================================*/
55
56/*=============================================================================
57 * Public function prototypes
58 *============================================================================*/
59
60/*----------------------------------------------------------------------------
61 * Time matrix operations.
62 *
63 * parameters:
64 * n_time_runs <-- number of timing runs for each measure
65 * n_types <-- number of matrix types timed, or 0
66 * n_fill_types <-- number of fill types timed, or 0
67 * types <-- array of matrix types timed, or NULL
68 * fill_types <-- array of fill types timed, or NULL
69 * n_cells <-- number of local cells
70 * n_cells_ext <-- number of cells including ghost cells (array size)
71 * n_faces <-- local number of internal faces
72 * cell_num <-- Optional global cell numbers (1 to n), or NULL
73 * face_cell <-- face -> cells connectivity
74 * halo <-- cell halo structure
75 * numbering <-- vectorization or thread-related numbering info, or NULL
76 *----------------------------------------------------------------------------*/
77
78void
79cs_benchmark_matrix(int n_time_runs,
80 int n_types,
81 int n_fill_types,
82 cs_matrix_type_t types[],
83 cs_matrix_fill_type_t fill_types[],
84 cs_lnum_t n_cells,
85 cs_lnum_t n_cells_ext,
86 cs_lnum_t n_faces,
87 const cs_lnum_2_t *face_cell,
88 const cs_halo_t *halo,
89 const cs_numbering_t *numbering);
90
91/*----------------------------------------------------------------------------*/
92
94
95#endif /* __CS_BENCHMARK_MATRIX_H__ */
void cs_benchmark_matrix(int n_time_runs, int n_types, int n_fill_types, cs_matrix_type_t types[], cs_matrix_fill_type_t fill_types[], cs_lnum_t n_cells, cs_lnum_t n_cells_ext, cs_lnum_t n_faces, const cs_lnum_2_t *face_cell, const cs_halo_t *halo, const cs_numbering_t *numbering)
Definition: cs_benchmark_matrix.cpp:1659
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
cs_lnum_t cs_lnum_2_t[2]
vector of 2 local mesh-entity ids
Definition: cs_defs.h:352
#define END_C_DECLS
Definition: cs_defs.h:543
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:335
cs_matrix_fill_type_t
Definition: cs_matrix.h:72
cs_matrix_type_t
Definition: cs_matrix.h:54
Definition: cs_halo.h:77
Definition: cs_numbering.h:87