PairCollisionRecord Class Reference

Record of a collision between the particle holding the record and the particle with the stored id. More...

Public Member Functions
	PairCollisionRecord ()
	PairCollisionRecord (bool accessed, label origProcOfOther, label origIdOfOther, const Type &data=Type(Zero))
	PairCollisionRecord (Istream &)
	PairCollisionRecord (const PairCollisionRecord &)
	~PairCollisionRecord ()
label	origProcOfOther () const
label	origIdOfOther () const
const Type &	collisionData () const
Type &	collisionData ()
bool	match (label queryOrigProcOfOther, label queryOrigIdOfOther) const
bool	accessed () const
void	setAccessed ()
void	setUnaccessed ()
void	operator= (const PairCollisionRecord &)

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

Detailed Description

Record of a collision between the particle holding the record and the particle with the stored id.

The access status of the record is to be coded in the origProcOfOther data member. The actual processor is offset by +1. A negative value means that the record has not been accessed, positive means that it has.

Source files

• PairCollisionRecord.H
• PairCollisionRecordI.H
• PairCollisionRecord.C
• PairCollisionRecordIO.C

Definition at line 54 of file PairCollisionRecord.H.

Constructor & Destructor Documentation

PairCollisionRecord() [1/4]

PairCollisionRecord

(

)

Definition at line 27 of file PairCollisionRecord.C.

PairCollisionRecord() [2/4]

PairCollisionRecord	(	bool	accessed,
		label	origProcOfOther,
		label	origIdOfOther,
		const Type &	data = Type(Zero)
	)

PairCollisionRecord() [3/4]

PairCollisionRecord

(

Istream &

)

PairCollisionRecord() [4/4]

PairCollisionRecord

(

const PairCollisionRecord &

)

~PairCollisionRecord()

~PairCollisionRecord

(

)

Definition at line 72 of file PairCollisionRecord.C.

Member Function Documentation

origProcOfOther()

Foam::label origProcOfOther ( ) const

inline

Definition at line 39 of file PairCollisionRecordI.H.

References Foam::mag().

Here is the call graph for this function:

origIdOfOther()

Foam::label origIdOfOther ( ) const

inline

Definition at line 46 of file PairCollisionRecordI.H.

collisionData() [1/2]

const Type & collisionData ( ) const

inline

Definition at line 54 of file PairCollisionRecordI.H.

collisionData() [2/2]

Type & collisionData ( )

inline

Definition at line 61 of file PairCollisionRecordI.H.

match()

bool match ( label  queryOrigProcOfOther, label  queryOrigIdOfOther  ) const

inline

Definition at line 25 of file PairCollisionRecordI.H.

Referenced by CollisionRecordList< vector, vector >::checkPairRecord(), and CollisionRecordList< vector, vector >::matchPairRecord().

Here is the caller graph for this function:

accessed()

bool accessed ( ) const

inline

Definition at line 68 of file PairCollisionRecordI.H.

References Foam::pos0().

Here is the call graph for this function:

setAccessed()

void setAccessed ( )

inline

Definition at line 75 of file PairCollisionRecordI.H.

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

Here is the caller graph for this function:

setUnaccessed()

void setUnaccessed ( )

inline

Definition at line 82 of file PairCollisionRecordI.H.

operator=()

void operator=

(

const PairCollisionRecord &

)

Definition at line 80 of file PairCollisionRecord.C.

Friends And Related Function Documentation

operator==

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

friend

operator!=

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

friend

operator>>

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

friend

operator

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

friend

---

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

• src/lagrangian/intermediate/parcels/Templates/CollidingParcel/CollisionRecordList/PairCollisionRecord/PairCollisionRecord.H
• src/lagrangian/intermediate/parcels/Templates/CollidingParcel/CollisionRecordList/PairCollisionRecord/PairCollisionRecord.C
• src/lagrangian/intermediate/parcels/Templates/CollidingParcel/CollisionRecordList/PairCollisionRecord/PairCollisionRecordI.H