Public Types | Public Member Functions | Protected Member Functions | Friends | List of all members
WallLocationData< WallLocation, Type > Class Template Reference

Holds information regarding nearest wall point. Used in wall distance calculation. More...

Inheritance diagram for WallLocationData< WallLocation, Type >:
Inheritance graph
[legend]
Collaboration diagram for WallLocationData< WallLocation, Type >:
Collaboration graph
[legend]

Public Types

typedef Type dataType
 The type of the stored data. More...
 

Public Member Functions

 WallLocationData ()
 Construct null. More...
 
template<class ... Geometry>
 WallLocationData (const Type &data, const Geometry &... geometry)
 Construct from data and other geometry. More...
 
const Type & data () const
 
Type & data ()
 
template<class TrackingData >
const Type & data (TrackingData &td) const
 
template<class TrackingData >
void transform (const transformer &transform, TrackingData &td)
 Transform across an interface. More...
 

Protected Member Functions

template<class TrackingData >
bool update (const point &pt, const WallLocationData< WallLocation, Type > &w2, const scalar tol, TrackingData &td)
 Evaluate distance to point. Update distSqr, origin from whomever. More...
 

Friends

Ostream & operator (Ostream &, const WallLocationData< WallLocation, Type > &)
 
Istream & operator>> (Istream &, WallLocationData< WallLocation, Type > &)
 

Detailed Description

template<class WallLocation, class Type>
class Foam::WallLocationData< WallLocation, Type >

Holds information regarding nearest wall point. Used in wall distance calculation.

Source files

Definition at line 61 of file WallLocationData.H.

Member Typedef Documentation

◆ dataType

typedef Type dataType

The type of the stored data.

Definition at line 93 of file WallLocationData.H.

Constructor & Destructor Documentation

◆ WallLocationData() [1/2]

WallLocationData
inline

Construct null.

Definition at line 55 of file WallLocationDataI.H.

◆ WallLocationData() [2/2]

WallLocationData ( const Type &  data,
const Geometry &...  geometry 
)
inline

Construct from data and other geometry.

Definition at line 64 of file WallLocationDataI.H.

Member Function Documentation

◆ update()

bool update ( const point &  pt,
const WallLocationData< WallLocation, Type > &  w2,
const scalar  tol,
TrackingData &  td 
)
inlineprotected

Evaluate distance to point. Update distSqr, origin from whomever.

is nearer pt. Return true if w2 is closer to point, false otherwise.

Definition at line 33 of file WallLocationDataI.H.

References w2.

◆ data() [1/3]

const Type & data
inline

Definition at line 78 of file WallLocationDataI.H.

◆ data() [2/3]

Type & data
inline

Definition at line 85 of file WallLocationDataI.H.

◆ data() [3/3]

const Type & data ( TrackingData &  td) const
inline

Definition at line 93 of file WallLocationDataI.H.

◆ transform()

void transform ( const transformer &  transform,
TrackingData &  td 
)
inline

Transform across an interface.

Definition at line 104 of file WallLocationDataI.H.

Friends And Related Function Documentation

◆ operator

Ostream& operator ( Ostream &  ,
const WallLocationData< WallLocation, Type > &   
)
friend

◆ operator>>

Istream& operator>> ( Istream &  ,
WallLocationData< WallLocation, Type > &   
)
friend
The documentation for this class was generated from the following files: