8.3
general documentation
cs_benchmark.h
Go to the documentation of this file.
1#ifndef __CS_BENCHMARK_H__
2#define __CS_BENCHMARK_H__
3
4/*============================================================================
5 * Low-level operator benchmarking
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_base.h"
35
36/*----------------------------------------------------------------------------*/
37
38BEGIN_C_DECLS
39
40/*============================================================================
41 * Macro definitions
42 *============================================================================*/
43
44/*============================================================================
45 * Type definitions
46 *============================================================================*/
47
48/*=============================================================================
49 * Public function prototypes
50 *============================================================================*/
51
52/*----------------------------------------------------------------------------
53 * Run simple benchmarks.
54 *
55 * parameters:
56 * mpi_trace_mode --> indicates if timing mode (0) or MPI trace-friendly
57 * mode (1) is to be used
58 *----------------------------------------------------------------------------*/
59
60void
61cs_benchmark(int mpi_trace_mode);
62
63/*----------------------------------------------------------------------------*/
64
65END_C_DECLS
66
67#endif /* __CS_BENCHMARK_H__ */
cs_base.h
cs_benchmark
void cs_benchmark(int mpi_trace_mode)
Definition: cs_benchmark.cpp:1143
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:543