Debian Codegraph @

include/deal.II/differentiation/sd/symengine_number_traits.h

raw
1 // ------------------------------------------------------------------------
2 //
3 // SPDX-License-Identifier: LGPL-2.1-or-later
4 // Copyright (C) 2019 - 2024 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_differentiation_sd_symengine_number_traits_h
16 #define dealii_differentiation_sd_symengine_number_traits_h
17
18 #include <deal.II/base/config.h>
19
20 #ifdef DEAL_II_WITH_SYMENGINE
21
22 # include <symengine/expression.h>
23
24 # include <type_traits>
25
26
27 DEAL_II_NAMESPACE_OPEN
28
29
30 namespace Differentiation
31 {
32 namespace SD
33 {
34 /**
35 * A struct to indicate whether a given @p NumberType is a supported
36 * symbolically differentiable number or not. By default, numbers are not
37 * considered to have the necessary characteristics to fulfill this
38 * condition.
39 */
40 template <typename NumberType>
41 struct is_sd_number : std::false_type
42 {};
43
44
45 /**
46 * A struct to indicate whether a given @p NumberType is a supported
47 * SymEngine number or not. By default, numbers are not
48 * considered to have the necessary characteristics to fulfill this
49 * condition.
50 */
51 template <typename NumberType>
52 struct is_symengine_number : std::false_type
53 {};
54
55
56 /*--- SymEngine Expression class ---*/
57
58
59 /**
60 * A struct to indicate whether a given @p NumberType is a supported
61 * symbolically differentiable number or not.
62 * This is a specialization for the SymEngine Expression class.
63 */
64 template <>
65 struct is_symengine_number<SymEngine::Expression> : std::true_type
66 {};
67
68
69 /**
70 * A struct to indicate whether a given @p NumberType is a supported
71 * symbolically differentiable number or not.
72 * This is a specialization for the SymEngine Expression class.
73 */
74 template <>
75 struct is_sd_number<SymEngine::Expression> : std::true_type
76 {};
77
78 } // namespace SD
79 } // namespace Differentiation
80
81
82 DEAL_II_NAMESPACE_CLOSE
83
84 #else
85
86 // Make sure the scripts that create the C++20 module input files have
87 // something to latch on if the preprocessor #ifdef above would
88 // otherwise lead to an empty content of the file.
89 DEAL_II_NAMESPACE_OPEN
90 DEAL_II_NAMESPACE_CLOSE
91
92 #endif // DEAL_II_WITH_SYMENGINE
93
94 #endif // dealii_differentiation_sd_symengine_number_traits_h