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

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

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

Classes

class  iNew
 Factory class to read-construct particles used for. More...
 
class  TrackingData
 

Public Member Functions

 TypeName ("MPPICParcel")
 Runtime type information. More...
 
 AddToPropertyList (ParcelType,"(UCorrectx UCorrecty UCorrectz)")
 String representation of properties. More...
 
 MPPICParcel (const polyMesh &mesh, const vector &position, const label cellI, const label tetFaceI, const label tetPtI)
 Construct from owner, position, and cloud owner. More...
 
 MPPICParcel (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 &UCorrect0, const typename ParcelType::constantProperties &constProps)
 Construct from components. More...
 
 MPPICParcel (const polyMesh &mesh, Istream &is, bool readFields=true)
 Construct from Istream. More...
 
 MPPICParcel (const MPPICParcel &p)
 Construct as a copy. More...
 
 MPPICParcel (const MPPICParcel &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 vectorUCorrect () const
 Return const access to correction velocity. More...
 
vectorUCorrect ()
 Return access to correction velocity. More...
 
template<class TrackData >
bool move (TrackData &td, const scalar trackTime)
 Move the parcel. 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 UCorrect_
 Velocity correction due to collisions [m/s]. More...
 

Friends

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

Detailed Description

template<class ParcelType>
class Foam::MPPICParcel< ParcelType >

Wrapper around kinematic parcel types to add MPPIC modelling.

Source files

Definition at line 52 of file MPPICParcel.H.

Constructor & Destructor Documentation

MPPICParcel ( 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 30 of file MPPICParcelI.H.

Referenced by MPPICParcel< ParcelType >::clone().

Here is the caller graph for this function:

MPPICParcel ( 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 UCorrect0,
const typename ParcelType::constantProperties &  constProps 
)
inline

Construct from components.

Definition at line 45 of file MPPICParcelI.H.

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

Construct from Istream.

Definition at line 47 of file MPPICParcelIO.C.

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

Here is the call graph for this function:

MPPICParcel ( const MPPICParcel< ParcelType > &  p)

Construct as a copy.

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

Construct as a copy.

Member Function Documentation

TypeName ( "MPPICParcel< ParcelType >"  )

Runtime type information.

AddToPropertyList ( ParcelType  ,
"(UCorrectx UCorrecty UCorrectz)"   
)

String representation of properties.

virtual autoPtr<particle> clone ( ) const
inlinevirtual

Construct and return a (basic particle) clone.

Definition at line 226 of file MPPICParcel.H.

References MPPICParcel< ParcelType >::MPPICParcel().

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 232 of file MPPICParcel.H.

References MPPICParcel< ParcelType >::MPPICParcel().

Here is the call graph for this function:

const Foam::vector & UCorrect ( ) const
inline

Return const access to correction velocity.

Definition at line 81 of file MPPICParcelI.H.

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

Here is the caller graph for this function:

Foam::vector & UCorrect ( )
inline

Return access to correction velocity.

Definition at line 88 of file MPPICParcelI.H.

bool move ( TrackData &  td,
const scalar  trackTime 
)

Move the parcel.

Definition at line 58 of file MPPICParcel.C.

References f(), p, and KinematicParcel< ParcelType >::U().

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

Here is the call graph for this function:

Here is the caller graph for this function:

void readFields ( CloudType c)
static

Read.

Definition at line 78 of file MPPICParcelIO.C.

References Cloud< ParticleType >::checkFieldIOobject(), Cloud< ParticleType >::fieldIOobject(), forAllIter, p, Foam::readFields(), Cloud< ParticleType >::size(), and MPPICParcel< ParcelType >::UCorrect_.

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

Here is the call graph for this function:

Here is the caller graph for this function:

void writeFields ( const CloudType c)
static

Write.

Definition at line 105 of file MPPICParcelIO.C.

References Cloud< ParticleType >::fieldIOobject(), forAllConstIter(), p, Cloud< ParticleType >::size(), MPPICParcel< ParcelType >::UCorrect(), and regIOobject::write().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

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

Member Data Documentation

vector UCorrect_
protected

Velocity correction due to collisions [m/s].

Definition at line 163 of file MPPICParcel.H.

Referenced by MPPICParcel< ParcelType >::readFields().


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