Public Member Functions | List of all members
lumpedPointInterpolator Class Reference

A simple linear interpolator between two locations, which are referenced by index. More...

Public Member Functions

 lumpedPointInterpolator ()
 
 lumpedPointInterpolator (const label id)
 
 ~lumpedPointInterpolator ()=default
 
bool valid () const
 
label nearest () const
 
label next () const
 
label next1 () const
 
label next2 () const
 
scalar weight0 () const
 
scalar weight1 () const
 
scalar weight2 () const
 
void nearest (const label id)
 
void next (const label id, const scalar weight)
 
void next (const label id, const scalar weight, const label position)
 
void set (const triFace &ids, const barycentric2D &weights)
 
template<class T >
T interpolate (const UList< T > &input) const
 

Detailed Description

A simple linear interpolator between two locations, which are referenced by index.

When the interpolator is built for based on searching for nearest and next-nearest points, the interpolation will typically cover a (0-0.5) range rather than a (0-1) range. The (0.5-1) range implies a flip in the relationship of nearest vs. next-nearest.

Source files

Definition at line 55 of file lumpedPointInterpolator.H.

Constructor & Destructor Documentation

◆ lumpedPointInterpolator() [1/2]

Definition at line 23 of file lumpedPointInterpolatorI.H.

◆ lumpedPointInterpolator() [2/2]

lumpedPointInterpolator ( const label  id)
inlineexplicit

Definition at line 29 of file lumpedPointInterpolatorI.H.

◆ ~lumpedPointInterpolator()

Member Function Documentation

◆ valid()

bool valid ( ) const
inline

Definition at line 41 of file lumpedPointInterpolatorI.H.

◆ nearest() [1/2]

Foam::label nearest ( ) const
inline

Definition at line 47 of file lumpedPointInterpolatorI.H.

◆ next() [1/3]

Foam::label next ( ) const
inline

Definition at line 53 of file lumpedPointInterpolatorI.H.

◆ next1()

Foam::label next1 ( ) const
inline

Definition at line 59 of file lumpedPointInterpolatorI.H.

◆ next2()

Foam::label next2 ( ) const
inline

Definition at line 65 of file lumpedPointInterpolatorI.H.

◆ weight0()

Foam::scalar weight0 ( ) const
inline

Definition at line 71 of file lumpedPointInterpolatorI.H.

◆ weight1()

Foam::scalar weight1 ( ) const
inline

Definition at line 77 of file lumpedPointInterpolatorI.H.

◆ weight2()

Foam::scalar weight2 ( ) const
inline

Definition at line 83 of file lumpedPointInterpolatorI.H.

◆ nearest() [2/2]

void nearest ( const label  id)
inline

Definition at line 89 of file lumpedPointInterpolatorI.H.

References Foam::Zero.

◆ next() [2/3]

void next ( const label  id,
const scalar  weight 
)
inline

Definition at line 97 of file lumpedPointInterpolatorI.H.

References Foam::Zero.

◆ next() [3/3]

void next ( const label  id,
const scalar  weight,
const label  position 
)
inline
Parameters
positionUse 0 or 1 for first/second

Definition at line 119 of file lumpedPointInterpolatorI.H.

◆ set()

void set ( const triFace ids,
const barycentric2D weights 
)
inline

Definition at line 148 of file lumpedPointInterpolatorI.H.

◆ interpolate()

T interpolate ( const UList< T > &  input) const
inline

Definition at line 163 of file lumpedPointInterpolatorI.H.

References Foam::input(), and Foam::Zero.

Referenced by lumpedPointMovement::pointsDisplacement(), and lumpedPointMovement::pointsPosition().

Here is the call graph for this function:
Here is the caller graph for this function:

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