CollidingParcel< ParcelType > Class Template Reference

Wrapper around parcel types to add collision modelling. More...

Inheritance diagram for CollidingParcel< ParcelType >:
Collaboration diagram for CollidingParcel< ParcelType >:

Classes

class  constantProperties
 Class to hold thermo particle constant properties. More...
 
class  trackingData
 Class to hold temporary data during tracking. More...
 

Public Member Functions

 AddToPropertyList (ParcelType, " (fx fy fz)"+" (angularMomentumx angularMomentumy angularMomentumz)"+" (torquex torquey torquez)"+" collisionRecordsPairAccessed"+" collisionRecordsPairOrigProcOfOther"+" collisionRecordsPairOrigIdOfOther"+" (collisionRecordsPairData)"+" collisionRecordsWallAccessed"+" collisionRecordsWallPRel"+" (collisionRecordsWallData)")
 String representation of properties. More...
 
 CollidingParcel (const polyMesh &mesh, const barycentric &coordinates, const label celli, const label tetFacei, const label tetPti, const label facei)
 Construct from mesh, coordinates and topology. More...
 
 CollidingParcel (const polyMesh &mesh, const vector &position, const label celli, label &nLocateBoundaryHits)
 Construct from a position and a cell, searching for the rest of the. More...
 
 CollidingParcel (Istream &is, bool readFields=true)
 Construct from Istream. More...
 
 CollidingParcel (const CollidingParcel &p)
 Construct as a copy. More...
 
virtual autoPtr< particle > clone () const
 Construct and return a clone. More...
 
const vector & f () const
 Return const access to force. More...
 
const vector & angularMomentum () const
 Return const access to angular momentum. More...
 
const vector & torque () const
 Return const access to torque. More...
 
const collisionRecordList & collisionRecords () const
 Return const access to the collision records. More...
 
vector & f ()
 Return access to force. More...
 
vector & angularMomentum ()
 Return access to angular momentum. More...
 
vector & torque ()
 Return access to torque. More...
 
collisionRecordList & collisionRecords ()
 Return access to collision records. More...
 
vector omega () const
 Particle angular velocity. More...
 
template<class TrackCloudType >
bool move (TrackCloudType &cloud, trackingData &td)
 Move the parcel. More...
 
virtual void transformProperties (const transformer &)
 Transform the physical properties of the particle. More...
 

Static Public Member Functions

static autoPtr< CollidingParcel > New (Istream &is)
 Construct from Istream and return. More...
 
template<class CloudType >
static void readFields (CloudType &c)
 Read. More...
 
template<class CloudType >
static void writeFields (const CloudType &c)
 Write. More...
 

Protected Attributes

vector f_
 Force on particle due to collisions [N]. More...
 
vector angularMomentum_
 Angular momentum of Parcel in global reference frame [kg m2/s]. More...
 
vector torque_
 Torque on particle due to collisions in global. More...
 
collisionRecordList collisionRecords_
 Particle collision records. More...
 

Friends

Ostream & operator (Ostream &, const CollidingParcel< ParcelType > &)
 

Detailed Description

template<class ParcelType>
class Foam::CollidingParcel< ParcelType >

Wrapper around parcel types to add collision modelling.

Source files

Definition at line 78 of file CollidingParcel.H.

Constructor & Destructor Documentation

◆ CollidingParcel() [1/4]

CollidingParcel ( const polyMesh &  mesh,
const barycentric &  coordinates,
const label  celli,
const label  tetFacei,
const label  tetPti,
const label  facei 
)
inline

Construct from mesh, coordinates and topology.

Other properties initialised as null

Definition at line 63 of file CollidingParcelI.H.

Referenced by CollidingParcel< ParcelType >::clone(), and CollidingParcel< ParcelType >::New().

Here is the caller graph for this function:

◆ CollidingParcel() [2/4]

CollidingParcel ( const polyMesh &  mesh,
const vector &  position,
const label  celli,
label &  nLocateBoundaryHits 
)
inline

Construct from a position and a cell, searching for the rest of the.

required topology. Other properties are initialised as null.

Definition at line 82 of file CollidingParcelI.H.

◆ CollidingParcel() [3/4]

◆ CollidingParcel() [4/4]

CollidingParcel ( const CollidingParcel< ParcelType > &  p)

Construct as a copy.

Member Function Documentation

◆ AddToPropertyList()

