Classes | Public Member Functions | Static Public Member Functions | Protected Attributes | Friends | List of all members
CollidingParcel< ParcelType > Class Template Reference

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

Inheritance diagram for CollidingParcel< ParcelType >:
Inheritance graph
[legend]
Collaboration diagram for CollidingParcel< ParcelType >:
Collaboration graph
[legend]

Classes

class  constantProperties
 Class to hold thermo particle constant properties. More...
 
class  iNew
 Factory class to read-construct particles used for. More...
 

Public Member Functions

 TypeName ("CollidingParcel")
 Runtime type information. More...
 
 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 vector &position, const label cellI, const label tetFaceI, const label tetPtI)
 Construct from owner, position, and cloud owner. More...
 
 CollidingParcel (const polyMesh &mesh, const vector &position, const label cellI, const label tetFaceI, const label tetPtI, const label typeId, const scalar nParticle0, const scalar d0, const scalar dTarget0, const vector &U0, const vector &f0, const vector &angularMomentum0, const vector &torque0, const typename ParcelType::constantProperties &constProps)
 Construct from components. More...
 
 CollidingParcel (const polyMesh &mesh, Istream &is, bool readFields=true)
 Construct from Istream. More...
 
 CollidingParcel (const CollidingParcel &p)
 Construct as a copy. More...
 
 CollidingParcel (const CollidingParcel &p, const polyMesh &mesh)
 Construct as a copy. More...
 
virtual autoPtr< particleclone () const
 Construct and return a (basic particle) clone. More...
 
virtual autoPtr< particleclone (const polyMesh &mesh) const
 Construct and return a (basic particle) clone. More...
 
const vectorf () const
 Return const access to force. More...
 
const vectorangularMomentum () const
 Return const access to angular momentum. More...
 
const vectortorque () const
 Return const access to torque. More...
 
const collisionRecordListcollisionRecords () const
 Return const access to the collision records. More...
 
vectorf ()
 Return access to force. More...
 
vectorangularMomentum ()
 Return access to angular momentum. More...
 
vectortorque ()
 Return access to torque. More...
 
collisionRecordListcollisionRecords ()
 Return access to collision records. More...
 
vector omega () const
 Particle angular velocity. More...
 
template<class TrackData >
bool move (TrackData &td, const scalar trackTime)
 Move the parcel. More...
 
virtual void transformProperties (const tensor &T)
 Transform the physical properties of the particle. More...
 
virtual void transformProperties (const vector &separation)
 Transform the physical properties of the particle. More...
 

Static Public Member Functions

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

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

Detailed Description

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

Wrapper around kinematic parcel types to add collision modelling.

Source files

Definition at line 54 of file CollidingParcel.H.

Constructor & Destructor Documentation

CollidingParcel ( const polyMesh mesh,
const vector position,
const label  cellI,
const label  tetFaceI,
const label  tetPtI 
)
inline

Construct from owner, position, and cloud owner.

Other properties initialised as null

Definition at line 64 of file CollidingParcelI.H.

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

Here is the caller graph for this function:

CollidingParcel ( const polyMesh mesh,
const vector position,
const label  cellI,
const label  tetFaceI,
const label  tetPtI,
const label  typeId,
const scalar  nParticle0,
const scalar  d0,
const scalar  dTarget0,
const vector U0,
const vector f0,
const vector angularMomentum0,
const vector torque0,
const typename ParcelType::constantProperties &  constProps 
)
inline

Construct from components.

Definition at line 82 of file CollidingParcelI.H.

CollidingParcel ( const polyMesh mesh,
Istream is,
bool  readFields = true 
)

Construct from Istream.

Definition at line 48 of file CollidingParcelIO.C.

References IOstream::check(), IOstream::format(), and Istream::read().

Here is the call graph for this function:

CollidingParcel ( const CollidingParcel< ParcelType > &  p)

Construct as a copy.

CollidingParcel ( const CollidingParcel< ParcelType > &  p,
const polyMesh mesh 
)

Construct as a copy.

Member Function Documentation

TypeName ( "CollidingParcel< ParcelType >"  )

Runtime type information.

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

String representation of properties.

virtual autoPtr<particle> clone ( ) const
inlinevirtual

Construct and return a (basic particle) clone.

Definition at line 210 of file CollidingParcel.H.

References CollidingParcel< ParcelType >::CollidingParcel().

Here is the call graph for this function:

virtual autoPtr<particle> clone ( const polyMesh mesh) const
inlinevirtual

Construct and return a (basic particle) clone.

Definition at line 216 of file CollidingParcel.H.

References CollidingParcel< ParcelType >::CollidingParcel().

Here is the call graph for this function:

const Foam::vector & f ( ) const
inline

Return const access to force.

Definition at line 141 of file CollidingParcelI.H.

References CollidingParcel< ParcelType >::f_.

Referenced by CollidingParcel< ParcelType >::iNew::operator()(), and CollidingParcel< ParcelType >::writeFields().

Here is the caller graph for this function:

const Foam::vector & angularMomentum ( ) const
inline

Return const access to angular momentum.

Definition at line 149 of file CollidingParcelI.H.

References CollidingParcel< ParcelType >::angularMomentum_.

Referenced by CollidingParcel< ParcelType >::iNew::operator()(), and CollidingParcel< ParcelType >::writeFields().

Here is the caller graph for this function:

const Foam::vector & torque ( ) const
inline

Return const access to torque.

Definition at line 156 of file CollidingParcelI.H.

References CollidingParcel< ParcelType >::torque_.

Referenced by CollidingParcel< ParcelType >::iNew::operator()(), and CollidingParcel< ParcelType >::writeFields().

Here is the caller graph for this function:

const Foam::collisionRecordList & collisionRecords ( ) const
inline

Return const access to the collision records.

Definition at line 164 of file CollidingParcelI.H.

References CollidingParcel< ParcelType >::collisionRecords_.

Referenced by CollidingParcel< ParcelType >::iNew::operator()(), and CollidingParcel< ParcelType >::writeFields().

Here is the caller graph for this function:

Foam::vector & f ( )
inline

Return access to force.

Definition at line 171 of file CollidingParcelI.H.

References CollidingParcel< ParcelType >::f_.

Foam::vector & angularMomentum ( )
inline

Return access to angular momentum.

Definition at line 178 of file CollidingParcelI.H.

References CollidingParcel< ParcelType >::angularMomentum_.

Foam::vector & torque ( )
inline

Return access to torque.

Definition at line 185 of file CollidingParcelI.H.

References CollidingParcel< ParcelType >::torque_.

Foam::collisionRecordList & collisionRecords ( )
inline

Return access to collision records.

Definition at line 193 of file CollidingParcelI.H.

References CollidingParcel< ParcelType >::collisionRecords_.

Foam::vector omega ( ) const
inline

Particle angular velocity.

Definition at line 200 of file CollidingParcelI.H.

References CollidingParcel< ParcelType >::angularMomentum_.

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

Here is the caller graph for this function:

bool move ( TrackData &  td,
const scalar  trackTime 
)

Move the parcel.

Definition at line 64 of file CollidingParcel.C.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

void transformProperties ( const tensor T)
virtual

Transform the physical properties of the particle.

according to the given transformation tensor

Definition at line 117 of file CollidingParcel.C.

References Foam::transform().

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

Here is the call graph for this function:

Here is the caller graph for this function:

void transformProperties ( const vector separation)
virtual

Transform the physical properties of the particle.

according to the given separation vector

Definition at line 131 of file CollidingParcel.C.

void readFields ( CloudType c)
static
void writeFields ( const CloudType c)
static

Friends And Related Function Documentation

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

Member Data Documentation

vector f_
protected

Force on particle due to collisions [N].

Definition at line 126 of file CollidingParcel.H.

Referenced by CollidingParcel< ParcelType >::f(), and CollidingParcel< ParcelType >::readFields().

vector angularMomentum_
protected

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

Definition at line 129 of file CollidingParcel.H.

Referenced by CollidingParcel< ParcelType >::angularMomentum(), CollidingParcel< ParcelType >::omega(), and CollidingParcel< ParcelType >::readFields().

vector torque_
protected

Torque on particle due to collisions in global.

reference frame [Nm]

Definition at line 133 of file CollidingParcel.H.

Referenced by CollidingParcel< ParcelType >::readFields(), and CollidingParcel< ParcelType >::torque().

collisionRecordList collisionRecords_
protected

Particle collision records.

Definition at line 136 of file CollidingParcel.H.

Referenced by CollidingParcel< ParcelType >::collisionRecords(), and CollidingParcel< ParcelType >::readFields().


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