Debian Codegraph @

include/deal.II/lac/vector_operation.h

raw
1 // ------------------------------------------------------------------------
2 //
3 // SPDX-License-Identifier: LGPL-2.1-or-later
4 // Copyright (C) 2017 - 2022 by the deal.II authors
5 //
6 // This file is part of the deal.II library.
7 //
8 // Part of the source code is dual licensed under Apache-2.0 WITH
9 // LLVM-exception OR LGPL-2.1-or-later. Detailed license information
10 // governing the source code and code contributions can be found in
11 // LICENSE.md and CONTRIBUTING.md at the top level directory of deal.II.
12 //
13 // ------------------------------------------------------------------------
14
15 #ifndef dealii_lac_vector_operation_h
16 #define dealii_lac_vector_operation_h
17
18 #include <deal.II/base/config.h>
19
20 DEAL_II_NAMESPACE_OPEN
21
22 /**
23 * @addtogroup Vectors
24 * @{
25 */
26
27 /**
28 * This enum keeps track of the current operation in parallel linear algebra
29 * objects like Vectors and Matrices.
30 *
31 * It is used in the various compress() functions. They also exist in serial
32 * codes for compatibility and are empty there.
33 *
34 * See
35 * @ref GlossCompress "Compressing distributed objects"
36 * for more information.
37 */
38 struct VectorOperation
39 {
40 enum values
41 {
42 /**
43 * The current operation is unknown.
44 */
45 unknown,
46 /**
47 * The current operation is an insertion.
48 */
49 insert,
50 /**
51 * The current operation is an addition.
52 */
53 add,
54 /**
55 * The current operation is a minimization.
56 */
57 min,
58 /**
59 * The current operation is a maximization.
60 */
61 max
62 };
63 };
64
65 /** @} */
66
67 DEAL_II_NAMESPACE_CLOSE
68
69 #endif