-
Notifications
You must be signed in to change notification settings - Fork 1
/
Traction.hpp
317 lines (258 loc) · 12.7 KB
/
Traction.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
// 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_TRACTION_HPP
#define PHQ_TRACTION_HPP
#include <array>
#include <cstddef>
#include <functional>
#include <ostream>
#include "Area.hpp"
#include "DimensionalVector.hpp"
#include "Direction.hpp"
#include "Force.hpp"
#include "PlanarTraction.hpp"
#include "ScalarTraction.hpp"
#include "Unit/Pressure.hpp"
#include "Vector.hpp"
namespace PhQ {
// Forward declaration for class PhQ::Traction.
template <typename NumericType>
class Stress;
/// \brief Three-dimensional Euclidean traction vector. Contains three components in Cartesian
/// coordinates: x, y, and z. Traction is similar to pressure; however, traction can act in any
/// direction, whereas pressure always acts compressively perpendicular to a surface. For a
/// two-dimensional Euclidean traction vector in the XY plane, see PhQ::PlanarTraction. For scalar
/// traction components or for the magnitude of a traction vector, see PhQ::ScalarTraction.
template <typename NumericType = double>
class Traction : public DimensionalVector<Unit::Pressure, NumericType> {
public:
/// \brief Default constructor. Constructs a traction vector with an uninitialized value.
Traction() = default;
/// \brief Constructor. Constructs a traction vector with a given value expressed in a given
/// pressure unit.
Traction(const Vector<NumericType>& value, const Unit::Pressure unit)
: DimensionalVector<Unit::Pressure, NumericType>(value, unit) {}
/// \brief Constructor. Constructs a traction vector from a given set of scalar traction
/// components.
Traction(const ScalarTraction<NumericType>& x, const ScalarTraction<NumericType>& y,
const ScalarTraction<NumericType>& z)
: Traction<NumericType>({x.Value(), y.Value(), z.Value()}) {}
/// \brief Constructor. Constructs a traction vector from a given scalar traction and direction.
constexpr Traction(
const ScalarTraction<NumericType>& scalar_traction, const Direction<NumericType>& direction)
: Traction<NumericType>(scalar_traction.Value() * direction.Value()) {}
/// \brief Constructor. Constructs a traction vector from a given planar traction vector in the XY
/// plane. This traction vector's z-component is initialized to zero.
explicit constexpr Traction(const PlanarTraction<NumericType>& planar_traction)
: Traction<NumericType>(Vector<NumericType>{planar_traction.Value()}) {}
/// \brief Constructor. Constructs a traction vector from a given force and area using the
/// definition of traction.
constexpr Traction(const Force<NumericType>& force, const Area<NumericType>& area)
: Traction<NumericType>(force.Value() / area.Value()) {}
/// \brief Constructor. Constructs a traction vector from a given stress and direction using the
/// definition of traction.
constexpr Traction(const Stress<NumericType>& stress, const Direction<NumericType>& direction);
/// \brief Destructor. Destroys this traction vector.
~Traction() noexcept = default;
/// \brief Copy constructor. Constructs a traction vector by copying another one.
constexpr Traction(const Traction<NumericType>& other) = default;
/// \brief Copy constructor. Constructs a traction vector by copying another one.
template <typename OtherNumericType>
explicit constexpr Traction(const Traction<OtherNumericType>& other)
: Traction(static_cast<Vector<NumericType>>(other.Value())) {}
/// \brief Move constructor. Constructs a traction vector by moving another one.
constexpr Traction(Traction<NumericType>&& other) noexcept = default;
/// \brief Copy assignment operator. Assigns this traction vector by copying another one.
constexpr Traction<NumericType>& operator=(const Traction<NumericType>& other) = default;
/// \brief Copy assignment operator. Assigns this traction vector by copying another one.
template <typename OtherNumericType>
constexpr Traction<NumericType>& operator=(const Traction<OtherNumericType>& other) {
this->value = static_cast<Vector<NumericType>>(other.Value());
return *this;
}
/// \brief Move assignment operator. Assigns this traction vector by moving another one.
constexpr Traction<NumericType>& operator=(Traction<NumericType>&& other) noexcept = default;
/// \brief Statically creates a traction vector of zero.
[[nodiscard]] static constexpr Traction<NumericType> Zero() {
return Traction<NumericType>{Vector<NumericType>::Zero()};
}
/// \brief Statically creates a traction vector from the given x, y, and z Cartesian components
/// expressed in a given pressure unit.
template <Unit::Pressure Unit>
[[nodiscard]] static constexpr Traction<NumericType> Create(
const NumericType x, const NumericType y, const NumericType z) {
return Traction<NumericType>{ConvertStatically<Unit::Pressure, Unit, Standard<Unit::Pressure>>(
Vector<NumericType>{x, y, z})};
}
/// \brief Statically creates a traction vector from the given x, y, and z Cartesian components
/// expressed in a given pressure unit.
template <Unit::Pressure Unit>
[[nodiscard]] static constexpr Traction<NumericType> Create(
const std::array<NumericType, 3>& x_y_z) {
return Traction<NumericType>{ConvertStatically<Unit::Pressure, Unit, Standard<Unit::Pressure>>(
Vector<NumericType>{x_y_z})};
}
/// \brief Statically creates a traction vector with a given value expressed in a given pressure
/// unit.
template <Unit::Pressure Unit>
[[nodiscard]] static constexpr Traction<NumericType> Create(const Vector<NumericType>& value) {
return Traction<NumericType>{
ConvertStatically<Unit::Pressure, Unit, Standard<Unit::Pressure>>(value)};
}
/// \brief Returns the x Cartesian component of this traction vector.
[[nodiscard]] constexpr ScalarTraction<NumericType> x() const noexcept {
return ScalarTraction<NumericType>{this->value.x()};
}
/// \brief Returns the y Cartesian component of this traction vector.
[[nodiscard]] constexpr ScalarTraction<NumericType> y() const noexcept {
return ScalarTraction<NumericType>{this->value.y()};
}
/// \brief Returns the z Cartesian component of this traction vector.
[[nodiscard]] constexpr ScalarTraction<NumericType> z() const noexcept {
return ScalarTraction<NumericType>{this->value.z()};
}
/// \brief Returns the magnitude of this traction vector.
[[nodiscard]] ScalarTraction<NumericType> Magnitude() const {
return ScalarTraction<NumericType>{this->value.Magnitude()};
}
/// \brief Returns the direction of this traction vector.
[[nodiscard]] PhQ::Direction<NumericType> Direction() const {
return this->value.Direction();
}
/// \brief Returns the angle between this traction vector and another one.
[[nodiscard]] PhQ::Angle<NumericType> Angle(const Traction<NumericType>& traction) const {
return PhQ::Angle<NumericType>{*this, traction};
}
constexpr Traction<NumericType> operator+(const Traction<NumericType>& traction) const {
return Traction<NumericType>{this->value + traction.value};
}
constexpr Traction<NumericType> operator-(const Traction<NumericType>& traction) const {
return Traction<NumericType>{this->value - traction.value};
}
constexpr Traction<NumericType> operator*(const NumericType number) const {
return Traction<NumericType>{this->value * number};
}
constexpr Force<NumericType> operator*(const Area<NumericType>& area) const {
return Force<NumericType>{*this, area};
}
constexpr Traction<NumericType> operator/(const NumericType number) const {
return Traction<NumericType>{this->value / number};
}
constexpr void operator+=(const Traction<NumericType>& traction) noexcept {
this->value += traction.value;
}
constexpr void operator-=(const Traction<NumericType>& traction) noexcept {
this->value -= traction.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 traction vector with a given value expressed in the standard
/// pressure unit.
explicit constexpr Traction(const Vector<NumericType>& value)
: DimensionalVector<Unit::Pressure, NumericType>(value) {}
};
template <typename NumericType>
inline constexpr bool operator==(
const Traction<NumericType>& left, const Traction<NumericType>& right) noexcept {
return left.Value() == right.Value();
}
template <typename NumericType>
inline constexpr bool operator!=(
const Traction<NumericType>& left, const Traction<NumericType>& right) noexcept {
return left.Value() != right.Value();
}
template <typename NumericType>
inline constexpr bool operator<(
const Traction<NumericType>& left, const Traction<NumericType>& right) noexcept {
return left.Value() < right.Value();
}
template <typename NumericType>
inline constexpr bool operator>(
const Traction<NumericType>& left, const Traction<NumericType>& right) noexcept {
return left.Value() > right.Value();
}
template <typename NumericType>
inline constexpr bool operator<=(
const Traction<NumericType>& left, const Traction<NumericType>& right) noexcept {
return left.Value() <= right.Value();
}
template <typename NumericType>
inline constexpr bool operator>=(
const Traction<NumericType>& left, const Traction<NumericType>& right) noexcept {
return left.Value() >= right.Value();
}
template <typename NumericType>
inline std::ostream& operator<<(std::ostream& stream, const Traction<NumericType>& traction) {
stream << traction.Print();
return stream;
}
template <typename NumericType>
inline constexpr Traction<NumericType> operator*(
const NumericType number, const Traction<NumericType>& traction) {
return traction * number;
}
template <typename NumericType>
inline Direction<NumericType>::Direction(const Traction<NumericType>& traction)
: Direction<NumericType>(traction.Value()) {}
template <typename NumericType>
inline Angle<NumericType>::Angle(
const Traction<NumericType>& traction1, const Traction<NumericType>& traction2)
: Angle<NumericType>(traction1.Value(), traction2.Value()) {}
template <typename NumericType>
inline constexpr Force<NumericType>::Force(
const Traction<NumericType>& traction, const Area<NumericType>& area)
: Force<NumericType>(traction.Value() * area.Value()) {}
template <typename NumericType>
inline constexpr Traction<NumericType> Direction<NumericType>::operator*(
const ScalarTraction<NumericType>& scalar_traction) const {
return Traction<NumericType>{scalar_traction, *this};
}
template <typename NumericType>
inline constexpr Traction<NumericType> ScalarTraction<NumericType>::operator*(
const Direction<NumericType>& direction) const {
return Traction<NumericType>{*this, direction};
}
template <typename NumericType>
inline constexpr Traction<NumericType> Force<NumericType>::operator/(
const Area<NumericType>& area) const {
return Traction<NumericType>{*this, area};
}
template <typename NumericType>
inline constexpr PlanarTraction<NumericType>::PlanarTraction(const Traction<NumericType>& traction)
: PlanarTraction(PlanarVector<NumericType>{traction.Value()}) {}
} // namespace PhQ
namespace std {
template <typename NumericType>
struct hash<PhQ::Traction<NumericType>> {
inline size_t operator()(const PhQ::Traction<NumericType>& traction) const {
return hash<PhQ::Vector<NumericType>>()(traction.Value());
}
};
} // namespace std
#endif // PHQ_TRACTION_HPP