FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

Cloud< ParticleType > Class Template Reference

#include <lagrangian/Cloud.H>


Detailed Description

template<class ParticleType>
class Foam::Cloud< ParticleType >

Source files

Definition at line 68 of file Cloud.H.

Inheritance diagram for Cloud< ParticleType >:
Collaboration diagram for Cloud< ParticleType >:

List of all members.

Public Types

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

Public Member Functions

 TypeName ("Cloud")
 Runtime type information.
 Cloud (const polyMesh &mesh, const IDLList< ParticleType > &particles)
 Construct from mesh and a list of particles.
 Cloud (const polyMesh &mesh, const word &cloudName, const IDLList< ParticleType > &particles)
 Construct from mesh, cloud name, and a list of particles.
 Cloud (const polyMesh &mesh, const bool checkClass=true)
 Construct from mesh by reading from file.
 Cloud (const polyMesh &pMesh, const word &cloudName, const bool checkClass=true)
 Construct from mesh by reading from file with given cloud instance.
const polyMesh &  pMesh () 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.
label  size () const
 Return number of elements in table.
const const_iterator  begin () const
 const_iterator set to the beginning of the HashTable
const const_iterator  cbegin () const
 const_iterator set to the beginning of the HashTable
const const_iterator  end () const
 const_iterator set to beyond the end of the HashTable
const const_iterator  cend () const
 const_iterator set to beyond the end of the HashTable
iterator  begin ()
 iterator set to the begining of the HashTable
iterator  end ()
 iterator set to beyond the end of the HashTable
void  clear ()
 Clear the contents of the list.
label  getNewParticleID () const
 Get unique particle creation id.
void  addParticle (ParticleType *pPtr)
 Transfer particle to cloud.
void  deleteParticle (ParticleType &)
 Remove particle from cloud and delete.
template<class TrackingData >
void  move (TrackingData &td)
 Move the particles.
virtual void  autoMap (const mapPolyMesh &)
 Remap the cells of particles corresponding to the.
IOobject  fieldIOobject (const word &fieldName, const IOobject::readOption r) const
 Helper to construct IOobject for field and current time.
template<class DataType >
void  checkFieldIOobject (const Cloud< ParticleType > &c, const IOField< DataType > &data) const
 Check lagrangian data field.
virtual void  readFields ()
 Read the field data for the cloud of particles. Dummy at.
virtual void  writeFields () const
 Write the field data for the cloud of particles Dummy at.
virtual bool  writeObject (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::compressionType cmp) const
 Write using given format, version and compression.
void  writePositions () const
 Write positions to <cloudName>_positions.obj file.

Static Public Attributes

static word  cloudPropertiesName
 Name of cloud properties dictionary.

Friends

class  Particle
class  IOPosition
Ostream &  operator (Ostream &, const Cloud< ParticleType > &)

Member Typedef Documentation

typedef ParticleType particleType

Definition at line 103 of file Cloud.H.

typedef IDLList<ParticleType>::iterator iterator

Reimplemented from HashTable< regIOobject * >.

Definition at line 105 of file Cloud.H.

typedef IDLList<ParticleType>::const_iterator const_iterator

Reimplemented from HashTable< regIOobject * >.

Definition at line 106 of file Cloud.H.


Constructor & Destructor Documentation

Cloud ( const polyMesh &   mesh,
const IDLList< ParticleType > &   particles  
)

Construct from mesh and a list of particles.

Definition at line 38 of file Cloud.C.

Cloud ( const polyMesh &   mesh,
const word &   cloudName,
const IDLList< ParticleType > &   particles  
)

Construct from mesh, cloud name, and a list of particles.

Definition at line 54 of file Cloud.C.

Cloud ( const polyMesh &   mesh,
const bool   checkClass = true  
)

Construct from mesh by reading from file.

Optionally disable checking of class name for post-processing

Definition at line 140 of file CloudIO.C.

Cloud ( const polyMesh &   pMesh,
const word &   cloudName,
const bool   checkClass = true  
)

Construct from mesh by reading from file with given cloud instance.

Optionally disable checking of class name for post-processing

Definition at line 155 of file CloudIO.C.


Member Function Documentation

