UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
Chaos::TUniformGrid< T, 3 > Class Template Reference

#include <UniformGrid.h>

+ Inheritance diagram for Chaos::TUniformGrid< T, 3 >:

Public Member Functions

 TUniformGrid ()
 
 TUniformGrid (const TVector< T, 3 > &MinCorner, const TVector< T, 3 > &MaxCorner, const TVector< int32, 3 > &Cells, const uint32 GhostCells=0)
 
 ~TUniformGrid ()
 
CHAOS_API TVector< int32, 3 > GetIndex (const int32 Index) const
 
CHAOS_API Pair< int32, TVector< int32, 3 > > GetFaceIndex (int32 Index) const
 
int32 GetNumFaces () const
 
TVector< T, 3 > Center (const int32 Index) const
 
CHAOS_API TVector< int32, 3 > ClampIndex (const TVector< int32, 3 > &Index) const
 
CHAOS_API TVector< T, 3 > Clamp (const TVector< T, 3 > &X) const
 
CHAOS_API TVector< T, 3 > ClampMinusHalf (const TVector< T, 3 > &X) const
 
CHAOS_API bool IsValid (const TVector< int32, 3 > &X) const
 
CHAOS_API TUniformGrid< T, 3 > SubGrid (const TVector< int32, 3 > &MinCell, const TVector< int32, 3 > &MaxCell) const
 
- Public Member Functions inherited from Chaos::TUniformGridBase< T, 3 >
void Serialize (FArchive &Ar)
 
TVector< T, d > Location (const TVector< int32, d > &Cell) const
 
TVector< T, d > Location (const Pair< int32, TVector< int32, 3 > > &Face) const
 
void Reset ()
 
TVector< int32, d > CellUnsafe (const TVector< T, d > &X) const
 
TVector< int32, d > Cell (const TVector< T, d > &X) const
 
TVector< int32, d > Face (const TVector< T, d > &X, const int32 Component) const
 
TVector< T, d > DomainSize () const
 
int32 GetNumCells () const
 
int32 GetNumNodes () const
 
TVector< T, d > Node (const TVector< int32, d > &Index) const
 
TVector< T, d > Node (const int32 FlatIndex) const
 
bool InteriorNode (const TVector< int32, d > &Index) const
 
int32 FlatIndex (const TVector< int32, 2 > &MIndex, const bool NodeIndex=false) const
 
int32 FlatIndex (const TVector< int32, 3 > &MIndex, const bool NodeIndex=false) const
 
void FlatToMultiIndex (const int32 FlatIndex, TVector< int32, 2 > &MIndex, const bool NodeIndex=false) const
 
void FlatToMultiIndex (const int32 FlatIndex, TVector< int32, 3 > &MIndex, const bool NodeIndex=false) const
 
T_SCALAR LinearlyInterpolate (const TArrayND< T_SCALAR, d > &ScalarN, const TVector< T, d > &X) const
 
TVector< T, d > LinearlyInterpolate (const TArrayFaceND< T, d > &ScalarN, const TVector< T, d > &X) const
 
TVector< T, d > LinearlyInterpolate (const TArrayFaceND< T, d > &ScalarN, const TVector< T, d > &X, const Pair< int32, TVector< int32, d > > Index) const
 
T LinearlyInterpolateComponent (const TArrayND< T, d > &ScalarNComponent, const TVector< T, d > &X, const int32 Axis) const
 
const TVector< int32, d > & Counts () const
 
const TVector< int32, d > NodeCounts () const
 
const TVector< T, d > & Dx () const
 
const TVector< T, d > & MinCorner () const
 
const TVector< T, d > & MaxCorner () const
 

Additional Inherited Members

- Protected Member Functions inherited from Chaos::TUniformGridBase< T, 3 >
 TUniformGridBase ()
 
 TUniformGridBase (const TVector< T, d > &MinCorner, const TVector< T, d > &MaxCorner, const TVector< int32, d > &Cells, const uint32 GhostCells)
 
 ~TUniformGridBase ()
 
- Protected Attributes inherited from Chaos::TUniformGridBase< T, 3 >
TVector< T, d > MMinCorner
 
TVector< T, d > MMaxCorner
 
TVector< int32, d > MCells
 
TVector< T, d > MDx
 

Constructor & Destructor Documentation

◆ TUniformGrid() [1/2]

template<class T >
Chaos::TUniformGrid< T, 3 >::TUniformGrid ( )
inline

◆ TUniformGrid() [2/2]

template<class T >
Chaos::TUniformGrid< T, 3 >::TUniformGrid ( const TVector< T, 3 > &  MinCorner,
const TVector< T, 3 > &  MaxCorner,
const TVector< int32, 3 > &  Cells,
const uint32  GhostCells = 0 
)
inline

◆ ~TUniformGrid()

template<class T >
Chaos::TUniformGrid< T, 3 >::~TUniformGrid ( )
inline

Member Function Documentation

◆ Center()

template<class T >
TVector< T, 3 > Chaos::TUniformGrid< T, 3 >::Center ( const int32  Index) const
inline

◆ Clamp()

template<class T >
TVector< T, 3 > Chaos::TUniformGrid< T, 3 >::Clamp ( const TVector< T, 3 > &  X) const

◆ ClampIndex()

template<class T >
TVector< int32, 3 > Chaos::TUniformGrid< T, 3 >::ClampIndex ( const TVector< int32, 3 > &  Index) const

◆ ClampMinusHalf()

template<class T >
TVector< T, 3 > Chaos::TUniformGrid< T, 3 >::ClampMinusHalf ( const TVector< T, 3 > &  X) const

◆ GetFaceIndex()

template<class T >
Pair< int32, TVector< int32, 3 > > Chaos::TUniformGrid< T, 3 >::GetFaceIndex ( int32  Index) const

◆ GetIndex()

template<class T >
TVector< int32, 3 > Chaos::TUniformGrid< T, 3 >::GetIndex ( const int32  Index) const

◆ GetNumFaces()

template<class T >
int32 Chaos::TUniformGrid< T, 3 >::GetNumFaces ( ) const
inline

◆ IsValid()

template<class T >
bool Chaos::TUniformGrid< T, 3 >::IsValid ( const TVector< int32, 3 > &  X) const

◆ SubGrid()

template<class T >
TUniformGrid< T, 3 > Chaos::TUniformGrid< T, 3 >::SubGrid ( const TVector< int32, 3 > &  MinCell,
const TVector< int32, 3 > &  MaxCell 
) const
The documentation for this class was generated from the following files: