FreeFOAM The Cross-Platform CFD Toolkit
KinematicCloud< ParcelType > Class Template Reference

Templated base class for kinematic cloud. More...

#include <lagrangianIntermediate/KinematicCloud_.H>


Detailed Description

template<class ParcelType>
class Foam::KinematicCloud< ParcelType >

Templated base class for kinematic cloud.

- Kinematic only

  • Dispersion model
  • Drag model
  • Injection model
  • Wall interaction model
Source files

Definition at line 84 of file KinematicCloud_.H.

+ Inheritance diagram for KinematicCloud< ParcelType >:
+ Collaboration diagram for KinematicCloud< ParcelType >:

List of all members.

Public Types

typedef ParcelType parcelType
 Type of parcel the cloud was instantiated for.
- Public Types inherited from Cloud< ParcelType >
typedef ParcelType particleType
typedef IDLList< ParcelType >
::iterator 
iterator
typedef IDLList< ParcelType >
::const_iterator 
const_iterator

Public Member Functions

 KinematicCloud (const word &cloudName, const volScalarField &rho, const volVectorField &U, const volScalarField &mu, const dimensionedVector &g, bool readFields=true)
 Construct given carrier gas fields.
virtual ~KinematicCloud ()
 Destructor.
const fvMeshmesh () const
 Return refernce to the mesh.
const IOdictionaryparticleProperties () const
 Return particle properties dictionary.
const
ParcelType::constantProperties & 
constProps () const
 Return the constant properties.
const Switch active () const
 Return the active flag.
label parcelTypeId () const
 Return the parcel type id.
const Switch coupled () const
 Return coupled flag.
const Switch cellValueSourceCorrection () const
 Return cell value correction flag.
RandomrndGen ()
 Return refernce to the random object.
const volVectorFieldU () const
 Return carrier gas velocity.
const volScalarFieldrho () const
 Return carrier gas density.
const volScalarFieldmu () const
 Return carrier gas dynamic viscosity.
const dimensionedVectorg () const
 Gravity.
const particleForcesforces () const
 Optional particle forces.
const dictionaryinterpolationSchemes () const
 Return reference to the interpolation dictionary.
const DispersionModel
< KinematicCloud< ParcelType > > & 
dispersion () const
 Return const-access to the dispersion model.
DispersionModel
< KinematicCloud< ParcelType > > & 
dispersion ()
 Return reference to the dispersion model.
const DragModel
< KinematicCloud< ParcelType > > & 
drag () const
 Return const-access to the drag model.
const InjectionModel
< KinematicCloud< ParcelType > > & 
injection () const
 Return const access to the injection model.
InjectionModel< KinematicCloud
< ParcelType > > & 
injection ()
 Return reference to the injection model.
const PatchInteractionModel
< KinematicCloud< ParcelType > > & 
patchInteraction () const
 Return const-access to the patch interaction model.
PostProcessingModel
< KinematicCloud< ParcelType > > & 
postProcessing ()
 Return reference to post-processing model.
const vectorIntegrationSchemeUIntegrator () const
 Return reference to velocity integration.
DimensionedField< vector,
volMesh > & 
UTrans ()
 Return reference to momentum source.
tmp< DimensionedField< vector,
volMesh > > 
SU () const
 Return tmp momentum source term - fully explicit.
scalar massInjected () const
 Total mass injected.
scalar massInSystem () const
 Total mass in system.
void info () const
 Print cloud information.
const tmp< volScalarFieldtheta () const
 Return the particle volume fraction field.
const tmp< volScalarFieldalpha () const
 Return the particle mass fraction field.
const tmp< volScalarFieldrhoEff () const
 Return the particle effective density field.
void checkParcelProperties (ParcelType &parcel, const scalar lagrangianDt, const bool fullyDescribed)
 Check parcel properties.
void resetSourceTerms ()
 Reset the spray source terms.
void evolve ()
 Evolve the spray (inject, inject)
