TensorT< T > Struct Template Reference

AMR-Wind API: amr_wind::vs::TensorT< T > Struct Template Reference
AMR-Wind API v0.1.0
CFD solver for wind plant simulations
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
amr_wind::vs::TensorT< T > Struct Template Reference

#include <tensor.H>

Inheritance diagram for amr_wind::vs::TensorT< T >:
[legend]

Public Types

using size_type = int
using value_type = T
using reference = T&
using iterator = T*
using const_iterator = const T*
using Traits = DTraits<T>

Public Member Functions

AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE constexpr TensorT ()=default
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE constexpr TensorT (const T &xx, const T &xy, const T &xz, const T &yx, const T &yy, const T &yz, const T &zx, const T &zy, const T &zz)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE TensorT (const VectorT< T > &x, const VectorT< T > &y, const VectorT< T > &z, bool transpose=false)
 ~TensorT ()=default
 TensorT (const TensorT &)=default
 TensorT (TensorT &&)=default
TensorT & operator= (const TensorT &) &=default
TensorT & operator= (const TensorT &) &&=delete
TensorT & operator= (TensorT &&) &=default
TensorT & operator= (TensorT &&) &&=delete
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void rows (const VectorT< T > &x, const VectorT< T > &y, const VectorT< T > &z)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void cols (const VectorT< T > &x, const VectorT< T > &y, const VectorT< T > &z)
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE VectorT< T > x () const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE VectorT< T > y () const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE VectorT< T > z () const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE VectorT< T > cx () const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE VectorT< T > cy () const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE VectorT< T > cz () const
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE T & xx () &
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE T & xy () &
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE T & xz () &
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE T & yx () &
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE T & yy () &
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE T & yz () &
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE T & zx () &
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE T & zy () &
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE T & zz () &
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const T & xx () const &
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const T & xy () const &
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const T & xz () const &
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const T & yx () const &
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const T & yy () const &
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const T & yz () const &
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const T & zx () const &
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const T & zy () const &
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const T & zz () const &
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE T & operator[] (size_type pos) &
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const T & operator[] (size_type pos) const &
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE T * data ()
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const T * data () const
iterator begin ()
iterator end ()
const_iterator cbegin () const
const_iterator cend () const
size_type size () const

Static Public Member Functions

AMREX_GPU_HOST_DEVICE static AMREX_FORCE_INLINE constexpr TensorT< T > zero ()
AMREX_GPU_HOST_DEVICE static AMREX_FORCE_INLINE constexpr TensorT< T > identity ()

Public Attributes

amrex::GpuArray< T, 9 > vv

Static Public Attributes

static constexpr int ncomp = 9

Detailed Description

template<typename T>
struct amr_wind::vs::TensorT< T >

Tensor in 3D vector space

Member Typedef Documentation

◆ const_iterator

template<typename T>
using amr_wind::vs::TensorT< T >::const_iterator = const T*

◆ iterator

template<typename T>
using amr_wind::vs::TensorT< T >::iterator = T*

◆ reference

template<typename T>
using amr_wind::vs::TensorT< T >::reference = T&

◆ size_type

template<typename T>
using amr_wind::vs::TensorT< T >::size_type = int

◆ Traits

template<typename T>
using amr_wind::vs::TensorT< T >::Traits = DTraits<T>

◆ value_type

template<typename T>
using amr_wind::vs::TensorT< T >::value_type = T

Constructor & Destructor Documentation

◆ TensorT() [1/5]

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE constexpr amr_wind::vs::TensorT< T >::TensorT ( )
constexprdefault

◆ TensorT() [2/5]

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE constexpr amr_wind::vs::TensorT< T >::TensorT ( const T & xx,
const T & xy,
const T & xz,
const T & yx,
const T & yy,
const T & yz,
const T & zx,
const T & zy,
const T & zz )
inlineconstexpr

◆ TensorT() [3/5]

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE amr_wind::vs::TensorT< T >::TensorT ( const VectorT< T > & x,
const VectorT< T > & y,
const VectorT< T > & z,
bool transpose = false )

◆ ~TensorT()

template<typename T>
amr_wind::vs::TensorT< T >::~TensorT ( )
default

◆ TensorT() [4/5]

template<typename T>
amr_wind::vs::TensorT< T >::TensorT ( const TensorT< T > & )
default

◆ TensorT() [5/5]

template<typename T>
amr_wind::vs::TensorT< T >::TensorT ( TensorT< T > && )
default

Member Function Documentation

◆ begin()

template<typename T>
iterator amr_wind::vs::TensorT< T >::begin ( )
inline

◆ cbegin()

template<typename T>
const_iterator amr_wind::vs::TensorT< T >::cbegin ( ) const
inlinenodiscard

◆ cend()

template<typename T>
const_iterator amr_wind::vs::TensorT< T >::cend ( ) const
inlinenodiscard

◆ cols()

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void amr_wind::vs::TensorT< T >::cols ( const VectorT< T > & x,
const VectorT< T > & y,
const VectorT< T > & z )

◆ cx()

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE VectorT< T > amr_wind::vs::TensorT< T >::cx ( ) const

◆ cy()

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE VectorT< T > amr_wind::vs::TensorT< T >::cy ( ) const

