Public Member Functions | Friends | List of all members
CollisionRecordList< PairType, WallType > Class Template Reference
Inheritance diagram for CollisionRecordList< PairType, WallType >:
Inheritance graph
[legend]

Public Member Functions

 CollisionRecordList ()
 Construct null. More...
 
 CollisionRecordList (Istream &)
 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...
 
 ~CollisionRecordList ()
 Destructor. 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...
 
void operator= (const CollisionRecordList &)
 

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 49 of file CollisionRecordList.H.

Constructor & Destructor Documentation

Construct null.

Definition at line 32 of file CollisionRecordList.C.

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

Here is the caller graph for this function:

Construct from Istream.

Definition at line 40 of file CollisionRecordList.C.

References IOstream::check(), and CollisionRecordList< PairType, WallType >::CollisionRecordList().

Here is the call graph for this function:

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 56 of file CollisionRecordList.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, forAll, Foam::nl, List< T >::size(), and List< Type >::size().

Here is the call graph for this function:

Destructor.

Definition at line 155 of file CollisionRecordList.C.

Member Function Documentation

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

Return the active pair collisions.

Definition at line 32 of file CollisionRecordListI.H.

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

Return the active wall collisions.

Definition at line 40 of file CollisionRecordListI.H.

Foam::labelField pairAccessed ( ) const

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

field IO

Definition at line 163 of file CollisionRecordList.C.

References f(), and forAll.

Here is the call graph for this function:

Foam::labelField pairOrigProcOfOther ( ) const

Return field of pair origProcOfOther from each record,.

used for field IO

Definition at line 178 of file CollisionRecordList.C.

References f(), and forAll.

Here is the call graph for this function:

Foam::labelField pairOrigIdOfOther ( ) const

Return field of pair origIdOfOther from each record, used.

for field IO

Definition at line 193 of file CollisionRecordList.C.

References f(), and forAll.

Here is the call graph for this function:

Foam::Field< PairType > pairData ( ) const

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

Definition at line 208 of file CollisionRecordList.C.

References f(), and forAll.

Here is the call graph for this function:

Foam::labelField wallAccessed ( ) const

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

Definition at line 223 of file CollisionRecordList.C.

References f(), and forAll.

Here is the call graph for this function:

Foam::vectorField wallPRel ( ) const

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

Definition at line 238 of file CollisionRecordList.C.

References f(), and forAll.

Here is the call graph for this function:

Foam::Field< WallType > wallData ( ) const

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

Definition at line 253 of file CollisionRecordList.C.

References f(), forAll, and CollisionRecordList< PairType, WallType >::matchPairRecord().

Here is the call graph for this function:

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 269 of file CollisionRecordList.C.

References CollisionRecordList< PairType, WallType >::checkPairRecord(), forAll, PairCollisionRecord< Type >::match(), and PairCollisionRecord< Type >::setAccessed().

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

Here is the call graph for this function:

Here is the caller graph for this function:

bool checkPairRecord ( label  origProcOfOther,
label  origIdOfOther 
)

Enquire if the specified record exists without modifying.

its accessed status

Definition at line 305 of file CollisionRecordList.C.

References forAll, PairCollisionRecord< Type >::match(), and CollisionRecordList< PairType, WallType >::matchWallRecord().

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

Here is the call graph for this function:

Here is the caller graph for this function:

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 327 of file CollisionRecordList.C.

References CollisionRecordList< PairType, WallType >::checkWallRecord(), forAll, WallCollisionRecord< Type >::match(), and WallCollisionRecord< Type >::setAccessed().

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

Here is the call graph for this function:

Here is the caller graph for this function:

bool checkWallRecord ( const vector pRel,
scalar  radius 
)

Enquire if the specified record exists without modifying.

its accessed status

Definition at line 359 of file CollisionRecordList.C.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

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 379 of file CollisionRecordList.C.

References DynamicList< T, SizeInc, SizeMult, SizeDiv >::append(), and forAll.

Here is the call graph for this function:

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

Definition at line 419 of file CollisionRecordList.C.

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

Here is the call graph for this function:

Friends And Related Function Documentation

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

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