WallSiteData Class 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

Private Attributes
label	patchI_
	Index of originating patch. More...
Type	wallData_
	Wall data. More...

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

Detailed Description

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

Source files

• WallSiteData.H
• WallSiteDataI.H
• WallSiteData.C
• WallSiteDataIO.C

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.

References WallSiteData::patchI_.

operator!=()

bool operator!=

(

const WallSiteData< Type > &

rhs

)

const

Definition at line 71 of file WallSiteData.C.

Friends And Related Function Documentation

operator>>

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

friend

operator

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

friend

Field Documentation

patchI_

label patchI_

private

Index of originating patch.

Definition at line 69 of file WallSiteData.H.

Referenced by WallSiteData::operator==().

wallData_

Type wallData_

private

Wall data.

Definition at line 72 of file WallSiteData.H.

---

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