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

#include <PairCollisionRecord.H>

Inheritance diagram for PairCollisionRecord< Type >:

Public Member Functions
	PairCollisionRecord ()
	Construct null.
	PairCollisionRecord (bool accessed, label origProcOfOther, label origIdOfOther, const Type &data=Type(Zero))
	Construct from components.
	PairCollisionRecord (Istream &)
	Construct from Istream.
	PairCollisionRecord (const PairCollisionRecord &)
	Construct as copy.
	~PairCollisionRecord ()
	Destructor.
label	origProcOfOther () const
	Return the origProcOfOther data.
label	origIdOfOther () const
	Return the origIdOfOther data.
const Type &	collisionData () const
	Return access to the collision data.
Type &	collisionData ()
	Return access to the collision data.
bool	match (label queryOrigProcOfOther, label queryOrigIdOfOther) const
bool	accessed () const
	Return the accessed status of the record.
void	setAccessed ()
	Set the accessed property of the record to accessed.
void	setUnaccessed ()
	Set the accessed property of the record to unaccessed.
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

template<class Type>
class Foam::PairCollisionRecord< Type >

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

Definition at line 82 of file PairCollisionRecord.H.

Constructor & Destructor Documentation

◆ PairCollisionRecord() [1/4]

template<class Type>

PairCollisionRecord ( )

Construct null.

Definition at line 27 of file PairCollisionRecord.C.

References Foam::Zero.

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

Here is the caller graph for this function:

◆ PairCollisionRecord() [2/4]

template<class Type>

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

Construct from components.

Definition at line 36 of file PairCollisionRecord.C.

References accessed(), origIdOfOther(), origProcOfOther(), and setUnaccessed().

Here is the call graph for this function:

◆ PairCollisionRecord() [3/4]

template<class Type>

PairCollisionRecord ( Istream & is )

Construct from Istream.

Definition at line 27 of file PairCollisionRecordIO.C.

References IOstream::check(), FUNCTION_NAME, and Foam::readLabel().

Here is the call graph for this function:

◆ PairCollisionRecord() [4/4]

template<class Type>

PairCollisionRecord ( const PairCollisionRecord< Type > & )

Construct as copy.

References PairCollisionRecord().

Here is the call graph for this function:

◆ ~PairCollisionRecord()

template<class Type>

~PairCollisionRecord ( )

Destructor.

Definition at line 72 of file PairCollisionRecord.C.

Member Function Documentation

◆ origProcOfOther()

template<class Type>

Foam::label origProcOfOther ( ) const

inline

Return the origProcOfOther data.

Definition at line 39 of file PairCollisionRecordI.H.

References Foam::mag().

Referenced by match(), PairCollisionRecord(), setAccessed(), and setUnaccessed().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ origIdOfOther()

template<class Type>

Foam::label origIdOfOther ( ) const

inline

Return the origIdOfOther data.

Definition at line 46 of file PairCollisionRecordI.H.

Referenced by match(), and PairCollisionRecord().

Here is the caller graph for this function:

◆ collisionData() [1/2]

template<class Type>

const Type & collisionData ( ) const

inline

Return access to the collision data.

Definition at line 54 of file PairCollisionRecordI.H.

◆ collisionData() [2/2]

template<class Type>

Type & collisionData ( )

inline

Return access to the collision data.

Definition at line 61 of file PairCollisionRecordI.H.

◆ match()

template<class Type>

bool match	(	label	queryOrigProcOfOther,
		label	queryOrigIdOfOther ) const

inline

Definition at line 24 of file PairCollisionRecordI.H.

References origIdOfOther(), and origProcOfOther().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ accessed()

template<class Type>

bool accessed ( ) const

inline

Return the accessed status of the record.

Definition at line 68 of file PairCollisionRecordI.H.

References Foam::pos0().

Referenced by PairCollisionRecord().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAccessed()

template<class Type>

void setAccessed ( )

inline

Set the accessed property of the record to accessed.

Definition at line 75 of file PairCollisionRecordI.H.

References origProcOfOther().

Referenced by CollisionRecordList< PairType, WallType >::matchPairRecord().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setUnaccessed()

template<class Type>

void setUnaccessed ( )

inline

Set the accessed property of the record to unaccessed.

Definition at line 82 of file PairCollisionRecordI.H.

References origProcOfOther().

Referenced by PairCollisionRecord().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

template<class Type>

void operator= ( const PairCollisionRecord< Type > & )

Definition at line 79 of file PairCollisionRecord.C.

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

Here is the call graph for this function:

◆ operator==

template<class Type>

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

friend

References PairCollisionRecord().

◆ operator!=

template<class Type>

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

friend

References PairCollisionRecord().

◆ operator>>

template<class Type>

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

friend

References PairCollisionRecord().

◆ operator<<

template<class Type>

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

friend

References PairCollisionRecord().

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
src/lagrangian/intermediate/parcels/Templates/CollidingParcel/CollisionRecordList/PairCollisionRecord/PairCollisionRecordIO.C

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ PairCollisionRecord() [1/4]

◆ PairCollisionRecord() [2/4]

◆ PairCollisionRecord() [3/4]

◆ PairCollisionRecord() [4/4]

◆ ~PairCollisionRecord()

Member Function Documentation

◆ origProcOfOther()

◆ origIdOfOther()

◆ collisionData() [1/2]

◆ collisionData() [2/2]

◆ match()

◆ accessed()

◆ setAccessed()

◆ setUnaccessed()

◆ operator=()

Friends And Related Symbol Documentation

◆ operator==

◆ operator!=

◆ operator>>

◆ operator<<