WallCollisionRecord Class Reference

Record of a collision between the particle holding the record and a wall face at the position relative to the centre of the particle. More...

Public Member Functions
	WallCollisionRecord ()
	WallCollisionRecord (bool accessed, const vector &pRel, const Type &data=Type(Zero))
	WallCollisionRecord (Istream &)
	WallCollisionRecord (const WallCollisionRecord &)
	~WallCollisionRecord ()
const vector &	pRel () const
const Type &	collisionData () const
Type &	collisionData ()
bool	match (const vector &pRel, scalar radius)
bool	accessed () const
void	setAccessed ()
void	setUnaccessed ()
void	operator= (const WallCollisionRecord &)

Static Public Attributes
static const scalar	errorCosAngle

Friends
bool	operator== (const WallCollisionRecord< Type > &, const WallCollisionRecord< Type > &)
bool	operator!= (const WallCollisionRecord< Type > &, const WallCollisionRecord< Type > &)
Istream &	operator>> (Istream &, WallCollisionRecord< Type > &)
Ostream &	operator (Ostream &, const WallCollisionRecord< Type > &)

Detailed Description

Record of a collision between the particle holding the record and a wall face at the position relative to the centre of the particle.

Source files

• WallCollisionRecord.H
• WallCollisionRecordI.H
• WallCollisionRecord.C
• WallCollisionRecordIO.C

Definition at line 47 of file WallCollisionRecord.H.

Constructor & Destructor Documentation

WallCollisionRecord() [1/4]

WallCollisionRecord

(

)

Definition at line 33 of file WallCollisionRecord.C.

WallCollisionRecord() [2/4]

WallCollisionRecord	(	bool	accessed,
		const vector &	pRel,
		const Type &	data = Type(Zero)
	)

WallCollisionRecord() [3/4]

WallCollisionRecord

(

Istream &

)

WallCollisionRecord() [4/4]

WallCollisionRecord

(

const WallCollisionRecord &

)

~WallCollisionRecord()

~WallCollisionRecord

(

)

Definition at line 70 of file WallCollisionRecord.C.

Member Function Documentation

pRel()

const Foam::vector & pRel ( ) const

inline

Definition at line 68 of file WallCollisionRecordI.H.

collisionData() [1/2]

const Type & collisionData ( ) const

inline

Definition at line 76 of file WallCollisionRecordI.H.

collisionData() [2/2]

Type & collisionData ( )

inline

Definition at line 83 of file WallCollisionRecordI.H.

match()

bool match ( const vector &  pRel, scalar  radius  )

inline

Definition at line 25 of file WallCollisionRecordI.H.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, Foam::Info, Foam::mag(), and Foam::nl.

Referenced by CollisionRecordList< vector, vector >::checkWallRecord(), and CollisionRecordList< vector, vector >::matchWallRecord().

Here is the call graph for this function:

Here is the caller graph for this function:

accessed()

bool accessed ( ) const

inline

Definition at line 90 of file WallCollisionRecordI.H.

setAccessed()

void setAccessed ( )

inline

Definition at line 97 of file WallCollisionRecordI.H.

Referenced by CollisionRecordList< vector, vector >::matchWallRecord().

Here is the caller graph for this function:

setUnaccessed()

void setUnaccessed ( )

inline

Definition at line 104 of file WallCollisionRecordI.H.

operator=()

void operator=

(

const WallCollisionRecord &

)

Definition at line 78 of file WallCollisionRecord.C.

Friends And Related Function Documentation

operator==

bool operator== ( const WallCollisionRecord< Type > &  , const WallCollisionRecord< Type > &    )

friend

operator!=

bool operator!= ( const WallCollisionRecord< Type > &  , const WallCollisionRecord< Type > &    )

friend

operator>>

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

friend

operator

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

friend

Member Data Documentation

errorCosAngle

const Foam::scalar errorCosAngle

static

Definition at line 95 of file WallCollisionRecord.H.

---

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

• src/lagrangian/intermediate/parcels/Templates/CollidingParcel/CollisionRecordList/WallCollisionRecord/WallCollisionRecord.H
• src/lagrangian/intermediate/parcels/Templates/CollidingParcel/CollisionRecordList/WallCollisionRecord/WallCollisionRecord.C
• src/lagrangian/intermediate/parcels/Templates/CollidingParcel/CollisionRecordList/WallCollisionRecord/WallCollisionRecordI.H