◆ cz()

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE VectorT< T > amr_wind::vs::TensorT< T >::cz ( ) const

◆ data() [1/2]

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE T * amr_wind::vs::TensorT< T >::data ( )
inline

◆ data() [2/2]

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const T * amr_wind::vs::TensorT< T >::data ( ) const
inline

◆ end()

template<typename T>
iterator amr_wind::vs::TensorT< T >::end ( )
inline

◆ identity()

template<typename T>
AMREX_GPU_HOST_DEVICE static AMREX_FORCE_INLINE constexpr TensorT< T > amr_wind::vs::TensorT< T >::identity ( )
inlinestaticconstexpr

◆ operator=() [1/4]

template<typename T>
TensorT & amr_wind::vs::TensorT< T >::operator= ( const TensorT< T > & ) &&
delete

◆ operator=() [2/4]

template<typename T>
TensorT & amr_wind::vs::TensorT< T >::operator= ( const TensorT< T > & ) &
default

◆ operator=() [3/4]

template<typename T>
TensorT & amr_wind::vs::TensorT< T >::operator= ( TensorT< T > && ) &&
delete

◆ operator=() [4/4]

template<typename T>
TensorT & amr_wind::vs::TensorT< T >::operator= ( TensorT< T > && ) &
default

◆ operator[]() [1/2]

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE T & amr_wind::vs::TensorT< T >::operator[] ( size_type pos) &
inline

◆ operator[]() [2/2]

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const T & amr_wind::vs::TensorT< T >::operator[] ( size_type pos) const &
inline

◆ rows()

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void amr_wind::vs::TensorT< T >::rows ( const VectorT< T > & x,
const VectorT< T > & y,
const VectorT< T > & z )

◆ size()

template<typename T>
size_type amr_wind::vs::TensorT< T >::size ( ) const
inlinenodiscard

◆ x()

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE VectorT< T > amr_wind::vs::TensorT< T >::x ( ) const

◆ xx() [1/2]

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE T & amr_wind::vs::TensorT< T >::xx ( ) &
inline

◆ xx() [2/2]

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const T & amr_wind::vs::TensorT< T >::xx ( ) const &
inline

◆ xy() [1/2]

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE T & amr_wind::vs::TensorT< T >::xy ( ) &
inline

◆ xy() [2/2]

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const T & amr_wind::vs::TensorT< T >::xy ( ) const &
inline

◆ xz() [1/2]

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE T & amr_wind::vs::TensorT< T >::xz ( ) &
inline

◆ xz() [2/2]

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const T & amr_wind::vs::TensorT< T >::xz ( ) const &
inline

◆ y()

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE VectorT< T > amr_wind::vs::TensorT< T >::y ( ) const

◆ yx() [1/2]

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE T & amr_wind::vs::TensorT< T >::yx ( ) &
inline

◆ yx() [2/2]

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const T & amr_wind::vs::TensorT< T >::yx ( ) const &
inline

◆ yy() [1/2]

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE T & amr_wind::vs::TensorT< T >::yy ( ) &
inline

◆ yy() [2/2]

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const T & amr_wind::vs::TensorT< T >::yy ( ) const &
inline

◆ yz() [1/2]

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE T & amr_wind::vs::TensorT< T >::yz ( ) &
inline

◆ yz() [2/2]

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const T & amr_wind::vs::TensorT< T >::yz ( ) const &
inline

◆ z()

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE VectorT< T > amr_wind::vs::TensorT< T >::z ( ) const

◆ zero()

template<typename T>
AMREX_GPU_HOST_DEVICE static AMREX_FORCE_INLINE constexpr TensorT< T > amr_wind::vs::TensorT< T >::zero ( )
inlinestaticconstexpr

◆ zx() [1/2]

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE T & amr_wind::vs::TensorT< T >::zx ( ) &
inline

◆ zx() [2/2]

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const T & amr_wind::vs::TensorT< T >::zx ( ) const &
inline

◆ zy() [1/2]

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE T & amr_wind::vs::TensorT< T >::zy ( ) &
inline

◆ zy() [2/2]

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const T & amr_wind::vs::TensorT< T >::zy ( ) const &
inline

◆ zz() [1/2]

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE T & amr_wind::vs::TensorT< T >::zz ( ) &
inline

◆ zz() [2/2]

template<typename T>
AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE const T & amr_wind::vs::TensorT< T >::zz ( ) const &
inline

Member Data Documentation

◆ ncomp

template<typename T>
int amr_wind::vs::TensorT< T >::ncomp = 9
staticconstexpr

◆ vv

template<typename T>
amrex::GpuArray<T, 9> amr_wind::vs::TensorT< T >::vv
Initial value:
= {Traits::zero(), Traits::zero(), Traits::zero(),
Traits::zero(), Traits::zero(), Traits::zero(),
Traits::zero(), Traits::zero(), Traits::zero()}
The documentation for this struct was generated from the following files:
  • /home/runner/work/amr-wind/amr-wind/amr-wind/core/vs/tensor.H
  • /home/runner/work/amr-wind/amr-wind/amr-wind/core/vs/tensorI.H
Generated by doxygen 1.14.0