-
Notifications
You must be signed in to change notification settings - Fork 1
/
StrainRate.hpp
332 lines (271 loc) · 13.7 KB
/
StrainRate.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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
// 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_STRAIN_RATE_HPP
#define PHQ_STRAIN_RATE_HPP
#include <array>
#include <cstddef>
#include <functional>
#include <ostream>
#include "DimensionalSymmetricDyad.hpp"
#include "Frequency.hpp"
#include "ScalarStrainRate.hpp"
#include "Strain.hpp"
#include "SymmetricDyad.hpp"
#include "Unit/Frequency.hpp"
namespace PhQ {
// Forward declaration for class PhQ::StrainRate.
template <typename NumericType>
class VelocityGradient;
/// \brief Three-dimensional Euclidean strain rate symmetric dyadic tensor. Time rate of change of
/// strain. Contains six components in Cartesian coordinates: xx, xy = yx, xz = zx, yy, yz = zy, and
/// zz. For the scalar components or resultants of a strain rate tensor, see PhQ::ScalarStrainRate.
/// See also PhQ::Strain, PhQ::Time, and PhQ::Frequency.
template <typename NumericType = double>
class StrainRate : public DimensionalSymmetricDyad<Unit::Frequency, NumericType> {
public:
/// \brief Default constructor. Constructs a strain rate tensor with an uninitialized value.
StrainRate() = default;
/// \brief Constructor. Constructs a strain rate tensor with a given value expressed in a given
/// frequency unit.
StrainRate(const SymmetricDyad<NumericType>& value, Unit::Frequency unit)
: DimensionalSymmetricDyad<Unit::Frequency, NumericType>(value, unit) {}
/// \brief Constructor. Constructs a strain rate tensor from a given set of scalar strain rate
/// components.
StrainRate(const ScalarStrainRate<NumericType>& xx, const ScalarStrainRate<NumericType>& xy,
const ScalarStrainRate<NumericType>& xz, const ScalarStrainRate<NumericType>& yy,
const ScalarStrainRate<NumericType>& yz, const ScalarStrainRate<NumericType>& zz)
: StrainRate<NumericType>(
{xx.Value(), xy.Value(), xz.Value(), yy.Value(), yz.Value(), zz.Value()}) {}
/// \brief Constructor. Constructs a strain rate tensor from a given strain tensor and time using
/// the definition of the strain rate tensor.
constexpr StrainRate(const Strain<NumericType>& strain, const Time<NumericType>& time)
: StrainRate<NumericType>(strain.Value() / time.Value()) {}
/// \brief Constructor. Constructs a strain rate tensor from a given strain tensor and frequency
/// using the definition of the strain rate tensor.
constexpr StrainRate(const Strain<NumericType>& strain, const Frequency<NumericType>& frequency)
: StrainRate<NumericType>(strain.Value() * frequency.Value()) {}
/// \brief Constructor. Constructs a strain rate tensor from a given velocity gradient using the
/// definition of the strain rate tensor.
explicit constexpr StrainRate(const VelocityGradient<NumericType>& velocity_gradient);
/// \brief Destructor. Destroys this strain rate tensor.
~StrainRate() noexcept = default;
/// \brief Copy constructor. Constructs a strain rate tensor by copying another one.
constexpr StrainRate(const StrainRate<NumericType>& other) = default;
/// \brief Copy constructor. Constructs a strain rate tensor by copying another one.
template <typename OtherNumericType>
explicit constexpr StrainRate(const StrainRate<OtherNumericType>& other)
: StrainRate(static_cast<SymmetricDyad<NumericType>>(other.Value())) {}
/// \brief Move constructor. Constructs a strain rate tensor by moving another one.
constexpr StrainRate(StrainRate<NumericType>&& other) noexcept = default;
/// \brief Copy assignment operator. Assigns this strain rate tensor by copying another one.
constexpr StrainRate<NumericType>& operator=(const StrainRate<NumericType>& other) = default;
/// \brief Copy assignment operator. Assigns this strain rate tensor by copying another one.
template <typename OtherNumericType>
constexpr StrainRate<NumericType>& operator=(const StrainRate<OtherNumericType>& other) {
this->value = static_cast<SymmetricDyad<NumericType>>(other.Value());
return *this;
}
/// \brief Move assignment operator. Assigns this strain rate tensor by moving another one.
constexpr StrainRate<NumericType>& operator=(StrainRate<NumericType>&& other) noexcept = default;
/// \brief Statically creates a strain rate tensor of zero.
[[nodiscard]] static constexpr StrainRate<NumericType> Zero() {
return StrainRate<NumericType>{SymmetricDyad<NumericType>::Zero()};
}
/// \brief Statically creates a strain rate tensor from the given xx, xy, xz, yy, yz, and zz
/// Cartesian components expressed in a given frequency unit.
template <Unit::Frequency Unit>
[[nodiscard]] static constexpr StrainRate<NumericType> Create(
const NumericType xx, const NumericType xy, const NumericType xz, const NumericType yy,
const NumericType yz, const NumericType zz) {
return StrainRate<NumericType>{
ConvertStatically<Unit::Frequency, Unit, Standard<Unit::Frequency>>(
SymmetricDyad<NumericType>{xx, xy, xz, yy, yz, zz})};
}
/// \brief Statically creates a strain rate tensor from the given xx, xy, xz, yy, yz, and zz
/// Cartesian components expressed in a given frequency unit.
template <Unit::Frequency Unit>
[[nodiscard]] static constexpr StrainRate<NumericType> Create(
const std::array<NumericType, 6>& xx_xy_xz_yy_yz_zz) {
return StrainRate<NumericType>{
ConvertStatically<Unit::Frequency, Unit, Standard<Unit::Frequency>>(
SymmetricDyad<NumericType>{xx_xy_xz_yy_yz_zz})};
}
/// \brief Statically creates a strain rate tensor with a given value expressed in a given
/// frequency unit.
template <Unit::Frequency Unit>
[[nodiscard]] static constexpr StrainRate<NumericType> Create(
const SymmetricDyad<NumericType>& value) {
return StrainRate<NumericType>{
ConvertStatically<Unit::Frequency, Unit, Standard<Unit::Frequency>>(value)};
}
/// \brief Returns the xx Cartesian component of this strain rate tensor.
[[nodiscard]] constexpr ScalarStrainRate<NumericType> xx() const noexcept {
return ScalarStrainRate<NumericType>{this->value.xx()};
}
/// \brief Returns the xy = yx Cartesian component of this strain rate tensor.
[[nodiscard]] constexpr ScalarStrainRate<NumericType> xy() const noexcept {
return ScalarStrainRate<NumericType>{this->value.xy()};
}
/// \brief Returns the xz = zx Cartesian component of this strain rate tensor.
[[nodiscard]] constexpr ScalarStrainRate<NumericType> xz() const noexcept {
return ScalarStrainRate<NumericType>{this->value.xz()};
}
/// \brief Returns the yx = xy Cartesian component of this strain rate tensor.
[[nodiscard]] constexpr ScalarStrainRate<NumericType> yx() const noexcept {
return ScalarStrainRate<NumericType>{this->value.yx()};
}
/// \brief Returns the yy Cartesian component of this strain rate tensor.
[[nodiscard]] constexpr ScalarStrainRate<NumericType> yy() const noexcept {
return ScalarStrainRate<NumericType>{this->value.yy()};
}
/// \brief Returns the yz = zy Cartesian component of this strain rate tensor.
[[nodiscard]] constexpr ScalarStrainRate<NumericType> yz() const noexcept {
return ScalarStrainRate<NumericType>{this->value.yz()};
}
/// \brief Returns the zx = xz Cartesian component of this strain rate tensor.
[[nodiscard]] constexpr ScalarStrainRate<NumericType> zx() const noexcept {
return ScalarStrainRate<NumericType>{this->value.zx()};
}
/// \brief Returns the zy = yz Cartesian component of this strain rate tensor.
[[nodiscard]] constexpr ScalarStrainRate<NumericType> zy() const noexcept {
return ScalarStrainRate<NumericType>{this->value.zy()};
}
/// \brief Returns the zz Cartesian component of this strain rate tensor.
[[nodiscard]] constexpr ScalarStrainRate<NumericType> zz() const noexcept {
return ScalarStrainRate<NumericType>{this->value.zz()};
}
constexpr StrainRate operator+(const StrainRate<NumericType>& strain_rate) const {
return StrainRate<NumericType>{this->value + strain_rate.value};
}
constexpr StrainRate<NumericType> operator-(const StrainRate<NumericType>& strain_rate) const {
return StrainRate<NumericType>{this->value - strain_rate.value};
}
constexpr StrainRate<NumericType> operator*(const NumericType number) const {
return StrainRate<NumericType>{this->value * number};
}
constexpr Strain<NumericType> operator*(const Time<NumericType>& time) const {
return Strain<NumericType>{*this, time};
}
constexpr StrainRate<NumericType> operator/(const NumericType number) const {
return StrainRate<NumericType>{this->value / number};
}
constexpr Strain<NumericType> operator/(const Frequency<NumericType>& frequency) const {
return Strain<NumericType>{*this, frequency};
}
constexpr void operator+=(const StrainRate<NumericType>& strain_rate) noexcept {
this->value += strain_rate.value;
}
constexpr void operator-=(const StrainRate<NumericType>& strain_rate) noexcept {
this->value -= strain_rate.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 strain rate tensor with a given value expressed in the
/// standard frequency unit.
explicit constexpr StrainRate(const SymmetricDyad<NumericType>& value)
: DimensionalSymmetricDyad<Unit::Frequency, NumericType>(value) {}
};
template <typename NumericType>
inline constexpr bool operator==(
const StrainRate<NumericType>& left, const StrainRate<NumericType>& right) noexcept {
return left.Value() == right.Value();
}
template <typename NumericType>
inline constexpr bool operator!=(
const StrainRate<NumericType>& left, const StrainRate<NumericType>& right) noexcept {
return left.Value() != right.Value();
}
template <typename NumericType>
inline constexpr bool operator<(
const StrainRate<NumericType>& left, const StrainRate<NumericType>& right) noexcept {
return left.Value() < right.Value();
}
template <typename NumericType>
inline constexpr bool operator>(
const StrainRate<NumericType>& left, const StrainRate<NumericType>& right) noexcept {
return left.Value() > right.Value();
}
template <typename NumericType>
inline constexpr bool operator<=(
const StrainRate<NumericType>& left, const StrainRate<NumericType>& right) noexcept {
return left.Value() <= right.Value();
}
template <typename NumericType>
inline constexpr bool operator>=(
const StrainRate<NumericType>& left, const StrainRate<NumericType>& right) noexcept {
return left.Value() >= right.Value();
}
template <typename NumericType>
inline std::ostream& operator<<(std::ostream& stream, const StrainRate<NumericType>& strain_rate) {
stream << strain_rate.Print();
return stream;
}
template <typename NumericType>
inline constexpr StrainRate<NumericType> operator*(
const NumericType number, const StrainRate<NumericType>& strain_rate) {
return strain_rate * number;
}
template <typename NumericType>
inline constexpr Strain<NumericType>::Strain(
const StrainRate<NumericType>& strain_rate, const Time<NumericType>& time)
: Strain<NumericType>(strain_rate.Value() * time.Value()) {}
template <typename NumericType>
inline constexpr Strain<NumericType>::Strain(
const StrainRate<NumericType>& strain_rate, const Frequency<NumericType>& frequency)
: Strain<NumericType>(strain_rate.Value() / frequency.Value()) {}
template <typename NumericType>
inline constexpr StrainRate<NumericType> Strain<NumericType>::operator*(
const Frequency<NumericType>& frequency) const {
return StrainRate<NumericType>{*this, frequency};
}
template <typename NumericType>
inline constexpr StrainRate<NumericType> Strain<NumericType>::operator/(
const Time<NumericType>& time) const {
return StrainRate<NumericType>{*this, time};
}
template <typename NumericType>
inline constexpr Strain<NumericType> Time<NumericType>::operator*(
const StrainRate<NumericType>& strain_rate) const {
return Strain<NumericType>{strain_rate, *this};
}
template <typename NumericType>
inline constexpr StrainRate<NumericType> Frequency<NumericType>::operator*(
const Strain<NumericType>& strain) const {
return StrainRate<NumericType>{strain, *this};
}
} // namespace PhQ
namespace std {
template <typename NumericType>
struct hash<PhQ::StrainRate<NumericType>> {
inline size_t operator()(const PhQ::StrainRate<NumericType>& strain_rate) const {
return hash<PhQ::SymmetricDyad<NumericType>>()(strain_rate.Value());
}
};
} // namespace std
#endif // PHQ_STRAIN_RATE_HPP