- Public Member Functions inherited from Cloud< ParcelType >
 TypeName ("Cloud")
 Runtime type information.
 Cloud (const polyMesh &mesh, const IDLList< ParcelType > &particles)
 Construct from mesh and a list of particles.
 Cloud (const polyMesh &mesh, const word &cloudName, const IDLList< ParcelType > &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 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.
label size () const
 Return number of elements in table.
const const_iterator begin () const
 const_iterator set to the beginning of the HashTable
iterator begin ()
 iterator set to the begining 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
iterator end ()
 iterator set to beyond the end of the HashTable
const const_iterator cend () const
 const_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 (ParcelType *pPtr)
 Transfer particle to cloud.
void deleteParticle (ParcelType &)
 Remove particle from cloud and delete.
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.
void checkFieldIOobject (const Cloud< ParcelType > &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.
- Public Member Functions inherited from cloud
 TypeName ("cloud")
 Runtime type information.
 cloud (const objectRegistry &, const word &cloudName="")
 Construct for the given objectRegistry and named cloud instance.
virtual ~cloud ()
 Destructor.
- Public Member Functions inherited from objectRegistry
 TypeName ("objectRegistry")
 Declare type name for this IOobject.
 objectRegistry (const Time &db, const label nIoObjects=128)
 Construct the time objectRegistry given an initial estimate.
 objectRegistry (const IOobject &io, const label nIoObjects=128)
 Construct a sub-registry given an IObject to describe the registry.
virtual ~objectRegistry ()
const Timetime () const
 Return time.
const objectRegistryparent () const
 Return the parent objectRegistry.
virtual const fileNamedbDir () const
 Local directory path of this objectRegistry relative to the time.
wordList names () const
 Return the list of names of the IOobjects.
wordList names (const word &className) const
 Return the list of names of the IOobjects of given class name.
template<class Type >
wordList names () const
 Return the list of names of the IOobjects of given type.
const objectRegistrysubRegistry (const word &name) const
 Lookup and return a const sub-objectRegistry.
template<class Type >
HashTable< const Type * > lookupClass () const
 Lookup and return all the object of the given Type.
template<class Type >
bool foundObject (const word &name) const
 Is the named Type.
template<class Type >
const Type & lookupObject (const word &name) const
 Lookup and return the object of the given Type.
label getEvent () const
 Return new event number.
virtual void rename (const word &newName)
 Rename.
bool checkIn (regIOobject &) const
 Add an regIOobject to registry.
bool checkOut (regIOobject &) const
 Remove an regIOobject from registry.
virtual bool modified () const
 Return true if any of the object's files have been modified.
void readModifiedObjects ()
 Read the objects that have been modified.
virtual bool readIfModified ()
 Read object if modified.
virtual bool writeData (Ostream &) const
 writeData function required by regIOobject but not used
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information.
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the.
 regIOobject (const regIOobject &)
 Construct as copy.
 regIOobject (const regIOobject &, bool registerCopy)
 Construct as copy, and transferring registry registration to copy.
virtual ~regIOobject ()
bool checkIn ()
 Add object to registry.
bool checkOut ()
 Remove object from registry.
bool ownedByRegistry () const
 Is this object owned by the registry?
void store ()
 Transfer ownership of this object to its registry.
void release ()
 Release ownership of this object from its registry.
label eventNo () const
 Event number at last update.
label & eventNo ()
 Event number at last update.
bool upToDate (const word &) const
 Am I uptodate with respect to other regIOobjects.
bool upToDate (const word &, const word &) const
bool upToDate (const word &, const word &, const word &) const
bool upToDate (const word &, const word &, const word &, const word &) const
void setUpToDate ()
 Flag me as up to date.
IstreamreadStream (const word &)
 Return Istream and check object type against that given.
void close ()
 Close Istream.
virtual bool readData (Istream &)
 Virtual readData function.
virtual bool read ()
 Read object.
virtual bool write () const
 Write using setting from DB.
void operator= (const IOobject &)
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information.
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, registry, io options.
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, local, registry, io options.
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options.
Foam::autoPtr< IOobjectclone () const
 Clone.
virtual ~IOobject ()
const objectRegistrydb () const
 Return the local objectRegistry.
const wordname () const
 Return name.
const wordheaderClassName () const
 Return name of the class name read from header.
stringnote ()
 Return non-constant access to the optional note.
const stringnote () const
 Return the optional note.
bool registerObject () const
 Register object created from this IOobject with registry if true.
readOption readOpt () const
readOptionreadOpt ()
writeOption writeOpt () const
writeOptionwriteOpt ()
const fileNamerootPath () const
const fileNamecaseName () const
const fileNameinstance () const
fileNameinstance ()
const fileNamelocal () const
fileName path () const
 Return complete path.
fileName path (const word &instance, const fileName &local="") const
 Return complete path with alternative instance and local.
fileName objectPath () const
 Return complete path + object name.
fileName filePath () const
 Return complete path + object name if the file exists.
bool readHeader (Istream &)
 Read header.
bool headerOk ()
 Read and check header info.
bool writeHeader (Ostream &) const
 Write header.
bool good () const
bool bad () const
- Public Member Functions inherited from HashTable< regIOobject * >
bool set (const word &, const regIOobject *&newElmt)
 Assign a new hashedEntry, overwriting existing entries.
 HashTable (const label size=128)
 Construct given initial table size.
 HashTable (Istream &, const label size=128)
 Construct from Istream.
 HashTable (const HashTable< regIOobject *, word, string::hash > &)
 Construct as copy.
 HashTable (const Xfer< HashTable< regIOobject *, word, string::hash > > &)
 Construct by transferring the parameter contents.
 ~HashTable ()
bool empty () const
 Return true if the hash table is empty.
bool found (const word &) const
 Return true if hashedEntry is found in table.
iterator find (const word &)
 Find and return an iterator set at the hashedEntry.
const_iterator find (const word &) const
 Find and return an const_iterator set at the hashedEntry.
List< wordtoc () const
 Return the table of contents.
List< wordsortedToc () const
 Return the table of contents as a sorted list.
OstreamprintInfo (Ostream &) const
 Print information.
bool insert (const word &, const regIOobject *&newElmt)
 Insert a new hashedEntry.
bool erase (const iterator &)
 Erase an hashedEntry specified by given iterator.
bool erase (const word &)
 Erase an hashedEntry specified by given key if in table.
label erase (const UList< word > &)
 Remove entries given by the listed keys from this HashTable.
label erase (const HashTable< AnyType, word, AnyHash > &)
 Remove entries given by the given keys from this HashTable.
void resize (const label newSize)
 Resize the hash table for efficiency.
void clearStorage ()
 Clear the table entries and the table itself.
void transfer (HashTable< regIOobject *, word, string::hash > &)
 Transfer the contents of the argument table into this table.
Xfer< HashTable< regIOobject
*, word, string::hash > > 
xfer ()
 Transfer contents to the Xfer container.
regIOobject *& operator[] (const word &)
 Find and return an hashedEntry.
const regIOobject *& operator[] (const word &) const
 Find and return an hashedEntry.
regIOobject *& operator() (const word &)
 Find and return an hashedEntry, create it null if not present.
void operator= (const HashTable< regIOobject *, word, string::hash > &)
 Assignment.
bool operator== (const HashTable< regIOobject *, word, string::hash > &) const
 Equality. Two hash tables are equal if all contents of first are.
bool operator!= (const HashTable< regIOobject *, word, string::hash > &) const
 The opposite of the equality operation. Takes linear time.
- Public Member Functions inherited from IDLList< ParcelType >
 IDLList ()
 Null construct.
 IDLList (const ParcelType &a)
 Construct given initial T.
 IDLList (Istream &is, const INew &inewt)
 Construct from Istream using given Istream constructor class.
 IDLList (Istream &is)
 Construct from Istream.
 IDLList (const IDLList< ParcelType > &idll, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone.
- Public Member Functions inherited from ILList< DLListBase, ParcelType >
 ILList ()
 Null construct.
 ILList (ParcelType *a)
 Construct given initial T.
 ILList (Istream &)
 Construct from Istream.
 ILList (const ILList< DLListBase, ParcelType > &)
 Construct as copy.
 ILList (const ILList< DLListBase, ParcelType > &lst, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone.
 ILList (Istream &, const INew &)
 Construct from Istream using given Istream constructor class.
 ~ILList ()
bool eraseHead ()
 Remove the head element specified from the list and delete it.
bool erase (ParcelType *p)
 Remove the specified element from the list and delete it.
void transfer (ILList< DLListBase, ParcelType > &)
 Transfer the contents of the argument into this List.
void operator= (const ILList< DLListBase, ParcelType > &)
- Public Member Functions inherited from UILList< DLListBase, ParcelType >
 UILList ()
 Null construct.
 UILList (ParcelType *a)
 Construct given initial T.
 UILList (const UILList< DLListBase, ParcelType > &)
 Construct as copy.
ParcelType * first ()
 Return the first entry.
const ParcelType * first () const
 Return the first entry.
ParcelType * last ()
 Return the last entry.
const ParcelType * last () const
 Return the last entry.
ParcelType * removeHead ()
 Remove and return head.
ParcelType * remove (ParcelType *p)
 Remove and return element.
ParcelType * remove (iterator &it)
 Remove and return specified by iterator.
void operator= (const UILList< DLListBase, ParcelType > &)
bool operator== (const UILList< DLListBase, ParcelType > &) const
 Equality operation on ULists of the same type.
bool operator!= (const UILList< DLListBase, ParcelType > &) const
 The opposite of the equality operation. Takes linear time.
- Public Member Functions inherited from DLListBase
 DLListBase ()
 Null construct.
 DLListBase (link *)
 Construct given initial entry.
 ~DLListBase ()
bool empty () const
 Return true if the list is empty.
void insert (link *)
 Add at head of list.
void append (link *)
 Add at tail of list.
bool swapUp (link *)
 Swap this element with the one above unless it is at the top.
bool swapDown (link *)
 Swap this element with the one below unless it is at the bottom.
linkremove (link *)
 Remove and return element.
linkreplace (link *oldLink, link *newLink)
 Replace oldLink with newLink and return element.
linkreplace (iterator &oldIter, link *newLink)
 Replace oldIter with newLink and return element.
void transfer (DLListBase &)
 Transfer the contents of the argument into this List.
- Public Member Functions inherited from kinematicCloud
 TypeName ("kinematicCloud")
 Runtime type information.
 kinematicCloud ()
 Null constructor.
virtual ~kinematicCloud ()
 Destructor.

Protected Member Functions

void preEvolve ()
 Pre-evolve.
void evolveCloud ()
 Evolve the cloud.
void postEvolve ()
 Post-evolve.

Protected Attributes

const fvMeshmesh_
 References to the mesh and time databases.
IOdictionary particleProperties_
 Dictionary of particle properties.
ParcelType::constantProperties constProps_
 Parcel constant properties.
const Switch active_
 Cloud active flag.
const label parcelTypeId_
 Parcel type id - used to flag the type of parcels issued by this.
const Switch coupled_
 Flag to indicate whether parcels are coupled to the carrier phase.
const Switch cellValueSourceCorrection_
 Flag to correct cell values with latest transfer information.
Random rndGen_
 Random number generator - used by some injection routines.
const volScalarFieldrho_
 Density.
const volVectorFieldU_
 Velocity.
const volScalarFieldmu_
 Dynamic viscosity.
const dimensionedVectorg_
 Gravity.
particleForces forces_
 Optional particle forces.
dictionary interpolationSchemes_
 Interpolation schemes dictionary.
autoPtr< DispersionModel
< KinematicCloud< ParcelType > > > 
dispersionModel_
 Dispersion model.
autoPtr< DragModel
< KinematicCloud< ParcelType > > > 
dragModel_
 Drag transfer model.
autoPtr< InjectionModel
< KinematicCloud< ParcelType > > > 
injectionModel_
 Injector model.
autoPtr< PatchInteractionModel
< KinematicCloud< ParcelType > > > 
patchInteractionModel_
 Patch interaction model.
autoPtr< PostProcessingModel
< KinematicCloud< ParcelType > > > 
postProcessingModel_
 Post-processing model.
autoPtr< vectorIntegrationSchemeUIntegrator_
 Velocity integration.
DimensionedField< vector, volMeshUTrans_
 Momentum.

Additional Inherited Members

- Static Public Attributes inherited from Cloud< ParcelType >
static word cloudPropertiesName
 Name of cloud properties dictionary.
- Static Public Attributes inherited from cloud
static const word prefix
 The prefix to local: lagrangian.
static word defaultName
 The default cloud name: defaultCloud.

Member Typedef Documentation

typedef ParcelType parcelType

Type of parcel the cloud was instantiated for.

Reimplemented in ReactingCloud< ParcelType >, ReactingMultiphaseCloud< ParcelType >, and ThermoCloud< ParcelType >.

Definition at line 222 of file KinematicCloud_.H.


Constructor & Destructor Documentation

KinematicCloud ( const word cloudName,
const volScalarField rho,
const volVectorField U,
const volScalarField mu,
const dimensionedVector g,
bool  readFields = true 
)

Construct given carrier gas fields.

~KinematicCloud ( )
virtual

Destructor.

Definition at line 221 of file KinematicCloud_.C.


Member Function Documentation

void preEvolve ( )
protected
void evolveCloud ( )
protected

Evolve the cloud.

Reimplemented in ReactingCloud< ParcelType >, ReactingMultiphaseCloud< ParcelType >, and ThermoCloud< ParcelType >.

Definition at line 47 of file KinematicCloud_.C.

void postEvolve ( )
protected
const Foam::fvMesh & mesh ( ) const
inline

Return refernce to the mesh.

Definition at line 38 of file KinematicCloudI_.H.

const Foam::IOdictionary & particleProperties ( ) const
inline

Return particle properties dictionary.

Definition at line 46 of file KinematicCloudI_.H.

const ParcelType::constantProperties & constProps ( ) const
inline

Return the constant properties.

Reimplemented in ReactingCloud< ParcelType >, ReactingMultiphaseCloud< ParcelType >, and ThermoCloud< ParcelType >.

Definition at line 54 of file KinematicCloudI_.H.

const Foam::Switch active ( ) const
inline

Return the active flag.

Definition at line 61 of file KinematicCloudI_.H.

Foam::label parcelTypeId ( ) const
inline

Return the parcel type id.

Definition at line 31 of file KinematicCloudI_.H.

const Foam::Switch coupled ( ) const
inline

Return coupled flag.

Definition at line 68 of file KinematicCloudI_.H.

const Foam::Switch cellValueSourceCorrection ( ) const
inline

Return cell value correction flag.

Definition at line 76 of file KinematicCloudI_.H.

Foam::Random & rndGen ( )
inline

Return refernce to the random object.

Definition at line 207 of file KinematicCloudI_.H.

const Foam::volVectorField & U ( ) const
inline

Return carrier gas velocity.

Definition at line 91 of file KinematicCloudI_.H.

const Foam::volScalarField & rho ( ) const
inline

Return carrier gas density.

Definition at line 84 of file KinematicCloudI_.H.

Referenced by KinematicCloud< ParcelType >::checkParcelProperties().

const Foam::volScalarField & mu ( ) const
inline

Return carrier gas dynamic viscosity.

Definition at line 98 of file KinematicCloudI_.H.

const Foam::dimensionedVector & g ( ) const
inline

Gravity.

Definition at line 106 of file KinematicCloudI_.H.

const Foam::particleForces & forces ( ) const
inline

Optional particle forces.

Definition at line 114 of file KinematicCloudI_.H.

const Foam::dictionary & interpolationSchemes ( ) const
inline

Return reference to the interpolation dictionary.

Definition at line 122 of file KinematicCloudI_.H.

const Foam::DispersionModel< Foam::KinematicCloud< ParcelType > > & dispersion ( ) const
inline

Return const-access to the dispersion model.

Definition at line 130 of file KinematicCloudI_.H.

Foam::DispersionModel< Foam::KinematicCloud< ParcelType > > & dispersion ( )
inline

Return reference to the dispersion model.

Definition at line 138 of file KinematicCloudI_.H.

const Foam::DragModel< Foam::KinematicCloud< ParcelType > > & drag ( ) const
inline

Return const-access to the drag model.

Definition at line 146 of file KinematicCloudI_.H.

const Foam::InjectionModel< Foam::KinematicCloud< ParcelType > > & injection ( ) const
inline

Return const access to the injection model.

Definition at line 154 of file KinematicCloudI_.H.

Foam::InjectionModel< Foam::KinematicCloud< ParcelType > > & injection ( )
inline

Return reference to the injection model.

Definition at line 170 of file KinematicCloudI_.H.

const Foam::PatchInteractionModel< Foam::KinematicCloud< ParcelType > > & patchInteraction ( ) const
inline

Return const-access to the patch interaction model.

Definition at line 162 of file KinematicCloudI_.H.

Foam::PostProcessingModel< Foam::KinematicCloud< ParcelType > > & postProcessing ( )
inline

Return reference to post-processing model.

Definition at line 178 of file KinematicCloudI_.H.

const Foam::vectorIntegrationScheme & UIntegrator ( ) const
inline

Return reference to velocity integration.

Definition at line 186 of file KinematicCloudI_.H.

Return reference to momentum source.

Definition at line 215 of file KinematicCloudI_.H.

Return tmp momentum source term - fully explicit.

Definition at line 223 of file KinematicCloudI_.H.

References Foam::dimDensity, Foam::dimTime, Foam::dimVelocity, mesh, name(), and timeName.

scalar massInjected ( ) const
inline

Total mass injected.

Foam::scalar massInSystem ( ) const
inline

Total mass in system.

Definition at line 193 of file KinematicCloudI_.H.

References forAllConstIter, and p.

void info ( ) const

Print cloud information.

Reimplemented from IOobject.

Reimplemented in ReactingCloud< ParcelType >, ThermoCloud< ParcelType >, and ReactingMultiphaseCloud< ParcelType >.

Definition at line 270 of file KinematicCloud_.C.

References Foam::Info, Foam::name(), Foam::nl, and Foam::returnReduce().

const Foam::tmp< Foam::volScalarField > theta ( ) const
inline

Return the particle volume fraction field.

Note: for particles belonging to this cloud only

Definition at line 256 of file KinematicCloudI_.H.

References Foam::dimless, forAllConstIter, mesh, name(), p, and timeName.

const Foam::tmp< Foam::volScalarField > alpha ( ) const
inline

Return the particle mass fraction field.

Note: for particles belonging to this cloud only

Definition at line 293 of file KinematicCloudI_.H.

References Foam::dimless, forAllConstIter, mesh, name(), p, and timeName.

const Foam::tmp< Foam::volScalarField > rhoEff ( ) const
inline

Return the particle effective density field.

Note: for particles belonging to this cloud only

Definition at line 330 of file KinematicCloudI_.H.

References Foam::dimDensity, forAllConstIter, mesh, name(), p, and timeName.

void checkParcelProperties ( ParcelType &  parcel,
const scalar  lagrangianDt,
const bool  fullyDescribed 
)
void resetSourceTerms ( )

Reset the spray source terms.

Reimplemented in ReactingCloud< ParcelType >, ThermoCloud< ParcelType >, and ReactingMultiphaseCloud< ParcelType >.

Definition at line 246 of file KinematicCloud_.C.

References Vector< scalar >::zero.

void evolve ( )

Evolve the spray (inject, inject)

Reimplemented in ReactingCloud< ParcelType >, ThermoCloud< ParcelType >, and ReactingMultiphaseCloud< ParcelType >.

Definition at line 253 of file KinematicCloud_.C.

References Foam::endl(), and Foam::Info.


Member Data Documentation

const fvMesh& mesh_
protected

References to the mesh and time databases.

Definition at line 103 of file KinematicCloud_.H.

IOdictionary particleProperties_
protected

Dictionary of particle properties.

Definition at line 106 of file KinematicCloud_.H.

ParcelType::constantProperties constProps_
protected

Parcel constant properties.

Reimplemented in ReactingCloud< ParcelType >, ReactingMultiphaseCloud< ParcelType >, and ThermoCloud< ParcelType >.

Definition at line 109 of file KinematicCloud_.H.

const Switch active_
protected

Cloud active flag.

Definition at line 112 of file KinematicCloud_.H.

const label parcelTypeId_
protected

Parcel type id - used to flag the type of parcels issued by this.

cloud

Definition at line 116 of file KinematicCloud_.H.

const Switch coupled_
protected

Flag to indicate whether parcels are coupled to the carrier phase.

i.e. whether or not to generate source terms for carrier phase

Definition at line 120 of file KinematicCloud_.H.

const Switch cellValueSourceCorrection_
protected

Flag to correct cell values with latest transfer information.

during the lagrangian timestep

Definition at line 124 of file KinematicCloud_.H.

Random rndGen_
protected

Random number generator - used by some injection routines.

Definition at line 127 of file KinematicCloud_.H.

const volScalarField& rho_
protected

Density.

Definition at line 133 of file KinematicCloud_.H.

const volVectorField& U_
protected

Velocity.

Definition at line 136 of file KinematicCloud_.H.

const volScalarField& mu_
protected

Dynamic viscosity.

Definition at line 139 of file KinematicCloud_.H.

const dimensionedVector& g_
protected

Gravity.

Definition at line 145 of file KinematicCloud_.H.

particleForces forces_
protected

Optional particle forces.

Definition at line 149 of file KinematicCloud_.H.

dictionary interpolationSchemes_
protected

Interpolation schemes dictionary.

Definition at line 152 of file KinematicCloud_.H.

autoPtr<DispersionModel<KinematicCloud<ParcelType> > > dispersionModel_
protected

Dispersion model.

Definition at line 159 of file KinematicCloud_.H.

autoPtr<DragModel<KinematicCloud<ParcelType> > > dragModel_
protected

Drag transfer model.

Definition at line 162 of file KinematicCloud_.H.

autoPtr<InjectionModel<KinematicCloud<ParcelType> > > injectionModel_
protected

Injector model.

Definition at line 166 of file KinematicCloud_.H.

autoPtr<PatchInteractionModel<KinematicCloud<ParcelType> > > patchInteractionModel_
protected

Patch interaction model.

Definition at line 170 of file KinematicCloud_.H.

autoPtr<PostProcessingModel<KinematicCloud<ParcelType> > > postProcessingModel_
protected

Post-processing model.

Definition at line 174 of file KinematicCloud_.H.

autoPtr<vectorIntegrationScheme> UIntegrator_
protected

Velocity integration.

Definition at line 180 of file KinematicCloud_.H.

DimensionedField<vector, volMesh> UTrans_
protected

Momentum.

Definition at line 186 of file KinematicCloud_.H.


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