 |
waLBerla 7.3
|
|
waLBerla 7.3
|
Efficient, generic implementation of a 3-dimensional vector.
The Vector3 class is the representation of a 3D vector with a total of 3 statically allocated elements of arbitrary type. The naming convention of the elements is as follows:
\f[\left(\begin{array}{*{3}{c}}
x & y & z \\
\end{array}\right)\f]
These elements can be accessed directly with the subscript operator. The numbering of the vector elements is
\f[\left(\begin{array}{*{3}{c}}
0 & 1 & 2 \\
\end{array}\right)\f]
#include <Vector3.h>
Public Types | |
| using | Length = typename SqrtTrait<Type>::Type |
| Vector length return type. | |
| using | value_type = Type |
Public Member Functions | |
| WALBERLA_HOST_DEVICE constexpr | Vector3 ()=default |
| WALBERLA_HOST_DEVICE constexpr | Vector3 (Type init) |
| Constructor for a homogenous initialization of all elements. | |
| template<typename Other> | |
| WALBERLA_HOST_DEVICE constexpr | Vector3 (Other init) |
| WALBERLA_HOST_DEVICE constexpr | Vector3 (Type x, Type y, Type z) |
| Constructor for a direct initialization of all vector elements. | |
| WALBERLA_HOST_DEVICE constexpr | Vector3 (const Type *init) |
| Constructor for an array initializer. | |
| WALBERLA_HOST_DEVICE constexpr | Vector3 (const Vector3 &v)=default |
| template<typename Other> | |
| WALBERLA_HOST_DEVICE constexpr | Vector3 (const Vector3< Other > &v) |
| Conversion constructor from different Vector3 instances. | |
| template<typename Other> | |
| WALBERLA_HOST_DEVICE Vector3< Type > & | operator= (const Vector3< Other > &v) |
| template<typename Other> | |
| WALBERLA_HOST_DEVICE Vector3< Type > & | operator%= (const Vector3< Other > &rhs) |
| template<typename Other> | |
| WALBERLA_HOST_DEVICE Vector3< Type > & | operator+= (const Vector3< Other > &rhs) |
| template<typename Other> | |
| WALBERLA_HOST_DEVICE Vector3< Type > & | operator-= (const Vector3< Other > &rhs) |
| template<typename Other> | |
| WALBERLA_HOST_DEVICE Vector3< Type > & | operator*= (Other rhs) |
| template<typename Other> | |
| WALBERLA_HOST_DEVICE Vector3< Type > & | operator/= (Other rhs) |
Operators | |
| WALBERLA_HOST_DEVICE Vector3 & | operator= (const Vector3 &v)=default |
| template<typename Other> | |
| WALBERLA_HOST_DEVICE Vector3 & | operator= (const Vector3< Other > &v) |
| Assignment operator for different Vector3 instances. | |
| template<typename Other> | |
| WALBERLA_HOST_DEVICE bool | operator== (Other rhs) const |
| Equality operator for the comparison of a vector and a scalar value. | |
| template<typename Other> | |
| WALBERLA_HOST_DEVICE bool | operator== (const Vector3< Other > &rhs) const |
| Equality operator for the comparison of two vectors. | |
| template<typename Other> | |
| WALBERLA_HOST_DEVICE bool | operator!= (Other rhs) const |
| Inequality operator for the comparison of a vector and a scalar value. | |
| template<typename Other> | |
| WALBERLA_HOST_DEVICE bool | operator!= (const Vector3< Other > &rhs) const |
| Inequality operator for the comparison of two vectors. | |
| WALBERLA_HOST_DEVICE Type & | operator[] (uint_t index) |
| Subscript operator for the direct access to the vector elements. | |
| WALBERLA_HOST_DEVICE const Type & | operator[] (uint_t index) const |
| Subscript operator for the direct access to the vector elements. | |
Arithmetic operators | |
The return type of the arithmetic operators depends on the involved data types of the vectors. HIGH denotes the more significant data type of the arithmetic operation (for further detail see the MathTrait class description). | |
| WALBERLA_HOST_DEVICE Vector3 | operator- () const |
| Unary minus operator for the inversion of a vector ( \( \vec{a} = -\vec{b} \)). | |
| template<typename Other> | |
| WALBERLA_HOST_DEVICE Vector3 & | operator%= (const Vector3< Other > &rhs) |
| Cross product (outer product) of two vectors ( \( \vec{a}=\vec{b}\times\vec{c} \)). | |
| template<typename Other> | |
| WALBERLA_HOST_DEVICE Vector3 & | operator+= (const Vector3< Other > &rhs) |
| Addition assignment operator for the addition of two vectors ( \( \vec{a}+=\vec{b} \)). | |
| template<typename Other> | |
| WALBERLA_HOST_DEVICE Vector3 & | operator-= (const Vector3< Other > &rhs) |
| Subtraction assignment operator for the subtraction of two vectors. | |
| template<typename Other> | |
| WALBERLA_HOST_DEVICE Vector3 & | operator*= (Other rhs) |
| Multiplication assignment operator for the multiplication between a vector and. | |
| template<typename Other> | |
| WALBERLA_HOST_DEVICE Vector3 & | operator/= (Other rhs) |
| Division assignment operator for the division of a vector by a scalar value. | |
| template<typename Other> | |
| WALBERLA_HOST_DEVICE Vector3< typename MathTrait< Type, Other >::High > | operator% (const Vector3< Other > &rhs) const |
| Cross product (outer product) of two vectors ( \( \vec{a}=\vec{b}\times\vec{c} \)). | |
| template<typename Other> | |
| WALBERLA_HOST_DEVICE Vector3< typename MathTrait< Type, Other >::High > | operator+ (const Vector3< Other > &rhs) const |
| Addition operator for the addition of two vectors ( \( \vec{a}=\vec{b}+\vec{c} \)). | |
| template<typename Other> | |
| WALBERLA_HOST_DEVICE Vector3< typename MathTrait< Type, Other >::High > | operator- (const Vector3< Other > &rhs) const |
| Subtraction operator for the subtraction of two vectors ( \( \vec{a}=\vec{b}-\vec{c} \)). | |
| template<typename Other> | |
| WALBERLA_HOST_DEVICE Vector3< typename MathTrait< Type, Other >::High > | operator* (Other rhs) const |
| Multiplication operator for the multiplication of a vector and a scalar value. | |
| template<typename Other> | |
| WALBERLA_HOST_DEVICE MathTrait< Type, Other >::High | operator* (const Vector3< Other > &rhs) const |
| Multiplication operator for the scalar product (inner product) of two vectors. | |
| template<typename Other> | |
| WALBERLA_HOST_DEVICE Vector3< typename MathTrait< Type, Other >::High > | operator/ (Other rhs) const |
| Division operator for the division of a vector by a scalar value. | |
Utility functions | |
| WALBERLA_HOST_DEVICE uint_t | indexOfMax () const |
| Returns index of absolute maximum value. | |
| WALBERLA_HOST_DEVICE uint_t | indexOfMin () const |
| Returns index of absolute minimum value. | |
| WALBERLA_HOST_DEVICE Type | max () const |
| Returns maximum value. | |
| WALBERLA_HOST_DEVICE Type | min () const |
| Returns minimum value. | |
| WALBERLA_HOST_DEVICE void | set (Type x, Type y, Type z) |
| Set function for a direct assignment of all vector elements. | |
| WALBERLA_HOST_DEVICE Length | length () const |
| Calculation of the vector length \(|\vec{a}|\). | |
| WALBERLA_HOST_DEVICE Type | sqrLength () const |
| Calculation of the vector square length \(|\vec{a}|^2\). | |
| WALBERLA_HOST_DEVICE Vector3< Length > | getNormalized () const |
| Calculation of the normalized vector ( \(|\vec{a}|=1\)). | |
| WALBERLA_HOST_DEVICE Vector3< Length > | getNormalizedOrZero () const |
| Calculation of the normalized vector ( \(|\vec{a}|=1\)) without precondition. | |
| WALBERLA_HOST_DEVICE Vector3< Length > | getNormalizedIfNotZero () const |
| Calculation of the normalized vector ( \(|\vec{a}|=1\)) without precondition. | |
| WALBERLA_HOST_DEVICE void | reset () |
| Sets all components of the vector to 0. | |
| WALBERLA_HOST_DEVICE Type * | data () |
| WALBERLA_HOST_DEVICE Type const * | data () const |
Private Attributes | |
Member variables | |
| stdlib::array< Type, 3 > | v_ = { Type(), Type(), Type() } |
| The three statically allocated vector elements. | |
| using walberla::math::Vector3< Type >::Length = typename SqrtTrait<Type>::Type |
Vector length return type.
Return type of the Vector3<Type>::length function.
| using walberla::math::Vector3< Type >::value_type = Type |
|
explicitconstexprdefault |
|
inlineexplicitconstexpr |
Constructor for a homogenous initialization of all elements.
| init | Initial value for all vector elements. |
|
inlineexplicitconstexpr |
|
inlineexplicitconstexpr |
Constructor for a direct initialization of all vector elements.
| x | The initial value for the x-component. |
| y | The initial value for the y-component. |
| z | The initial value for the z-component. |
|
inlineexplicitconstexpr |
Constructor for an array initializer.
| init | Pointer to the initialization array. |
The array is assumed to have at least three valid elements.
|
constexprdefault |
|
inlineconstexpr |
Conversion constructor from different Vector3 instances.
| v | Vector to be copied. |
|
inline |
|
inline |
| WALBERLA_HOST_DEVICE Vector3< typename Vector3< Type >::Length > walberla::math::Vector3< Type >::getNormalized | ( | ) | const |
Calculation of the normalized vector ( \(|\vec{a}|=1\)).
The function returns the normalized vector.
| WALBERLA_HOST_DEVICE Vector3< typename Vector3< Type >::Length > walberla::math::Vector3< Type >::getNormalizedIfNotZero | ( | ) | const |
Calculation of the normalized vector ( \(|\vec{a}|=1\)) without precondition.
| WALBERLA_HOST_DEVICE Vector3< typename Vector3< Type >::Length > walberla::math::Vector3< Type >::getNormalizedOrZero | ( | ) | const |
Calculation of the normalized vector ( \(|\vec{a}|=1\)) without precondition.
|
inline |
Returns index of absolute maximum value.
|
inline |
Returns index of absolute minimum value.
|
inline |
Calculation of the vector length \(|\vec{a}|\).
The return type of the length function depends on the actual type of the vector instance:
| Type | Length |
| float | float |
| integral data types and double | double |
| long double | long double |
|
inline |
Returns maximum value.
|
inline |
Returns minimum value.
|
inline |
Inequality operator for the comparison of two vectors.
| rhs | The right-hand-side vector for the comparison. |
|
inline |
Inequality operator for the comparison of a vector and a scalar value.
| rhs | The right-hand-side scalar value for the comparison. |
If one value of the vector is inequal to the scalar value, the inequality test returns true, otherwise false.
|
inline |
Cross product (outer product) of two vectors ( \( \vec{a}=\vec{b}\times\vec{c} \)).
| rhs | The right-hand-side vector for the cross product. |
|
inline |
| WALBERLA_HOST_DEVICE Vector3 & walberla::math::Vector3< Type >::operator%= | ( | const Vector3< Other > & | rhs | ) |
Cross product (outer product) of two vectors ( \( \vec{a}=\vec{b}\times\vec{c} \)).
| rhs | The right-hand-side vector for the cross product. |
|
inline |
Multiplication operator for the scalar product (inner product) of two vectors.
( \( s=\vec{a}*\vec{b} \)).
| rhs | The right-hand-side vector for the inner product. |
The operator returns a scalar value of the higher-order data type of the two involved data types (in fact the two template arguments Type and Other ).
|
inline |
Multiplication operator for the multiplication of a vector and a scalar value.
( \( \vec{a}=\vec{b}*s \)).
| rhs | The right-hand-side scalar value for the multiplication. |
The operator returns a vector of the higher-order data type of the two involved data types (in fact the two template arguments Type and Other ).
|
inline |
| WALBERLA_HOST_DEVICE Vector3 & walberla::math::Vector3< Type >::operator*= | ( | Other | rhs | ) |
Multiplication assignment operator for the multiplication between a vector and.
a scalar value ( \( \vec{a}*=s \)).
| rhs | The right-hand-side scalar value for the multiplication. |
|
inline |
Addition operator for the addition of two vectors ( \( \vec{a}=\vec{b}+\vec{c} \)).
| rhs | The right-hand-side vector to be added to the vector. |
The operator returns a vector of the higher-order data type of the two involved vector data types (in fact the two template arguments Type and Other ).
|
inline |
| WALBERLA_HOST_DEVICE Vector3 & walberla::math::Vector3< Type >::operator+= | ( | const Vector3< Other > & | rhs | ) |
Addition assignment operator for the addition of two vectors ( \( \vec{a}+=\vec{b} \)).
| rhs | The right-hand-side vector to be added to the vector. |
|
inline |
Unary minus operator for the inversion of a vector ( \( \vec{a} = -\vec{b} \)).
|
inline |
Subtraction operator for the subtraction of two vectors ( \( \vec{a}=\vec{b}-\vec{c} \)).
| rhs | The right-hand-side vector to be subtracted from the vector. |
The operator returns a vector of the higher-order data type of the two involved vector data types (in fact the two template arguments Type and Other ).
|
inline |
| WALBERLA_HOST_DEVICE Vector3 & walberla::math::Vector3< Type >::operator-= | ( | const Vector3< Other > & | rhs | ) |
Subtraction assignment operator for the subtraction of two vectors.
( \( \vec{a}-=\vec{b} \)).
| rhs | The right-hand-side vector to be subtracted from the vector. |
|
inline |
Division operator for the division of a vector by a scalar value.
( \( \vec{a}=\vec{b}/s \)).
| rhs | The right-hand-side scalar value for the division. |
The operator returns a vector of the higher-order data type of the two involved data types (in fact the two template arguments Type and Other ).
Note: No check for 0 is applied.
|
inline |
| WALBERLA_HOST_DEVICE Vector3 & walberla::math::Vector3< Type >::operator/= | ( | Other | rhs | ) |
Division assignment operator for the division of a vector by a scalar value.
( \( \vec{a}/=s \)).
| rhs | The right-hand-side scalar value for the division. |
Note: No check for 0 is applied.
|
default |
|
inline |
| WALBERLA_HOST_DEVICE Vector3 & walberla::math::Vector3< Type >::operator= | ( | const Vector3< Other > & | v | ) |
Assignment operator for different Vector3 instances.
| v | Vector to be copied. |
|
inline |
Equality operator for the comparison of two vectors.
| rhs | The right-hand-side vector for the comparison. |
|
inline |
Equality operator for the comparison of a vector and a scalar value.
| rhs | The right-hand-side scalar value for the comparison. |
If all values of the vector are equal to the scalar value, the equality test returns true, otherwise false.
|
inline |
Subscript operator for the direct access to the vector elements.
| index | Access index. The index has to be in the range \([0..2]\). |
|
inline |
Subscript operator for the direct access to the vector elements.
| index | Access index. The index has to be in the range \([0..2]\). |
| WALBERLA_HOST_DEVICE void walberla::math::Vector3< Type >::reset | ( | ) |
Sets all components of the vector to 0.
|
inline |
Set function for a direct assignment of all vector elements.
| x | The initial value for the x-component. |
| y | The initial value for the y-component. |
| z | The initial value for the z-component. |
|
inline |
Calculation of the vector square length \(|\vec{a}|^2\).
|
private |
The three statically allocated vector elements.
Access to the vector values is gained via the subscript operator. The order of the elements is
\[\left(\begin{array}{*{3}{c}} 0 & 1 & 2 \\ \end{array}\right)\]