NeoN
A framework for CFD software
Loading...
Searching...
No Matches
NeoN::Vec3 Class Reference

A class for the representation of a 3D Vec3. More...

#include <vec3.hpp>

Public Member Functions

KOKKOS_INLINE_FUNCTION Vec3 ()
KOKKOS_INLINE_FUNCTION Vec3 (scalar x, scalar y, scalar z)
KOKKOS_INLINE_FUNCTION Vec3 (const scalar constValue)
scalar * data ()
 Returns pointer to the data of the vector.
const scalar * data () const
 Returns pointer to the data of the vector.
constexpr sizeType size () const
 Returns the size of the vector.
KOKKOS_INLINE_FUNCTION scalar & operator[] (const sizeType i)
KOKKOS_INLINE_FUNCTION scalar operator[] (const sizeType i) const
KOKKOS_INLINE_FUNCTION scalar & operator() (const sizeType i)
KOKKOS_INLINE_FUNCTION scalar operator() (const sizeType i) const
KOKKOS_INLINE_FUNCTION bool operator== (const Vec3 &rhs) const
KOKKOS_INLINE_FUNCTION Vec3 operator+ (const Vec3 &rhs) const
KOKKOS_INLINE_FUNCTION Vec3 & operator+= (const Vec3 &rhs)
KOKKOS_INLINE_FUNCTION Vec3 operator- (const Vec3 &rhs) const
KOKKOS_INLINE_FUNCTION Vec3 & operator-= (const Vec3 &rhs)
KOKKOS_INLINE_FUNCTION Vec3 operator* (const scalar &rhs) const
KOKKOS_INLINE_FUNCTION Vec3 operator* (const label &rhs) const
KOKKOS_INLINE_FUNCTION Vec3 & operator*= (const scalar &rhs)

Detailed Description

A class for the representation of a 3D Vec3.

Definition at line 23 of file vec3.hpp.

Constructor & Destructor Documentation

◆ Vec3() [1/3]

KOKKOS_INLINE_FUNCTION NeoN::Vec3::Vec3 ( )
inline

Definition at line 28 of file vec3.hpp.

◆ Vec3() [2/3]

KOKKOS_INLINE_FUNCTION NeoN::Vec3::Vec3 ( scalar x,
scalar y,
scalar z )
inline

Definition at line 36 of file vec3.hpp.

◆ Vec3() [3/3]

KOKKOS_INLINE_FUNCTION NeoN::Vec3::Vec3 ( const scalar constValue)
inlineexplicit

Definition at line 44 of file vec3.hpp.

Member Function Documentation

◆ data() [1/2]

scalar * NeoN::Vec3::data ( )
inline

Returns pointer to the data of the vector.

Returns
point to the first scalar

Definition at line 56 of file vec3.hpp.

◆ data() [2/2]

const scalar * NeoN::Vec3::data ( ) const
inline

Returns pointer to the data of the vector.

Returns
point to the first scalar

Definition at line 63 of file vec3.hpp.

◆ operator()() [1/2]

KOKKOS_INLINE_FUNCTION scalar & NeoN::Vec3::operator() ( const sizeType i)
inline

Definition at line 79 of file vec3.hpp.

◆ operator()() [2/2]

KOKKOS_INLINE_FUNCTION scalar NeoN::Vec3::operator() ( const sizeType i) const
inline

Definition at line 82 of file vec3.hpp.

◆ operator*() [1/2]

KOKKOS_INLINE_FUNCTION Vec3 NeoN::Vec3::operator* ( const label & rhs) const
inline

Definition at line 128 of file vec3.hpp.

◆ operator*() [2/2]

KOKKOS_INLINE_FUNCTION Vec3 NeoN::Vec3::operator* ( const scalar & rhs) const
inline

Definition at line 121 of file vec3.hpp.

◆ operator*=()

KOKKOS_INLINE_FUNCTION Vec3 & NeoN::Vec3::operator*= ( const scalar & rhs)
inline

Definition at line 135 of file vec3.hpp.

◆ operator+()

KOKKOS_INLINE_FUNCTION Vec3 NeoN::Vec3::operator+ ( const Vec3 & rhs) const
inline

Definition at line 91 of file vec3.hpp.

◆ operator+=()

KOKKOS_INLINE_FUNCTION Vec3 & NeoN::Vec3::operator+= ( const Vec3 & rhs)
inline

Definition at line 97 of file vec3.hpp.

◆ operator-()

KOKKOS_INLINE_FUNCTION Vec3 NeoN::Vec3::operator- ( const Vec3 & rhs) const
inline

Definition at line 106 of file vec3.hpp.

◆ operator-=()

KOKKOS_INLINE_FUNCTION Vec3 & NeoN::Vec3::operator-= ( const Vec3 & rhs)
inline

Definition at line 112 of file vec3.hpp.

◆ operator==()

KOKKOS_INLINE_FUNCTION bool NeoN::Vec3::operator== ( const Vec3 & rhs) const
inline

Definition at line 85 of file vec3.hpp.

◆ operator[]() [1/2]

KOKKOS_INLINE_FUNCTION scalar & NeoN::Vec3::operator[] ( const sizeType i)
inline

Definition at line 73 of file vec3.hpp.

◆ operator[]() [2/2]

KOKKOS_INLINE_FUNCTION scalar NeoN::Vec3::operator[] ( const sizeType i) const
inline

Definition at line 76 of file vec3.hpp.

◆ size()

sizeType NeoN::Vec3::size ( ) const
inlineconstexpr

Returns the size of the vector.

Returns
The size of the vector

Definition at line 70 of file vec3.hpp.


The documentation for this class was generated from the following file: