Loading...
Searching...
No Matches
CollisionRecordList< PairType, WallType > Class Template Reference

#include <CollisionRecordList.H>

Inheritance diagram for CollisionRecordList< PairType, WallType >:
Inheritance graph
[legend]

Public Member Functions

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

Friends

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

Detailed Description

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

Source files

Definition at line 76 of file CollisionRecordList.H.

Constructor & Destructor Documentation

◆ CollisionRecordList() [1/3]

template<class PairType, class WallType>
CollisionRecordList ( )
default

Default construct.

◆ CollisionRecordList() [2/3]

template<class PairType, class WallType>
CollisionRecordList ( Istream & is)
explicit

Construct from Istream.

Definition at line 28 of file CollisionRecordList.C.

References IOstream::check(), and FUNCTION_NAME.

Here is the call graph for this function:

◆ CollisionRecordList() [3/3]

template<class PairType, class WallType>
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 38 of file CollisionRecordList.C.

References forAll, pairAccessed(), pairData(), pairOrigIdOfOther(), pairOrigProcOfOther(), wallAccessed(), wallData(), and wallPRel().

Here is the call graph for this function:

Member Function Documentation

◆ pairRecords()

template<class PairType, class WallType>
const Foam::DynamicList< Foam::PairCollisionRecord< PairType > > & pairRecords ( ) const
inline

Return the active pair collisions.

Definition at line 25 of file CollisionRecordListI.H.

◆ wallRecords()

template<class PairType, class WallType>
const Foam::DynamicList< Foam::WallCollisionRecord< WallType > > & wallRecords ( ) const
inline

Return the active wall collisions.

Definition at line 33 of file CollisionRecordListI.H.

◆ pairAccessed()

template<class PairType, class WallType>
Foam::labelField pairAccessed ( ) const

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

field IO

Definition at line 115 of file CollisionRecordList.C.

References f(), and forAll.

Referenced by CollisionRecordList().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ pairOrigProcOfOther()

template<class PairType, class WallType>
Foam::labelField pairOrigProcOfOther ( ) const

Return field of pair origProcOfOther from each record,.

used for field IO

Definition at line 130 of file CollisionRecordList.C.

References f(), and forAll.

Referenced by CollisionRecordList().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ pairOrigIdOfOther()

template<class PairType, class WallType>
Foam::labelField pairOrigIdOfOther ( ) const

Return field of pair origIdOfOther from each record, used.

for field IO

Definition at line 145 of file CollisionRecordList.C.

References f(), and forAll.

Referenced by CollisionRecordList().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ pairData()

template<class PairType, class WallType>
Foam::Field< PairType > pairData ( ) const

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

Definition at line 160 of file CollisionRecordList.C.

References f(), and forAll.

Referenced by CollisionRecordList().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ wallAccessed()

template<class PairType, class WallType>
Foam::labelField wallAccessed ( ) const

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

Definition at line 175 of file CollisionRecordList.C.

References f(), and forAll.

Referenced by CollisionRecordList().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ wallPRel()

template<class PairType, class WallType>
Foam::vectorField wallPRel ( ) const

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

Definition at line 190 of file CollisionRecordList.C.

References f(), and forAll.

Referenced by CollisionRecordList().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ wallData()

template<class PairType, class WallType>
Foam::Field< WallType > wallData ( ) const

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

Definition at line 205 of file CollisionRecordList.C.

References f(), and forAll.

Referenced by CollisionRecordList().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ matchPairRecord()

template<class PairType, class WallType>
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 220 of file CollisionRecordList.C.

References forAll, PairCollisionRecord< Type >::match(), and PairCollisionRecord< Type >::setAccessed().

Here is the call graph for this function:

◆ checkPairRecord()

template<class PairType, class WallType>
bool checkPairRecord ( label origProcOfOther,
label origIdOfOther )

Enquire if the specified record exists without modifying.

its accessed status

Definition at line 251 of file CollisionRecordList.C.

References forAll, and PairCollisionRecord< Type >::match().

Here is the call graph for this function:

◆ matchWallRecord()

template<class PairType, class WallType>
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 273 of file CollisionRecordList.C.

References forAll, WallCollisionRecord< Type >::match(), and WallCollisionRecord< Type >::setAccessed().

Here is the call graph for this function:

◆ checkWallRecord()

template<class PairType, class WallType>
bool checkWallRecord ( const vector & pRel,
scalar radius )

Enquire if the specified record exists without modifying.

its accessed status

Definition at line 303 of file CollisionRecordList.C.

References forAll, and WallCollisionRecord< Type >::match().

Here is the call graph for this function:

◆ update()

template<class PairType, class WallType>
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 324 of file CollisionRecordList.C.

References DynamicList< T, SizeMin >::append(), and forAll.

Here is the call graph for this function:

◆ operator==

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

◆ operator!=

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

◆ operator>>

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

◆ operator

template<class PairType, class WallType>
Ostream & operator ( Ostream & ,
const CollisionRecordList< PairType, WallType > &  )
friend
The documentation for this class was generated from the following files: