Loading...
Searching...
No Matches
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...

#include <WallSiteData.H>

Public Member Functions

 WallSiteData ()
 Construct null.
 WallSiteData (label patchi, const Type &wallData)
 Construct from components.
 ~WallSiteData ()
 Destructor.
label patchIndex () const
 Return access to the patch index.
label & patchIndex ()
 Return non-const access to the patch index.
const Type & wallData () const
 Return access to wall data.
Type & wallData ()
 Return non-const access to wall data.
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 62 of file WallSiteData.H.

Constructor & Destructor Documentation

◆ WallSiteData() [1/2]

template<class Type>
WallSiteData ( )

Construct null.

Definition at line 26 of file WallSiteData.C.

Referenced by operator!=(), operator<<, operator==(), and operator>>.

Here is the caller graph for this function:

◆ WallSiteData() [2/2]

template<class Type>
WallSiteData ( label patchi,
const Type & wallData )

Construct from components.

Definition at line 34 of file WallSiteData.C.

References wallData().

Here is the call graph for this function:

◆ ~WallSiteData()

template<class Type>
~WallSiteData ( )

Destructor.

Definition at line 48 of file WallSiteData.C.

Member Function Documentation

◆ patchIndex() [1/2]

template<class Type>
Foam::label patchIndex ( ) const
inline

Return access to the patch index.

Definition at line 26 of file WallSiteDataI.H.

◆ patchIndex() [2/2]

template<class Type>
Foam::label & patchIndex ( )
inline

Return non-const access to the patch index.

Definition at line 33 of file WallSiteDataI.H.

◆ wallData() [1/2]

template<class Type>
const Type & wallData ( ) const
inline

Return access to wall data.

Definition at line 40 of file WallSiteDataI.H.

Referenced by WallSiteData().

Here is the caller graph for this function:

◆ wallData() [2/2]

template<class Type>
Type & wallData ( )
inline

Return non-const access to wall data.

Definition at line 47 of file WallSiteDataI.H.

◆ operator==()

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

Definition at line 55 of file WallSiteData.C.

References Foam::rhs(), and WallSiteData().

Here is the call graph for this function:

◆ operator!=()

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

Definition at line 65 of file WallSiteData.C.

References Foam::rhs(), and WallSiteData().

Here is the call graph for this function:

◆ operator>>

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

References WallSiteData().

◆ operator<<

template<class Type>
Ostream & operator<< ( Ostream & ,
const WallSiteData< Type > &  )
friend

References WallSiteData().

The documentation for this class was generated from the following files:
  • src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/WallSiteData/WallSiteData.H
  • src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/WallSiteData/WallSiteData.C
  • src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/WallSiteData/WallSiteDataI.H