Public Member Functions | Static Public Attributes | Private Attributes | Friends
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...

Collaboration diagram for WallCollisionRecord:
Collaboration graph
[legend]

Public Member Functions

 WallCollisionRecord ()
 Construct null. More...
 
 WallCollisionRecord (bool accessed, const vector &pRel, const Type &data=pTraits< Type >::zero)
 Construct from components. More...
 
 WallCollisionRecord (Istream &)
 Construct from Istream. More...
 
 WallCollisionRecord (const WallCollisionRecord &)
 Construct as copy. More...
 
 ~WallCollisionRecord ()
 Destructor. More...
 
const vector & pRel () const
 Return the pRel data. More...
 
const Type & collisionData () const
 Return access to the collision data. More...
 
Type & collisionData ()
 Return access to the collision data. More...
 
bool match (const vector &pRel, scalar radius)
 
bool accessed () const
 Return the accessed status of the record. More...
 
void setAccessed ()
 Set the accessed property of the record to accessed. More...
 
void setUnaccessed ()
 Set the accessed property of the record to unaccessed. More...
 
void operator= (const WallCollisionRecord &)
 

Static Public Attributes

static const scalar errorCosAngle
 Tolerance for detecting seriously erroneous wall matches. More...
 

Private Attributes

bool accessed_
 
vector pRel_
 The position of wall impact relative to the particle centre. More...
 
Type data_
 Collision data, stored as if the storing particle was the. More...
 

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

Definition at line 49 of file WallCollisionRecord.H.

Constructor & Destructor Documentation

◆ WallCollisionRecord() [1/4]

WallCollisionRecord ( )

Construct null.

Definition at line 37 of file WallCollisionRecord.C.

◆ WallCollisionRecord() [2/4]

WallCollisionRecord ( bool  accessed,
const vector &  pRel,
const Type &  data = pTraits< Type >::zero 
)

Construct from components.

◆ WallCollisionRecord() [3/4]

WallCollisionRecord ( Istream &  )

Construct from Istream.

◆ WallCollisionRecord() [4/4]

WallCollisionRecord ( const WallCollisionRecord &  )

Construct as copy.

◆ ~WallCollisionRecord()

~WallCollisionRecord ( )

Destructor.

Definition at line 74 of file WallCollisionRecord.C.

Member Function Documentation

◆ pRel()

const Foam::vector & pRel ( ) const
inline

Return the pRel data.

Definition at line 73 of file WallCollisionRecordI.H.

◆ collisionData() [1/2]

const Type & collisionData ( ) const
inline

Return access to the collision data.

Definition at line 81 of file WallCollisionRecordI.H.

◆ collisionData() [2/2]

Type & collisionData ( )
inline

Return access to the collision data.

Definition at line 88 of file WallCollisionRecordI.H.

◆ match()

bool match ( const vector &  pRel,
scalar  radius 
)
inline

Definition at line 30 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

Return the accessed status of the record.

Definition at line 95 of file WallCollisionRecordI.H.

◆ setAccessed()

void setAccessed ( )
inline

Set the accessed property of the record to accessed.

Definition at line 102 of file WallCollisionRecordI.H.

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

Here is the caller graph for this function:

◆ setUnaccessed()

void setUnaccessed ( )
inline

Set the accessed property of the record to unaccessed.

Definition at line 109 of file WallCollisionRecordI.H.

◆ operator=()

void operator= ( const WallCollisionRecord &  )

Definition at line 82 of file WallCollisionRecord.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

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

Field Documentation

◆ accessed_

bool accessed_
private

Definition at line 82 of file WallCollisionRecord.H.

Referenced by Foam::operator==().

◆ pRel_

vector pRel_
private

The position of wall impact relative to the particle centre.

Definition at line 85 of file WallCollisionRecord.H.

Referenced by Foam::operator==().

◆ data_

Type data_
private

Collision data, stored as if the storing particle was the.

first particle (particle A) in the collision.

Definition at line 89 of file WallCollisionRecord.H.

Referenced by Foam::operator==().

◆ errorCosAngle

const Foam::scalar errorCosAngle
static

Tolerance for detecting seriously erroneous wall matches.

Definition at line 97 of file WallCollisionRecord.H.

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17