AddToPropertyList ( ParcelType  ,
" (fx fy fz)"+" (angularMomentumx angularMomentumy angularMomentumz)"+" (torquex torquey torquez)"+" collisionRecordsPairAccessed"+" collisionRecordsPairOrigProcOfOther"+" collisionRecordsPairOrigIdOfOther"+" (collisionRecordsPairData)"+" collisionRecordsWallAccessed"+" collisionRecordsWallPRel"+" (collisionRecordsWallData)"   
)

String representation of properties.

◆ clone()

virtual autoPtr<particle> clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 242 of file CollidingParcel.H.

References CollidingParcel< ParcelType >::CollidingParcel().

Here is the call graph for this function:

◆ New()

static autoPtr<CollidingParcel> New ( Istream &  is)
inlinestatic

Construct from Istream and return.

Definition at line 248 of file CollidingParcel.H.

References CollidingParcel< ParcelType >::CollidingParcel().

Here is the call graph for this function:

◆ f() [1/2]

const Foam::vector & f
inline

Return const access to force.

Definition at line 119 of file CollidingParcelI.H.

◆ angularMomentum() [1/2]

const Foam::vector & angularMomentum
inline

Return const access to angular momentum.

Definition at line 127 of file CollidingParcelI.H.

◆ torque() [1/2]

const Foam::vector & torque
inline

Return const access to torque.

Definition at line 134 of file CollidingParcelI.H.

◆ collisionRecords() [1/2]

const Foam::collisionRecordList & collisionRecords
inline

Return const access to the collision records.

Definition at line 142 of file CollidingParcelI.H.

◆ f() [2/2]

Foam::vector & f
inline

Return access to force.

Definition at line 149 of file CollidingParcelI.H.

◆ angularMomentum() [2/2]

Foam::vector & angularMomentum
inline

Return access to angular momentum.

Definition at line 156 of file CollidingParcelI.H.

◆ torque() [2/2]

Foam::vector & torque
inline

Return access to torque.

Definition at line 163 of file CollidingParcelI.H.

◆ collisionRecords() [2/2]

Foam::collisionRecordList & collisionRecords
inline

Return access to collision records.

Definition at line 171 of file CollidingParcelI.H.

◆ omega()

Particle angular velocity.

Definition at line 178 of file CollidingParcelI.H.

◆ move()

bool move ( TrackCloudType &  cloud,
trackingData &  td 
)

Move the parcel.

Definition at line 48 of file CollidingParcel.C.

References Pair< Type >::first(), NotImplemented, p, CollidingParcel< ParcelType >::trackingData::part(), and Pair< Type >::second().

Here is the call graph for this function:

◆ transformProperties()

void transformProperties ( const transformer &  transform)
virtual

Transform the physical properties of the particle.

according to the given transformation tensor

Definition at line 96 of file CollidingParcel.C.

References Foam::transform(), and dimensionSet::transform.

Here is the call graph for this function:

◆ readFields()

void readFields ( CloudType &  c)
static

Read.

Definition at line 82 of file CollidingParcelIO.C.

References Foam::constant::universal::c, f(), forAllIter, IOobject::MUST_READ, p, Foam::readFields(), and Foam::vtkWriteOps::write().

Referenced by CollidingParcel< ParcelType >::CollidingParcel().

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

◆ writeFields()

void writeFields ( const CloudType &  c)
static

Write.

Definition at line 190 of file CollidingParcelIO.C.

References Foam::constant::universal::c, f(), forAllConstIter, IOobject::NO_READ, p, regIOobject::write(), and Foam::vtkWriteOps::write().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator

Ostream& operator ( Ostream &  ,
const CollidingParcel< ParcelType > &   
)
friend

Member Data Documentation

◆ f_

vector f_
protected

Force on particle due to collisions [N].

Definition at line 177 of file CollidingParcel.H.

Referenced by CollidingParcel< ParcelType >::CollidingParcel().

◆ angularMomentum_

vector angularMomentum_
protected

Angular momentum of Parcel in global reference frame [kg m2/s].

Definition at line 180 of file CollidingParcel.H.

Referenced by CollidingParcel< ParcelType >::CollidingParcel().

◆ torque_

vector torque_
protected

Torque on particle due to collisions in global.

reference frame [Nm]

Definition at line 184 of file CollidingParcel.H.

Referenced by CollidingParcel< ParcelType >::CollidingParcel().

◆ collisionRecords_

collisionRecordList collisionRecords_
protected

Particle collision records.

Definition at line 187 of file CollidingParcel.H.

Referenced by CollidingParcel< ParcelType >::CollidingParcel().


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