-
Notifications
You must be signed in to change notification settings - Fork 1
/
SubstanceAmount.hpp
200 lines (162 loc) · 7.8 KB
/
SubstanceAmount.hpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
// Copyright © 2020-2024 Alexandre Coderre-Chabot
//
// This file is part of Physical Quantities (PhQ), a C++ library of physical quantities, physical
// models, and units of measure for scientific computing.
//
// Physical Quantities is hosted at:
// https://github.com/acodcha/phq
//
// Physical Quantities is licensed under the MIT License:
// https://mit-license.org
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
// associated documentation files (the "Software"), to deal in the Software without restriction,
// including without limitation the rights to use, copy, modify, merge, publish, distribute,
// sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// - The above copyright notice and this permission notice shall be included in all copies or
// substantial portions of the Software.
// - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
// BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#ifndef PHQ_SUBSTANCE_AMOUNT_HPP
#define PHQ_SUBSTANCE_AMOUNT_HPP
#include <cstddef>
#include <functional>
#include <ostream>
#include "DimensionalScalar.hpp"
#include "Unit/SubstanceAmount.hpp"
namespace PhQ {
/// \brief Amount of substance. Typically measured in moles (mol).
template <typename NumericType = double>
class SubstanceAmount : public DimensionalScalar<Unit::SubstanceAmount, NumericType> {
public:
/// \brief Default constructor. Constructs a substance amount with an uninitialized value.
SubstanceAmount() = default;
/// \brief Constructor. Constructs a substance amount with a given value expressed in a given
/// substance amount unit.
SubstanceAmount(const NumericType value, const Unit::SubstanceAmount unit)
: DimensionalScalar<Unit::SubstanceAmount, NumericType>(value, unit) {}
/// \brief Destructor. Destroys this substance amount.
~SubstanceAmount() noexcept = default;
/// \brief Copy constructor. Constructs a substance amount by copying another one.
constexpr SubstanceAmount(const SubstanceAmount<NumericType>& other) = default;
/// \brief Copy constructor. Constructs a substance amount by copying another one.
template <typename OtherNumericType>
explicit constexpr SubstanceAmount(const SubstanceAmount<OtherNumericType>& other)
: SubstanceAmount(static_cast<NumericType>(other.Value())) {}
/// \brief Move constructor. Constructs a substance amount by moving another one.
constexpr SubstanceAmount(SubstanceAmount<NumericType>&& other) noexcept = default;
/// \brief Copy assignment operator. Assigns this substance amount by copying another one.
constexpr SubstanceAmount<NumericType>& operator=(
const SubstanceAmount<NumericType>& other) = default;
/// \brief Copy assignment operator. Assigns this substance amount by copying another one.
template <typename OtherNumericType>
constexpr SubstanceAmount<NumericType>& operator=(
const SubstanceAmount<OtherNumericType>& other) {
this->value = static_cast<NumericType>(other.Value());
return *this;
}
/// \brief Move assignment operator. Assigns this substance amount by moving another one.
constexpr SubstanceAmount<NumericType>& operator=(
SubstanceAmount<NumericType>&& other) noexcept = default;
/// \brief Statically creates a substance amount of zero.
[[nodiscard]] static constexpr SubstanceAmount<NumericType> Zero() {
return SubstanceAmount<NumericType>{static_cast<NumericType>(0)};
}
/// \brief Statically creates a substance amount with a given value expressed in a given substance
/// amount unit.
template <Unit::SubstanceAmount Unit>
[[nodiscard]] static constexpr SubstanceAmount<NumericType> Create(const NumericType value) {
return SubstanceAmount<NumericType>{
ConvertStatically<Unit::SubstanceAmount, Unit, Standard<Unit::SubstanceAmount>>(value)};
}
constexpr SubstanceAmount<NumericType> operator+(
const SubstanceAmount<NumericType>& substance_amount) const {
return SubstanceAmount<NumericType>{this->value + substance_amount.value};
}
constexpr SubstanceAmount<NumericType> operator-(
const SubstanceAmount<NumericType>& substance_amount) const {
return SubstanceAmount<NumericType>{this->value - substance_amount.value};
}
constexpr SubstanceAmount<NumericType> operator*(const NumericType number) const {
return SubstanceAmount<NumericType>{this->value * number};
}
constexpr SubstanceAmount<NumericType> operator/(const NumericType number) const {
return SubstanceAmount<NumericType>{this->value / number};
}
constexpr NumericType operator/(
const SubstanceAmount<NumericType>& substance_amount) const noexcept {
return this->value / substance_amount.value;
}
constexpr void operator+=(const SubstanceAmount<NumericType>& substance_amount) noexcept {
this->value += substance_amount.value;
}
constexpr void operator-=(const SubstanceAmount<NumericType>& substance_amount) noexcept {
this->value -= substance_amount.value;
}
constexpr void operator*=(const NumericType number) noexcept {
this->value *= number;
}
constexpr void operator/=(const NumericType number) noexcept {
this->value /= number;
}
private:
/// \brief Constructor. Constructs a substance amount with a given value expressed in the standard
/// substance amount unit.
explicit constexpr SubstanceAmount(const NumericType value)
: DimensionalScalar<Unit::SubstanceAmount, NumericType>(value) {}
};
template <typename NumericType>
inline constexpr bool operator==(
const SubstanceAmount<NumericType>& left, const SubstanceAmount<NumericType>& right) noexcept {
return left.Value() == right.Value();
}
template <typename NumericType>
inline constexpr bool operator!=(
const SubstanceAmount<NumericType>& left, const SubstanceAmount<NumericType>& right) noexcept {
return left.Value() != right.Value();
}
template <typename NumericType>
inline constexpr bool operator<(
const SubstanceAmount<NumericType>& left, const SubstanceAmount<NumericType>& right) noexcept {
return left.Value() < right.Value();
}
template <typename NumericType>
inline constexpr bool operator>(
const SubstanceAmount<NumericType>& left, const SubstanceAmount<NumericType>& right) noexcept {
return left.Value() > right.Value();
}
template <typename NumericType>
inline constexpr bool operator<=(
const SubstanceAmount<NumericType>& left, const SubstanceAmount<NumericType>& right) noexcept {
return left.Value() <= right.Value();
}
template <typename NumericType>
inline constexpr bool operator>=(
const SubstanceAmount<NumericType>& left, const SubstanceAmount<NumericType>& right) noexcept {
return left.Value() >= right.Value();
}
template <typename NumericType>
inline std::ostream& operator<<(
std::ostream& stream, const SubstanceAmount<NumericType>& substance_amount) {
stream << substance_amount.Print();
return stream;
}
template <typename NumericType>
inline constexpr SubstanceAmount<NumericType> operator*(
const NumericType number, const SubstanceAmount<NumericType>& substance_amount) {
return substance_amount * number;
}
} // namespace PhQ
namespace std {
template <typename NumericType>
struct hash<PhQ::SubstanceAmount<NumericType>> {
inline size_t operator()(const PhQ::SubstanceAmount<NumericType>& substance_amount) const {
return hash<NumericType>()(substance_amount.Value());
}
};
} // namespace std
#endif // PHQ_SUBSTANCE_AMOUNT_HPP