TypeName ( "Cloud< ParticleType >"    )

Runtime type information.

const polyMesh& pMesh (  ) const [inline]

Return the polyMesh reference.

Definition at line 159 of file Cloud.H.

Referenced by KinematicParcel< ParcelType >::massCell(), solidParticle::move(), parcel::move(), and trackedParticle::move().

bool internalFace ( const label   facei  ) const [inline]

Is this global face an internal face?

Definition at line 165 of file Cloud.H.

Referenced by Cloud< BasicReactingParcel< ThermoType > >::boundaryFace().

bool boundaryFace ( const label   facei  ) const [inline]

Is this global face a boundary face?

Definition at line 171 of file Cloud.H.

label facePatch ( const label   facei  ) const [inline]

Which patch is this global face on.

Definition at line 177 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 183 of file Cloud.H.

const const_iterator cbegin (  ) const [inline]

const_iterator set to the beginning of the HashTable

Reimplemented from HashTable< regIOobject * >.

Definition at line 201 of file Cloud.H.

Referenced by Cloud< BasicReactingParcel< ThermoType > >::cbegin().

const const_iterator cend (  ) const [inline]

const_iterator set to beyond the end of the HashTable

Reimplemented from HashTable< regIOobject * >.

Definition at line 211 of file Cloud.H.

Referenced by Cloud< BasicReactingParcel< ThermoType > >::cend().

iterator begin (  ) [inline]

iterator set to the begining of the HashTable

Reimplemented from HashTable< regIOobject * >.

Definition at line 216 of file Cloud.H.

iterator end (  ) [inline]

iterator set to beyond the end of the HashTable

Reimplemented from HashTable< regIOobject * >.

Definition at line 221 of file Cloud.H.

void clear (  ) [inline]

Clear the contents of the list.

Reimplemented from ILList< DLListBase, ParticleType >.

Reimplemented in DsmcCloud< ParcelType >.

Definition at line 229 of file Cloud.H.

Referenced by Cloud< BasicReactingParcel< ThermoType > >::clear().

Foam::label getNewParticleID (  ) const

Get unique particle creation id.

Definition at line 72 of file Cloud.C.

References Foam::endl(), and WarningIn.

void addParticle ( ParticleType *   pPtr  )

Transfer particle to cloud.

Definition at line 87 of file Cloud.C.

References append().

void deleteParticle ( ParticleType &   p  )

Remove particle from cloud and delete.

Definition at line 94 of file Cloud.C.

References p.

Referenced by trajectoryCollisionModel::collideParcels(), and ORourkeCollisionModel::collideParcels().

void autoMap ( const mapPolyMesh &   mapper  ) [virtual]

Remap the cells of particles corresponding to the.

mesh topology change

Implements cloud.

Definition at line 287 of file Cloud.C.

References Foam::endl(), forAllIter, Foam::Info, mapPolyMesh::mergedCell(), name(), p, mapPolyMesh::reverseCellMap(), and mapPolyMesh::reverseFaceMap().

void readFields (  ) [virtual]

Read the field data for the cloud of particles. Dummy at.

this level.

Definition at line 213 of file CloudIO.C.

void writeFields (  ) const [virtual]

Write the field data for the cloud of particles Dummy at.

this level.

Definition at line 218 of file CloudIO.C.

References p.

bool writeObject ( IOstream::streamFormat   fmt,
IOstream::versionNumber   ver,
IOstream::compressionType   cmp  
) const [virtual]

Write using given format, version and compression.

Only writes the cloud file if the Cloud isn't empty

Reimplemented from objectRegistry.

Definition at line 230 of file CloudIO.C.

void writePositions (  ) const

Write positions to <cloudName>_positions.obj file.

Definition at line 333 of file Cloud.C.

References OSstream::flush(), forAllConstIter, name(), Foam::nl, and p.


Friends And Related Function Documentation

friend class Particle [friend]

Definition at line 99 of file Cloud.H.

friend class IOPosition [friend]

Definition at line 101 of file Cloud.H.

Ostream& operator ( Ostream &   ,
const Cloud< ParticleType > &    
) [friend]

Member Data Documentation

Name of cloud properties dictionary.

Definition at line 115 of file Cloud.H.


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