Loading...
Searching...
No Matches
WallCollisionRecord< Type > Class Template 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...

#include <WallCollisionRecord.H>

Inheritance diagram for WallCollisionRecord< Type >:
Inheritance graph
[legend]

Public Member Functions

 WallCollisionRecord ()
 Construct null.
 WallCollisionRecord (bool accessed, const vector &pRel, const Type &data=Type(Zero))
 Construct from components.
 WallCollisionRecord (Istream &)
 Construct from Istream.
 WallCollisionRecord (const WallCollisionRecord &)
 Construct as copy.
 ~WallCollisionRecord ()
 Destructor.
const vector & pRel () const
 Return the pRel data.
const Type & collisionData () const
 Return access to the collision data.
Type & collisionData ()
 Return access to the collision data.
bool match (const vector &pRel, scalar radius)
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 WallCollisionRecord &)

Static Public Attributes

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

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

template<class Type>
class Foam::WallCollisionRecord< Type >

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 75 of file WallCollisionRecord.H.

Constructor & Destructor Documentation

◆ WallCollisionRecord() [1/4]

template<class Type>
WallCollisionRecord ( )

Construct null.

Definition at line 33 of file WallCollisionRecord.C.

References Foam::Zero.

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

Here is the caller graph for this function:

◆ WallCollisionRecord() [2/4]

template<class Type>
WallCollisionRecord ( bool accessed,
const vector & pRel,
const Type & data = Type(Zero) )

Construct from components.

Definition at line 42 of file WallCollisionRecord.C.

References accessed(), and pRel().

Here is the call graph for this function:

◆ WallCollisionRecord() [3/4]

template<class Type>
WallCollisionRecord ( Istream & is)

Construct from Istream.

Definition at line 27 of file WallCollisionRecordIO.C.

References IOstream::check(), and FUNCTION_NAME.

Here is the call graph for this function:

◆ WallCollisionRecord() [4/4]

template<class Type>
WallCollisionRecord ( const WallCollisionRecord< Type > & )

Construct as copy.

References pRel(), and WallCollisionRecord().

Here is the call graph for this function:

◆ ~WallCollisionRecord()

template<class Type>
~WallCollisionRecord ( )

Destructor.

Definition at line 70 of file WallCollisionRecord.C.

Member Function Documentation

◆ pRel()

template<class Type>
const Foam::vector & pRel ( ) const
inline

Return the pRel data.

Definition at line 68 of file WallCollisionRecordI.H.

Referenced by match(), WallCollisionRecord(), and WallCollisionRecord().

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 76 of file WallCollisionRecordI.H.

◆ collisionData() [2/2]

template<class Type>
Type & collisionData ( )
inline

Return access to the collision data.

Definition at line 83 of file WallCollisionRecordI.H.

◆ match()

template<class Type>
bool match ( const vector & pRel,
scalar radius )
inline

Definition at line 24 of file WallCollisionRecordI.H.

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

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

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 90 of file WallCollisionRecordI.H.

Referenced by WallCollisionRecord().

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 97 of file WallCollisionRecordI.H.

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

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 104 of file WallCollisionRecordI.H.

◆ operator=()

template<class Type>
void operator= ( const WallCollisionRecord< Type > & )

Definition at line 77 of file WallCollisionRecord.C.

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

Here is the call graph for this function:

◆ operator==

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

References WallCollisionRecord().

◆ operator!=

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

References WallCollisionRecord().

◆ operator>>

template<class Type>
Istream & operator>> ( Istream & ,
WallCollisionRecord< Type > &  )
friend

References WallCollisionRecord().

◆ operator<<

template<class Type>
Ostream & operator<< ( Ostream & ,
const WallCollisionRecord< Type > &  )
friend

References WallCollisionRecord().

Member Data Documentation

◆ errorCosAngle

template<class Type>
const Foam::scalar errorCosAngle
static

Tolerance for detecting seriously erroneous wall matches.

Definition at line 102 of file WallCollisionRecord.H.

Referenced by match().

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
  • src/lagrangian/intermediate/parcels/Templates/CollidingParcel/CollisionRecordList/WallCollisionRecord/WallCollisionRecordIO.C