OpenFOAM logo
Open Source CFD Toolkit

Cloud Class Template Reference

Inheritance diagram for Cloud:

Inheritance graph
[legend]
Collaboration diagram for Cloud:

Collaboration graph
[legend]
List of all members.

template<class particleType>
class Foam::Cloud< particleType >


Public Types

typedef IDLList< particleType
>::iterator 
iterator
typedef IDLList< particleType
>::const_iterator 
const_iterator

Public Member Functions

 Cloud (const polyMesh &mesh, const IDLList< particleType > &particles)
 Construct from mesh and a list of particles.
 Cloud (const polyMesh &mesh)
 Construct from mesh by reading from file.
const polyMeshpMesh () const
 Return the polyMesh reference.
bool internalFace (const label facei) const
 Is this global face an internal face?
bool boundaryFace (const label facei) const
 Is this global face a boundary face?
label facePatch (const label facei) const
 Which patch is this global face on.
label patchFace (const label patchi, const label facei) const
 Which face of this patch is this global face.
void addParticle (particleType *pPtr)
 Transfer particle to cloud.
void deleteParticle (particleType &)
 Remove particle from cloud and delete.
template<class TrackingData>
void track (TrackingData &td)
 Track the particles.
virtual void autoMap (const mapPolyMesh &)
 Remap the cells of particles corresponding to the.
IOobject fieldIOobject (const word &fieldName) const
 Read and return a lagrangian data field.
template<class Type>
tmp< IOField< Type > > readField (const word &fieldName) const
 Read and return a lagrangian data field.
void readFields ()
 Read the field data for the cloud of particles.
virtual bool writeData (Ostream &) const
 Pure virtual writaData function.
virtual void writeFields () const
 Write the field data for the cloud of particles.

Friends

class particle
Ostreamoperator (Ostream &, const Cloud< particleType > &)

Member Typedef Documentation

typedef IDLList<particleType>::const_iterator const_iterator
 

Reimplemented from UILList< DLListBase, particleType >.

Definition at line 95 of file Cloud.H.

typedef IDLList<particleType>::iterator iterator
 

Reimplemented from UILList< DLListBase, particleType >.

Definition at line 94 of file Cloud.H.


Constructor & Destructor Documentation

Cloud const polyMesh mesh,
const IDLList< particleType > &  particles
 

Construct from mesh and a list of particles.

Cloud const polyMesh mesh  ) 
 

Construct from mesh by reading from file.


Member Function Documentation

void addParticle particleType *  pPtr  ) 
 

Transfer particle to cloud.

virtual void autoMap const mapPolyMesh  )  [virtual]
 

Remap the cells of particles corresponding to the.

mesh topology change

Implements cloud.

bool boundaryFace const label  facei  )  const [inline]
 

Is this global face a boundary face?

Definition at line 131 of file Cloud.H.

void deleteParticle particleType &   ) 
 

Remove particle from cloud and delete.

label facePatch const label  facei  )  const [inline]
 

Which patch is this global face on.

Definition at line 137 of file Cloud.H.

IOobject fieldIOobject const word fieldName  )  const
 

Read and return a lagrangian data field.

bool internalFace const label  facei  )  const [inline]
 

Is this global face an internal face?

Definition at line 125 of file Cloud.H.

label patchFace const label  patchi,
const label  facei
const [inline]
 

Which face of this patch is this global face.

Definition at line 143 of file Cloud.H.

const polyMesh& pMesh  )  const [inline]
 

Return the polyMesh reference.

Definition at line 119 of file Cloud.H.

tmp<IOField<Type> > readField const word fieldName  )  const
 

Read and return a lagrangian data field.

void readFields  ) 
 

Read the field data for the cloud of particles.

void track TrackingData &  td  ) 
 

Track the particles.

virtual bool writeData Ostream  )  const [virtual]
 

Pure virtual writaData function.

Must be defined in derived types

Implements regIOobject.

virtual void writeFields  )  const [virtual]
 

Write the field data for the cloud of particles.


Friends And Related Function Documentation

Ostream& operator Ostream ,
const Cloud< particleType > & 
[friend]
 

friend class particle [friend]
 

Definition at line 92 of file Cloud.H.


The documentation for this class was generated from the following file:
For further information go to www.openfoam.org