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

Wrapper around 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

 AddToPropertyList (ParcelType, "(UCorrectx UCorrecty UCorrectz)")
 String representation of properties. More...
 
 MPPICParcel (const polyMesh &mesh, const barycentric &coordinates, const label celli, const label tetFacei, const label tetPti)
 Construct from mesh, coordinates and topology. More...
 
 MPPICParcel (const polyMesh &mesh, const vector &position, const label celli)
 Construct from a position and a cell, searching for the rest of the. 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< particle > clone () const
 Construct and return a (basic particle) clone. More...
 
virtual autoPtr< particle > clone (const polyMesh &mesh) const
 Construct and return a (basic particle) clone. More...
 
const vector & UCorrect () const
 Return const access to correction velocity. More...
 
vector & UCorrect ()
 Return access to correction velocity. More...
 
template<class TrackCloudType >
bool move (TrackCloudType &cloud, trackingData &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

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

Detailed Description

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

Wrapper around parcel types to add MPPIC modelling.

Source files

Definition at line 52 of file MPPICParcel.H.

Constructor & Destructor Documentation

◆ MPPICParcel() [1/5]

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

Construct from mesh, coordinates and topology.

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() [2/5]

MPPICParcel ( const polyMesh &  mesh,
const vector &  position,
const label  celli 
)
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 45 of file MPPICParcelI.H.

◆ MPPICParcel() [3/5]

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() [4/5]

MPPICParcel ( const MPPICParcel< ParcelType > &  p)

Construct as a copy.

◆ MPPICParcel() [5/5]

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

Construct as a copy.

Member Function Documentation

◆ AddToPropertyList()

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

String representation of properties.

◆ clone() [1/2]

virtual autoPtr<particle> clone ( ) const
inlinevirtual

Construct and return a (basic particle) clone.

Definition at line 220 of file MPPICParcel.H.

References MPPICParcel< ParcelType >::MPPICParcel().

Here is the call graph for this function:

◆ clone() [2/2]

virtual autoPtr<particle> clone ( const polyMesh &  mesh) 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:

◆ UCorrect() [1/2]

const Foam::vector & UCorrect ( ) const
inline

Return const access to correction velocity.

Definition at line 59 of file MPPICParcelI.H.

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

Here is the caller graph for this function:

◆ UCorrect() [2/2]

Foam::vector & UCorrect ( )
inline

Return access to correction velocity.

Definition at line 66 of file MPPICParcelI.H.

◆ move()

bool move ( TrackCloudType &  cloud,
trackingData &  td,
const scalar  trackTime 
)

Move the parcel.

Definition at line 58 of file MPPICParcel.C.

References f(), p, MPPICParcel< ParcelType >::trackingData::part(), and Foam::Swap().

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

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

◆ readFields()

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:

◆ writeFields()

void writeFields ( const CloudType &  c)
static

Write.

Definition at line 106 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

◆ operator

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

Member Data Documentation

◆ UCorrect_

vector UCorrect_
protected

Velocity correction due to collisions [m/s].

Definition at line 168 of file MPPICParcel.H.

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

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