Public Member Functions | Friends | List of all members
WallSiteData< Type > Class Template Reference

Stores the patch ID and templated data to represent a collision with a wall to be passed to the wall model. More...

Public Member Functions

 WallSiteData ()
 Construct null. More...
 
 WallSiteData (label patchi, const Type &wallData)
 Construct from components. More...
 
 ~WallSiteData ()
 Destructor. More...
 
label patchIndex () const
 Return access to the patch index. More...
 
label & patchIndex ()
 Return non-const access to the patch index. More...
 
const Type & wallData () const
 Return access to wall data. More...
 
Type & wallData ()
 Return non-const access to wall data. More...
 
bool operator== (const WallSiteData< Type > &) const
 
bool operator!= (const WallSiteData< Type > &) const
 

Friends

Istream & operator>> (Istream &, WallSiteData< Type > &)
 
Ostream & operator (Ostream &, const WallSiteData< Type > &)
 

Detailed Description

template<class Type>
class Foam::WallSiteData< Type >

Stores the patch ID and templated data to represent a collision with a wall to be passed to the wall model.

Source files

Definition at line 50 of file WallSiteData.H.

Constructor & Destructor Documentation

◆ WallSiteData() [1/2]

WallSiteData ( )

Construct null.

Definition at line 31 of file WallSiteData.C.

◆ WallSiteData() [2/2]

WallSiteData ( label  patchi,
const Type &  wallData 
)

Construct from components.

Definition at line 40 of file WallSiteData.C.

◆ ~WallSiteData()

~WallSiteData ( )

Destructor.

Definition at line 53 of file WallSiteData.C.

Member Function Documentation

◆ patchIndex() [1/2]

Foam::label patchIndex ( ) const
inline

Return access to the patch index.

Definition at line 31 of file WallSiteDataI.H.

◆ patchIndex() [2/2]

Foam::label & patchIndex ( )
inline

Return non-const access to the patch index.

Definition at line 38 of file WallSiteDataI.H.

◆ wallData() [1/2]

const Type & wallData ( ) const
inline

Return access to wall data.

Definition at line 45 of file WallSiteDataI.H.

◆ wallData() [2/2]

Type & wallData ( )
inline

Return non-const access to wall data.

Definition at line 52 of file WallSiteDataI.H.

◆ operator==()

bool operator== ( const WallSiteData< Type > &  rhs) const

Definition at line 61 of file WallSiteData.C.

◆ operator!=()

bool operator!= ( const WallSiteData< Type > &  rhs) const

Definition at line 71 of file WallSiteData.C.

References IOstream::check(), and token::SPACE.

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator>>

Istream& operator>> ( Istream &  ,
WallSiteData< Type > &   
)
friend

◆ operator

Ostream& operator ( Ostream &  ,
const WallSiteData< Type > &   
)
friend
The documentation for this class was generated from the following files: