CollisionRecordList< PairType, WallType > Class Template Reference
Inheritance diagram for CollisionRecordList< PairType, WallType >:
[legend]

Public Member Functions

 CollisionRecordList ()=default
 Default construct. More...
 
 CollisionRecordList (Istream &is)
 Construct from Istream. More...
 
 CollisionRecordList (const labelField &pairAccessed, const labelField &pairOrigProcOfOther, const labelField &pairOrigIdOfOther, const Field< PairType > &pairData, const labelField &wallAccessed, const vectorField &wallPRel, const Field< WallType > &wallData)
 Construct from component fields (for IO) More...
 
const DynamicList< PairCollisionRecord< PairType > > & pairRecords () const
 Return the active pair collisions. More...
 
const DynamicList< WallCollisionRecord< WallType > > & wallRecords () const
 Return the active wall collisions. More...
 
labelField pairAccessed () const
 Return field of pair accessed from each record, used for. More...
 
labelField pairOrigProcOfOther () const
 Return field of pair origProcOfOther from each record,. More...
 
labelField pairOrigIdOfOther () const
 Return field of pair origIdOfOther from each record, used. More...
 
Field< PairType > pairData () const
 Return field of pair data from each record, used for field IO. More...
 
labelField wallAccessed () const
 Return field of wall accessed from each record, used for field IO. More...
 
vectorField wallPRel () const
 Return field of wall pRel from each record, used for field IO. More...
 
Field< WallType > wallData () const
 Return field of wall data from each record, used for field IO. More...
 
PairCollisionRecord< PairType > & matchPairRecord (label origProcOfOther, label origIdOfOther)
 Enquires if the proc and id pair of the other particle are. More...
 
bool checkPairRecord (label origProcOfOther, label origIdOfOther)
 Enquire if the specified record exists without modifying. More...
 
WallCollisionRecord< WallType > & matchWallRecord (const vector &pRel, scalar radius)
 Enquires if the position of wall impact relative to the. More...
 
bool checkWallRecord (const vector &pRel, scalar radius)
 Enquire if the specified record exists without modifying. More...
 
void update ()
 Update the collision records, deleting any records not. More...
 

Friends

bool operator== (const CollisionRecordList< PairType, WallType > &, const CollisionRecordList< PairType, WallType > &)
 
bool operator!= (const CollisionRecordList< PairType, WallType > &, const CollisionRecordList< PairType, WallType > &)
 
Istreamoperator>> (Istream &, CollisionRecordList< PairType, WallType > &)
 
Ostreamoperator (Ostream &, const CollisionRecordList< PairType, WallType > &)
 

Detailed Description

template<class PairType, class WallType>
class Foam::CollisionRecordList< PairType, WallType >

Source files

Definition at line 52 of file CollisionRecordList.H.

Constructor & Destructor Documentation

◆ CollisionRecordList() [1/3]

CollisionRecordList ( )
default

Default construct.

◆ CollisionRecordList() [2/3]

CollisionRecordList ( Istream is)
explicit

Construct from Istream.

Definition at line 35 of file CollisionRecordList.C.

◆ CollisionRecordList() [3/3]

CollisionRecordList ( const labelField pairAccessed,
const labelField pairOrigProcOfOther,
const labelField pairOrigIdOfOther,
const Field< PairType > &  pairData,
const labelField wallAccessed,
const vectorField wallPRel,
const Field< WallType > &  wallData 
)

Construct from component fields (for IO)

Definition at line 46 of file CollisionRecordList.C.

Member Function Documentation

◆ pairRecords()

const Foam::DynamicList< Foam::PairCollisionRecord< PairType > > & pairRecords ( ) const
inline

Return the active pair collisions.

Definition at line 32 of file CollisionRecordListI.H.

◆ wallRecords()

const Foam::DynamicList< Foam::WallCollisionRecord< WallType > > & wallRecords ( ) const
inline

Return the active wall collisions.

Definition at line 40 of file CollisionRecordListI.H.

◆ pairAccessed()

Foam::labelField pairAccessed ( ) const

Return field of pair accessed from each record, used for.

field IO

Definition at line 122 of file CollisionRecordList.C.

◆ pairOrigProcOfOther()

Foam::labelField pairOrigProcOfOther ( ) const

Return field of pair origProcOfOther from each record,.

used for field IO

Definition at line 137 of file CollisionRecordList.C.

◆ pairOrigIdOfOther()

Foam::labelField pairOrigIdOfOther ( ) const

Return field of pair origIdOfOther from each record, used.

for field IO

Definition at line 152 of file CollisionRecordList.C.

◆ pairData()

Foam::Field< PairType > pairData ( ) const

Return field of pair data from each record, used for field IO.

Definition at line 167 of file CollisionRecordList.C.

◆ wallAccessed()

Foam::labelField wallAccessed ( ) const

Return field of wall accessed from each record, used for field IO.

Definition at line 182 of file CollisionRecordList.C.

◆ wallPRel()

Foam::vectorField wallPRel ( ) const

Return field of wall pRel from each record, used for field IO.

Definition at line 197 of file CollisionRecordList.C.

◆ wallData()

Foam::Field< WallType > wallData ( ) const

Return field of wall data from each record, used for field IO.

Definition at line 212 of file CollisionRecordList.C.

◆ matchPairRecord()

Foam::PairCollisionRecord< PairType > & matchPairRecord ( label  origProcOfOther,
label  origIdOfOther 
)

Enquires if the proc and id pair of the other particle are.

present in the records. If so, return non-const access to the PairCollisionRecord (hence the data) and mark the PairCollisionRecord as accessed this step, if not, create the record and return access to it.

Definition at line 228 of file CollisionRecordList.C.

◆ checkPairRecord()

bool checkPairRecord ( label  origProcOfOther,
label  origIdOfOther 
)

Enquire if the specified record exists without modifying.

its accessed status

Definition at line 264 of file CollisionRecordList.C.

◆ matchWallRecord()

Foam::WallCollisionRecord< WallType > & matchWallRecord ( const vector pRel,
scalar  radius 
)

Enquires if the position of wall impact relative to the.

particle centre is present in the records. If so, return access to the WallCollisionRecord (hence the data) and mark the WallCollisionRecord as accesses this step, if not, create the record and return access to it.

Definition at line 286 of file CollisionRecordList.C.

◆ checkWallRecord()

bool checkWallRecord ( const vector pRel,
scalar  radius 
)

Enquire if the specified record exists without modifying.

its accessed status

Definition at line 318 of file CollisionRecordList.C.

◆ update()

void update ( )

Update the collision records, deleting any records not.

marked as having been accessed, then mark all records as not accessed ready for the next evaluation

Definition at line 338 of file CollisionRecordList.C.

Friends And Related Function Documentation

◆ operator==

bool operator== ( const CollisionRecordList< PairType, WallType > &  ,
const CollisionRecordList< PairType, WallType > &   
)
friend

◆ operator!=

bool operator!= ( const CollisionRecordList< PairType, WallType > &  ,
const CollisionRecordList< PairType, WallType > &   
)
friend

◆ operator>>

Istream& operator>> ( Istream ,
CollisionRecordList< PairType, WallType > &   
)
friend

◆ operator

Ostream& operator ( Ostream ,
const CollisionRecordList< PairType, WallType > &   
)
friend

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