Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
KinematicCloud< CloudType > Class Template Reference

Templated base class for kinematic cloud. More...

Inheritance diagram for KinematicCloud< CloudType >:
Inheritance graph
[legend]
Collaboration diagram for KinematicCloud< CloudType >:
Collaboration graph
[legend]

Public Types

typedef CloudType cloudType
 Type of cloud this cloud was instantiated for. More...
 
typedef CloudType::particleType parcelType
 Type of parcel the cloud was instantiated for. More...
 
typedef KinematicCloud< CloudTypekinematicCloudType
 Convenience typedef for this cloud type. More...
 
typedef ParticleForceList< KinematicCloud< CloudType > > forceType
 Force models type. More...
 
typedef CloudFunctionObjectList< KinematicCloud< CloudType > > functionType
 Function object type. More...
 
- Public Types inherited from DSMCCloud< ParcelType >
typedef ParcelType parcelType
 Type of parcel the cloud was instantiated for. More...
 
- Public Types inherited from Cloud< ParcelType >
typedef ParcelType particleType
 
typedef IDLList< ParcelType >::iterator iterator
 
typedef IDLList< ParcelType >::const_iterator const_iterator
 
- Public Types inherited from regIOobject
enum  fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Types of communications. More...
 
- Public Types inherited from IOobject
enum  objectState { GOOD, BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 Enumeration defining the read options. More...
 
enum  writeOption { AUTO_WRITE = 0, NO_WRITE = 1 }
 Enumeration defining the write options. More...
 
- Public Types inherited from HashTable< regIOobject * >
typedef regIOobjectvalue_type
 Type of values the HashTable contains. More...
 
typedef regIOobject * & reference
 Type that can be used for storing into HashTable::value_type. More...
 
typedef const regIOobject * & const_reference
 Type that can be used for storing into constant. More...
 
typedef label size_type
 The type that can represent the size of a HashTable. More...
 
- Public Types inherited from UILList< DLListBase, ParcelType >
typedef ParcelType value_type
 Type of values the DLList contains. More...
 
typedef ParcelType & reference
 Type that can be used for storing into DLList::value_type. More...
 
typedef const ParcelType & const_reference
 Type that can be used for storing into constant. More...
 
typedef label size_type
 The type that can represent the size of a DLList. More...
 
typedef DLListBase::iterator LListBase_iterator
 
typedef DLListBase::const_iterator LListBase_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. More...
 
 KinematicCloud (KinematicCloud< CloudType > &c, const word &name)
 Copy constructor with new name. More...
 
 KinematicCloud (const fvMesh &mesh, const word &name, const KinematicCloud< CloudType > &c)
 Copy constructor with new name - creates bare cloud. More...
 
virtual autoPtr< Cloud< parcelType > > clone (const word &name)
 Construct and return clone based on (this) with new name. More...
 
virtual autoPtr< Cloud< parcelType > > cloneBare (const word &name) const
 Construct and return bare clone based on (this) with new name. More...
 
virtual ~KinematicCloud ()
 Destructor. More...
 
const KinematicCloudcloudCopy () const
 Return a reference to the cloud copy. More...
 
virtual bool hasWallImpactDistance () const
 Switch to specify if particles of the cloud can return. More...
 
const fvMeshmesh () const
 Return reference to the mesh. More...
 
const IOdictionaryparticleProperties () const
 Return particle properties dictionary. More...
 
const IOdictionaryoutputProperties () const
 Return output properties dictionary. More...
 
IOdictionaryoutputProperties ()
 Return non-const access to the output properties dictionary. More...
 
const cloudSolutionsolution () const
 Return const access to the solution properties. More...
 
cloudSolutionsolution ()
 Return access to the solution properties. More...
 
const parcelType::constantProperties & constProps () const
 Return the constant properties. More...
 
parcelType::constantProperties & constProps ()
 Return access to the constant properties. More...
 
const dictionarysubModelProperties () const
 Return reference to the sub-models dictionary. More...
 
cachedRandomrndGen ()
 Return reference to the random object. More...
 
List< DynamicList< parcelType * > > & cellOccupancy ()
 Return the cell occupancy information for each. More...
 
const scalarFieldcellLengthScale () const
 Return the cell length scale. More...
 
const volVectorFieldU () const
 Return carrier gas velocity. More...
 
const volScalarFieldrho () const
 Return carrier gas density. More...
 
const volScalarFieldmu () const
 Return carrier gas dynamic viscosity. More...
 
const dimensionedVectorg () const
 Gravity. More...
 
scalar pAmbient () const
 Return const-access to the ambient pressure. More...
 
scalar & pAmbient ()
 Return reference to the ambient pressure. More...
 
const forceTypeforces () const
 Optional particle forces. More...
 
forceTypeforces ()
 Return the optional particle forces. More...
 
functionTypefunctions ()
 Optional cloud function objects. More...
 
const InjectionModelList< KinematicCloud< CloudType > > & injectors () const
 Return const access to the injection model. More...
 
InjectionModelList< KinematicCloud< CloudType > > & injectors ()
 Return reference to the injection model. More...
 
const DispersionModel< KinematicCloud< CloudType > > & dispersion () const
 Return const-access to the dispersion model. More...
 
DispersionModel< KinematicCloud< CloudType > > & dispersion ()
 Return reference to the dispersion model. More...
 
const PatchInteractionModel< KinematicCloud< CloudType > > & patchInteraction () const
 Return const-access to the patch interaction model. More...
 
PatchInteractionModel< KinematicCloud< CloudType > > & patchInteraction ()
 Return reference to the patch interaction model. More...
 
const StochasticCollisionModel< KinematicCloud< CloudType > > & stochasticCollision () const
 Return const-access to the stochastic collision model. More...
 
StochasticCollisionModel< KinematicCloud< CloudType > > & stochasticCollision ()
 Return reference to the stochastic collision model. More...
 
const SurfaceFilmModel< KinematicCloud< CloudType > > & surfaceFilm () const
 Return const-access to the surface film model. More...
 
SurfaceFilmModel< KinematicCloud< CloudType > > & surfaceFilm ()
 Return reference to the surface film model. More...
 
const vectorIntegrationSchemeUIntegrator () const
 Return reference to velocity integration. More...
 
DimensionedField< vector, volMesh > & UTrans ()
 Return reference to momentum source. More...
 
const DimensionedField< vector, volMesh > & UTrans () const
 Return const reference to momentum source. More...
 
DimensionedField< scalar, volMesh > & UCoeff ()
 Return coefficient for carrier phase U equation. More...
 
const DimensionedField< scalar, volMesh > & UCoeff () const
 Return const coefficient for carrier phase U equation. More...
 
tmp< fvVectorMatrixSU (volVectorField &U) const
 Return tmp momentum source term. More...
 
label nParcels () const
 Total number of parcels. More...
 
scalar massInSystem () const
 Total mass in system. More...
 
vector linearMomentumOfSystem () const
 Total linear momentum of the system. More...
 
scalar linearKineticEnergyOfSystem () const
 Total linear kinetic energy in the system. More...
 
scalar rotationalKineticEnergyOfSystem () const
 Total rotational kinetic energy in the system. More...
 
scalar penetration (const scalar fraction) const
 Penetration for fraction [0-1] of the current total mass. More...
 
scalar Dij (const label i, const label j) const
 Mean diameter Dij. More...
 
scalar Dmax () const
 Max diameter. More...
 
const tmp< volScalarFieldvDotSweep () const
 Volume swept rate of parcels per cell. More...
 
const tmp< volScalarFieldtheta () const
 Return the particle volume fraction field. More...
 
const tmp< volScalarFieldalpha () const
 Return the particle mass fraction field. More...
 
const tmp< volScalarFieldrhoEff () const
 Return the particle effective density field. More...
 
void setParcelThermoProperties (parcelType &parcel, const scalar lagrangianDt)
 Set parcel thermo properties. More...
 
void checkParcelProperties (parcelType &parcel, const scalar lagrangianDt, const bool fullyDescribed)
 Check parcel properties. More...
 
void storeState ()
 Store the current cloud state. More...
 
void restoreState ()
 Reset the current cloud to the previously stored state. More...
 
void resetSourceTerms ()
 Reset the cloud source terms. More...
 
template<class Type >
void relax (DimensionedField< Type, volMesh > &field, const DimensionedField< Type, volMesh > &field0, const word &name) const
 Relax field. More...
 
template<class Type >
void scale (DimensionedField< Type, volMesh > &field, const word &name) const
 Scale field. More...
 
void relaxSources (const KinematicCloud< CloudType > &cloudOldTime)
 Apply relaxation to (steady state) cloud sources. More...
 
void scaleSources ()
 Apply scaling to (transient) cloud sources. More...
 
void preEvolve ()
 Pre-evolve. More...
 
void evolve ()
 Evolve the cloud. More...
 
template<class TrackData >
void motion (TrackData &td)
 Particle motion. More...
 
void patchData (const parcelType &p, const polyPatch &pp, const scalar trackFraction, const tetIndices &tetIs, vector &normal, vector &Up) const
 Calculate the patch normal and velocity to interact with,. More...
 
void updateMesh ()
 Update mesh. More...
 
virtual void autoMap (const mapPolyMesh &)
 Remap the cells of particles corresponding to the. More...
 
void info ()
 Print cloud information. More...
 
- Public Member Functions inherited from DSMCCloud< ParcelType >
 DSMCCloud (const word &cloudName, const fvMesh &mesh, bool readFields=true)
 Construct given name and mesh, will read Parcels and fields from. More...
 
 DSMCCloud (const word &cloudName, const fvMesh &mesh, const IOdictionary &dsmcInitialiseDict)
 Construct given name, mesh and initialisation dictionary. More...
 
virtual ~DSMCCloud ()
 Destructor. More...
 
const wordcloudName () const
 Return the cloud type. More...
 
const fvMeshmesh () const
 Return refernce to the mesh. More...
 
const IOdictionaryparticleProperties () const
 Return particle properties dictionary. More...
 
const List< word > & typeIdList () const
 Return the idList. More...
 
scalar nParticle () const
 Return the number of real particles represented by one. More...
 
const List< DynamicList< ParcelType * > > & cellOccupancy () const
 Return the cell occupancy addressing. More...
 
volScalarFieldsigmaTcRMax ()
 Return the sigmaTcRMax field. non-const access to allow. More...
 
scalarFieldcollisionSelectionRemainder ()
 Return the collision selection remainder field. non-const. More...
 
const List< typename ParcelType::constantProperties > & constProps () const
 Return all of the constant properties. More...
 
const ParcelType::constantProperties & constProps (label typeId) const
 Return the constant properties of the given typeId. More...
 
RandomrndGen ()
 Return refernce to the random object. More...
 
volScalarField::GeometricBoundaryField & qBF ()
 Return non-const heat flux boundary field reference. More...
 
volVectorField::GeometricBoundaryField & fDBF ()
 Return non-const force density at boundary field reference. More...
 
volScalarField::GeometricBoundaryField & rhoNBF ()
 Return non-const number density boundary field reference. More...
 
volScalarField::GeometricBoundaryField & rhoMBF ()
 Return non-const mass density boundary field reference. More...
 
volScalarField::GeometricBoundaryField & linearKEBF ()
 Return non-const linear kinetic energy density boundary. More...
 
volScalarField::GeometricBoundaryField & internalEBF ()
 Return non-const internal energy density boundary field. More...
 
volScalarField::GeometricBoundaryField & iDofBF ()
 Return non-const internal degree of freedom density boundary. More...
 
volVectorField::GeometricBoundaryField & momentumBF ()
 Return non-const momentum density boundary field reference. More...
 
const volScalarFieldboundaryT () const
 Return macroscopic temperature. More...
 
const volVectorFieldboundaryU () const
 Return macroscopic velocity. More...
 
const volScalarFieldq () const
 Return heat flux at surface field. More...
 
const volVectorFieldfD () const
 Return force density at surface field. More...
 
const volScalarFieldrhoN () const
 Return the real particle number density field. More...
 
const volScalarFieldrhoM () const
 Return the particle mass density field. More...
 
const volScalarFielddsmcRhoN () const
 Return the field of number of DSMC particles. More...
 
const volScalarFieldlinearKE () const
 Return the total linear kinetic energy (translational and. More...
 
const volScalarFieldinternalE () const
 Return the internal energy density field. More...
 
const volScalarFieldiDof () const
 Return the average internal degrees of freedom field. More...
 
const volVectorFieldmomentum () const
 Return the momentum density field. More...
 
vector equipartitionLinearVelocity (scalar temperature, scalar mass)
 Generate a random velocity sampled from the Maxwellian speed. More...
 
scalar equipartitionInternalEnergy (scalar temperature, direction internalDegreesOfFreedom)
 Generate a random internal energy, sampled from the. More...
 
scalar maxwellianAverageSpeed (scalar temperature, scalar mass) const
 Average particle speed. More...
 
scalarField maxwellianAverageSpeed (scalarField temperature, scalar mass) const
 
scalar maxwellianRMSSpeed (scalar temperature, scalar mass) const
 RMS particle speed. More...
 
scalarField maxwellianRMSSpeed (scalarField temperature, scalar mass) const
 
scalar maxwellianMostProbableSpeed (scalar temperature, scalar mass) const
 Most probable speed. More...
 
scalarField maxwellianMostProbableSpeed (scalarField temperature, scalar mass) const
 
const BinaryCollisionModel< DSMCCloud< ParcelType > > & binaryCollision () const
 Return reference to binary elastic collision model. More...
 
BinaryCollisionModel< DSMCCloud< ParcelType > > & binaryCollision ()
 Return non-const reference to binary elastic collision model. More...
 
const WallInteractionModel< DSMCCloud< ParcelType > > & wallInteraction () const
 Return reference to wall interaction model. More...
 
WallInteractionModel< DSMCCloud< ParcelType > > & wallInteraction ()
 Return non-const reference to wall interaction model. More...
 
const InflowBoundaryModel< DSMCCloud< ParcelType > > & inflowBoundary () const
 Return reference to wall interaction model. More...
 
InflowBoundaryModel< DSMCCloud< ParcelType > > & inflowBoundary ()
 Return non-const reference to wall interaction model. More...
 
scalar massInSystem () const
 Total mass in system. More...
 
vector linearMomentumOfSystem () const
 Total linear momentum of the system. More...
 
scalar linearKineticEnergyOfSystem () const
 Total linear kinetic energy in the system. More...
 
scalar internalEnergyOfSystem () const
 Total internal energy in the system. More...
 
void info () const
 Print cloud information. More...
 
void dumpParticlePositions () const
 Dump particle positions to .obj file. More...
 
void addNewParcel (const vector &position, const vector &U, const scalar Ei, const label cellI, const label tetFaceI, const label tetPtI, const label typeId)
 Add new parcel. More...
 
void evolve ()
 Evolve the cloud (move, collide) More...
 
void clear ()
 Clear the Cloud. More...
 
- Public Member Functions inherited from Cloud< ParcelType >
 TypeName ("Cloud")
 Runtime type information. More...
 
 Cloud (const polyMesh &mesh, const IDLList< ParcelType > &particles)
 Construct from mesh and a list of particles. More...
 
 Cloud (const polyMesh &mesh, const word &cloudName, const IDLList< ParcelType > &particles)
 Construct from mesh, cloud name, and a list of particles. More...
 
 Cloud (const polyMesh &mesh, const bool checkClass=true)
 Construct from mesh by reading from file. More...
 
 Cloud (const polyMesh &pMesh, const word &cloudName, const bool checkClass=true)
 Construct from mesh by reading from file with given cloud instance. More...
 
const polyMeshpMesh () const
 Return the polyMesh reference. More...
 
label size () const
 
DynamicList< label > & labels ()
 
label nTrackingRescues () const
 Return nTrackingRescues. More...
 
void trackingRescue () const
 Increment the nTrackingRescues counter. More...
 
const PackedBoolListcellHasWallFaces () const
 Whether each cell has any wall faces (demand driven data) More...
 
const const_iterator begin () const
 
iterator begin ()
 
const const_iterator cbegin () const
 
const const_iterator end () const
 
iterator end ()
 
const const_iterator cend () const
 
void clear ()
 
void addParticle (ParcelType *pPtr)
 Transfer particle to cloud. More...
 
void deleteParticle (ParcelType &)
 Remove particle from cloud and delete. More...
 
void cloudReset (const Cloud< ParcelType > &c)
 Reset the particles. More...
 
void move (TrackData &td, const scalar trackTime)
 Move the particles. More...
 
void autoMap (TrackData &td, const mapPolyMesh &)
 Remap the cells of particles corresponding to the. More...
 
IOobject fieldIOobject (const word &fieldName, const IOobject::readOption r) const
 Helper to construct IOobject for field and current time. More...
 
void checkFieldIOobject (const Cloud< ParcelType > &c, const IOField< DataType > &data) const
 Check lagrangian data field. More...
 
void checkFieldFieldIOobject (const Cloud< ParcelType > &c, const CompactIOField< Field< DataType >, DataType > &data) const
 Check lagrangian data fieldfield. More...
 
virtual void readFields ()
 Read the field data for the cloud of particles. Dummy at. More...
 
virtual void writeFields () const
 Write the field data for the cloud of particles Dummy at. More...
 
virtual bool writeObject (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::compressionType cmp) const
 Write using given format, version and compression. More...
 
void writePositions () const
 Write positions to <cloudName>_positions.obj file. More...
 
- Public Member Functions inherited from cloud
 TypeName ("cloud")
 Runtime type information. More...
 
 cloud (const objectRegistry &, const word &cloudName="")
 Construct for the given objectRegistry and named cloud instance. More...
 
virtual ~cloud ()
 Destructor. More...
 
- Public Member Functions inherited from objectRegistry
 TypeName ("objectRegistry")
 Declare type name for this IOobject. More...
 
 objectRegistry (const Time &db, const label nIoObjects=128)
 Construct the time objectRegistry given an initial estimate. More...
 
 objectRegistry (const IOobject &io, const label nIoObjects=128)
 Construct a sub-registry given an IObject to describe the registry. More...
 
virtual ~objectRegistry ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistryparent () const
 Return the parent objectRegistry. More...
 
virtual const fileNamedbDir () const
 Local directory path of this objectRegistry relative to the time. More...
 
wordList names () const
 Return the list of names of the IOobjects. More...
 
wordList sortedNames () const
 Return the sorted list of names of the IOobjects. More...
 
wordList names (const word &className) const
 Return the list of names of IOobjects of given class name. More...
 
wordList sortedNames (const word &className) const
 Return the sorted list of names of IOobjects of given class name. More...
 
template<class Type >
wordList names () const
 Return the list of names of the IOobjects of given type. More...
 
template<class Type >
wordList names (const wordRe &name) const
 Return the list of objects whose name matches the input regExp. More...
 
template<class Type >
wordList names (const wordReList &name) const
 Return the list of objects whose name matches the input regExp. More...
 
const objectRegistrysubRegistry (const word &name, const bool forceCreate=false) const
 Lookup and return a const sub-objectRegistry. Optionally create. More...
 
template<class Type >
HashTable< const Type * > lookupClass (const bool strict=false) const
 Lookup and return all objects of the given Type. More...
 
template<class Type >
HashTable< Type * > lookupClass (const bool strict=false)
 Lookup and return all objects of the given Type. More...
 
template<class Type >
bool foundObject (const word &name) const
 Is the named Type found? More...
 
template<class Type >
const Type & lookupObject (const word &name) const
 Lookup and return the object of the given Type. More...
 
label getEvent () const
 Return new event number. More...
 
virtual void rename (const word &newName)
 Rename. More...
 
bool checkIn (regIOobject &) const
 Add an regIOobject to registry. More...
 
bool checkOut (regIOobject &) const
 Remove an regIOobject from registry. More...
 
virtual bool modified () const
 Return true if any of the object's files have been modified. More...
 
void readModifiedObjects ()
 Read the objects that have been modified. More...
 
virtual bool readIfModified ()
 Read object if modified. More...
 
virtual bool writeData (Ostream &) const
 writeData function required by regIOobject but not used More...
 
template<class Type >
Foam::wordList names () const
 
template<class Type >
Foam::wordList names (const wordRe &name) const
 
template<class Type >
Foam::wordList names (const wordReList &patterns) const
 
template<class Type >
Foam::HashTable< const Type * > lookupClass (const bool strict) const
 
template<class Type >
Foam::HashTable< Type * > lookupClass (const bool strict)
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the. More...
 
 regIOobject (const regIOobject &)
 Construct as copy. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Construct as copy, transferring registry registration to copy. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Construct as copy with new name, transfering registry registration. More...
 
 regIOobject (const IOobject &, const regIOobject &)
 Construct as copy with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from registry. More...
 
bool ownedByRegistry () const
 Is this object owned by the registry? More...
 
void store ()
 Transfer ownership of this object to its registry. More...
 
void release ()
 Release ownership of this object from its registry. More...
 
label eventNo () const
 Event number at last update. More...
 
labeleventNo ()
 Event number at last update. More...
 
bool upToDate (const regIOobject &) const
 Return true if up-to-date with respect to given object. More...
 
bool upToDate (const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
void setUpToDate ()
 Set up to date (obviously) More...
 
IstreamreadStream (const word &)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
virtual bool readData (Istream &)
 Virtual readData function. More...
 
virtual bool read ()
 Read object. More...
 
label watchIndex () const
 Return file-monitoring handle. More...
 
labelwatchIndex ()
 Return file-monitoring handle. More...
 
virtual bool write () const
 Write using setting from DB. More...
 
void operator= (const IOobject &)
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information. More...
 
 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. More...
 
 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. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options. More...
 
Foam::autoPtr< IOobjectclone () const
 Clone. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () const
 Return the optional note. More...
 
bool & registerObject ()
 Register object created from this IOobject with registry if true. More...
 
bool registerObject () const
 Register object created from this IOobject with registry if true. More...
 
readOption readOpt () const
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const
 
const fileNamecaseName () const
 
const fileNameinstance () const
 
fileNameinstance ()
 
const fileNamelocal () const
 
fileName path () const
 Return complete path. More...
 
fileName path (const word &instance, const fileName &local="") const
 Return complete path with alternative instance and local. More...
 
fileName objectPath () const
 Return complete path + object name. More...
 
fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool readHeader (Istream &)
 Read header. More...
 
bool headerOk ()
 Read and check header info. More...
 
bool writeHeader (Ostream &) const
 Write header. More...
 
bool writeHeader (Ostream &, const word &objectType) const
 Write header. Allow override of type. More...
 
bool good () const
 
bool bad () const
 
InfoProxy< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 
- Public Member Functions inherited from HashTable< regIOobject * >
bool set (const word &, const regIOobject * &newElmt)
 Assign a new hashedEntry, overwriting existing entries. More...
 
 HashTable (const label size=128)
 Construct given initial table size. More...
 
 HashTable (Istream &, const label size=128)
 Construct from Istream. More...
 
 HashTable (const HashTable< regIOobject *, word, string::hash > &)
 Construct as copy. More...
 
 HashTable (const Xfer< HashTable< regIOobject *, word, string::hash > > &)
 Construct by transferring the parameter contents. More...
 
 ~HashTable ()
 Destructor. More...
 
label capacity () const
 The size of the underlying table. More...
 
label size () const
 Return number of elements in table. More...
 
bool empty () const
 Return true if the hash table is empty. More...
 
bool found (const word &) const
 Return true if hashedEntry is found in table. More...
 
iterator find (const word &)
 Find and return an iterator set at the hashedEntry. More...
 
const_iterator find (const word &) const
 Find and return an const_iterator set at the hashedEntry. More...
 
List< wordtoc () const
 Return the table of contents. More...
 
List< wordsortedToc () const
 Return the table of contents as a sorted list. More...
 
OstreamprintInfo (Ostream &) const
 Print information. More...
 
bool insert (const word &, const regIOobject * &newElmt)
 Insert a new hashedEntry. More...
 
bool erase (const iterator &)
 Erase a hashedEntry specified by given iterator. More...
 
bool erase (const word &)
 Erase a hashedEntry specified by the given key. More...
 
label erase (const UList< word > &)
 Remove entries given by the listed keys from this HashTable. More...
 
label erase (const HashTable< AnyType, word, AnyHash > &)
 Remove entries given by the given keys from this HashTable. More...
 
void resize (const label newSize)
 Resize the hash table for efficiency. More...
 
void clear ()
 Clear all entries from table. More...
 
void clearStorage ()
 Clear the table entries and the table itself. More...
 
void shrink ()
 Shrink the allocated table to approx. twice number of elements. More...
 
void transfer (HashTable< regIOobject *, word, string::hash > &)
 Transfer the contents of the argument table into this table. More...
 
Xfer< HashTable< regIOobject *, word, string::hash > > xfer ()
 Transfer contents to the Xfer container. More...
 
regIOobject * & operator[] (const word &)
 Find and return a hashedEntry. More...
 
const regIOobject * & operator[] (const word &) const
 Find and return a hashedEntry. More...
 
regIOobject * & operator() (const word &)
 Find and return a hashedEntry, create it null if not present. More...
 
void operator= (const HashTable< regIOobject *, word, string::hash > &)
 Assignment. More...
 
bool operator== (const HashTable< regIOobject *, word, string::hash > &) const
 Equality. Hash tables are equal if the keys and values are equal. More...
 
bool operator!= (const HashTable< regIOobject *, word, string::hash > &) const
 The opposite of the equality operation. Takes linear time. More...
 
iterator begin ()
 Iterator set to the beginning of the HashTable. More...
 
const_iterator begin () const
 const_iterator set to the beginning of the HashTable More...
 
const_iterator cbegin () const
 const_iterator set to the beginning of the HashTable More...
 
- Public Member Functions inherited from HashTableCore
 HashTableCore ()
 Construct null. More...
 
 ClassName ("HashTable")
 Define template name and debug. More...
 
- Public Member Functions inherited from IDLList< ParcelType >
 IDLList ()
 Null construct. More...
 
 IDLList (const ParcelType &a)
 Construct given initial T. More...
 
 IDLList (Istream &is, const INew &inewt)
 Construct from Istream using given Istream constructor class. More...
 
 IDLList (Istream &is)
 Construct from Istream. More...
 
 IDLList (const IDLList< ParcelType > &idll, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone. More...
 
- Public Member Functions inherited from ILList< DLListBase, ParcelType >
 ILList ()
 Null construct. More...
 
 ILList (ParcelType *a)
 Construct given initial T. More...
 
 ILList (Istream &)
 Construct from Istream. More...
 
 ILList (const ILList< DLListBase, ParcelType > &)
 Construct as copy. More...
 
 ILList (const ILList< DLListBase, ParcelType > &lst, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone. More...
 
 ILList (Istream &, const INew &)
 Construct from Istream using given Istream constructor class. More...
 
 ~ILList ()
 Destructor. More...
 
bool eraseHead ()
 Remove the head element specified from the list and delete it. More...
 
bool erase (ParcelType *p)
 Remove the specified element from the list and delete it. More...
 
void clear ()
 Clear the contents of the list. More...
 
void transfer (ILList< DLListBase, ParcelType > &)
 Transfer the contents of the argument into this List. More...
 
void operator= (const ILList< DLListBase, ParcelType > &)
 
- Public Member Functions inherited from UILList< DLListBase, ParcelType >
 UILList ()
 Null construct. More...
 
 UILList (ParcelType *a)
 Construct given initial T. More...
 
 UILList (const UILList< DLListBase, ParcelType > &)
 Construct as copy. More...
 
ParcelType * first ()
 Return the first entry. More...
 
const ParcelType * first () const
 Return the first entry. More...
 
ParcelType * last ()
 Return the last entry. More...
 
const ParcelType * last () const
 Return the last entry. More...
 
ParcelType * removeHead ()
 Remove and return head. More...
 
ParcelType * remove (ParcelType *p)
 Remove and return element. More...
 
ParcelType * remove (iterator &it)
 Remove and return specified by iterator. More...
 
void operator= (const UILList< DLListBase, ParcelType > &)
 
iterator begin ()
 
const_iterator begin () const
 
const iteratorend ()
 
const const_iteratorend () const
 
const_iterator cbegin () const
 
const const_iteratorcend () const
 
const_reverse_iterator crbegin () const
 
const const_reverse_iteratorcrend () const
 
const_reverse_iterator rbegin () const
 
const const_reverse_iteratorrend () const
 
bool operator== (const UILList< DLListBase, ParcelType > &) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UILList< DLListBase, ParcelType > &) const
 The opposite of the equality operation. Takes linear time. More...
 
- Public Member Functions inherited from DLListBase
 DLListBase ()
 Null construct. More...
 
 DLListBase (link *)
 Construct given initial entry. More...
 
 ~DLListBase ()
 Destructor. More...
 
label size () const
 Return number of elements in list. More...
 
bool empty () const
 Return true if the list is empty. More...
 
linkfirst ()
 Return first entry. More...
 
const linkfirst () const
 Return const access to first entry. More...
 
linklast ()
 Return last entry. More...
 
const linklast () const
 Return const access to last entry. More...
 
void insert (link *)
 Add at head of list. More...
 
void append (link *)
 Add at tail of list. More...
 
bool swapUp (link *)
 Swap this element with the one above unless it is at the top. More...
 
bool swapDown (link *)
 Swap this element with the one below unless it is at the bottom. More...
 
linkremoveHead ()
 Remove and return head. More...
 
linkremove (link *)
 Remove and return element. More...
 
linkremove (iterator &)
 
linkreplace (link *oldLink, link *newLink)
 Replace oldLink with newLink and return element. More...
 
linkreplace (iterator &oldIter, link *newLink)
 Replace oldIter with newLink and return element. More...
 
void clear ()
 Clear the list. More...
 
void transfer (DLListBase &)
 Transfer the contents of the argument into this List. More...
 
iterator begin ()
 
const iteratorend ()
 
const_iterator cbegin () const
 
const const_iteratorcend () const
 
const_iterator begin () const
 
const const_iteratorend () const
 
const_reverse_iterator crbegin () const
 
const const_reverse_iteratorcrend () const
 
const_reverse_iterator rbegin () const
 
const const_reverse_iteratorrend () const
 
- Public Member Functions inherited from DSMCBaseCloud
 TypeName ("DSMCBaseCloud")
 Runtime type information. More...
 
 DSMCBaseCloud ()
 Null constructor. More...
 
virtual ~DSMCBaseCloud ()
 Destructor. More...
 
- Public Member Functions inherited from kinematicCloud
 TypeName ("kinematicCloud")
 Runtime type information. More...
 
 kinematicCloud ()
 Null constructor. More...
 
virtual ~kinematicCloud ()
 Destructor. More...
 

Protected Member Functions

void setModels ()
 Set cloud sub-models. More...
 
template<class TrackData >
void solve (TrackData &td)
 Solve the cloud - calls all evolution functions. More...
 
void buildCellOccupancy ()
 Build the cellOccupancy. More...
 
void updateCellOccupancy ()
 Update (i.e. build) the cellOccupancy if it has. More...
 
template<class TrackData >
void evolveCloud (TrackData &td)
 Evolve the cloud. More...
 
void postEvolve ()
 Post-evolve. More...
 
void cloudReset (KinematicCloud< CloudType > &c)
 Reset state of cloud. More...
 
- Protected Member Functions inherited from IOobject
IstreamobjectStream ()
 Construct and return an IFstream for the object. More...
 
IstreamobjectStream (const fileName &)
 Construct and return an IFstream for the object given the. More...
 
void setBad (const string &)
 Set the object state to bad. More...
 

Protected Attributes

const fvMeshmesh_
 References to the mesh and time databases. More...
 
IOdictionary particleProperties_
 Dictionary of particle properties. More...
 
IOdictionary outputProperties_
 Dictionary of output properties. More...
 
cloudSolution solution_
 Solution properties. More...
 
parcelType::constantProperties constProps_
 Parcel constant properties. More...
 
const dictionary subModelProperties_
 Sub-models dictionary. More...
 
cachedRandom rndGen_
 Random number generator - used by some injection routines. More...
 
autoPtr< List< DynamicList< parcelType * > > > cellOccupancyPtr_
 Cell occupancy information for each parcel, (demand driven) More...
 
scalarField cellLengthScale_
 Cell length scale. More...
 
const volScalarFieldrho_
 Density [kg/m3]. More...
 
const volVectorFieldU_
 Velocity [m/s]. More...
 
const volScalarFieldmu_
 Dynamic viscosity [Pa.s]. More...
 
const dimensionedVectorg_
 Gravity. More...
 
scalar pAmbient_
 Averaged ambient domain pressure. More...
 
forceType forces_
 Optional particle forces. More...
 
functionType functions_
 Optional cloud function objects. More...
 
InjectionModelList< KinematicCloud< CloudType > > injectors_
 Injector models. More...
 
autoPtr< DispersionModel< KinematicCloud< CloudType > > > dispersionModel_
 Dispersion model. More...
 
autoPtr< PatchInteractionModel< KinematicCloud< CloudType > > > patchInteractionModel_
 Patch interaction model. More...
 
autoPtr< StochasticCollisionModel< KinematicCloud< CloudType > > > stochasticCollisionModel_
 Stochastic collision model. More...
 
autoPtr< SurfaceFilmModel< KinematicCloud< CloudType > > > surfaceFilmModel_
 Surface film model. More...
 
autoPtr< vectorIntegrationSchemeUIntegrator_
 Velocity integration. More...
 
autoPtr< DimensionedField< vector, volMesh > > UTrans_
 Momentum. More...
 
autoPtr< DimensionedField< scalar, volMesh > > UCoeff_
 Coefficient for carrier phase U equation. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *)
 Transfer ownership of the given object pointer to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &)
 Transfer ownership of the given object pointer to its registry. More...
 
- Static Public Member Functions inherited from IOobject
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components. More...
 
template<class Name >
static word groupName (Name name, const word &group)
 
template<class Stream >
static Stream & writeBanner (Stream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
template<class Stream >
static Stream & writeDivider (Stream &os)
 Write the standard file section divider. More...
 
template<class Stream >
static Stream & writeEndDivider (Stream &os)
 Write the standard end file divider. More...
 
- Static Public Member Functions inherited from HashTableCore
static label canonicalSize (const label)
 Return a canonical (power-of-two) size. More...
 
static iteratorEnd cend ()
 iteratorEnd set to beyond the end of any HashTable More...
 
static iteratorEnd end ()
 iteratorEnd set to beyond the end of any HashTable More...
 
- Static Public Attributes inherited from Cloud< ParcelType >
static word cloudPropertiesName
 Name of cloud properties dictionary. More...
 
- Static Public Attributes inherited from cloud
static const word prefix
 The prefix to local: lagrangian. More...
 
static word defaultName
 The default cloud name: defaultCloud. More...
 
- Static Public Attributes inherited from regIOobject
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static int fileModificationSkew
 
static fileCheckTypes fileModificationChecking
 
- Static Public Attributes inherited from HashTableCore
static const label maxTableSize
 Maximum allowable table size. More...
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

template<class CloudType>
class Foam::KinematicCloud< CloudType >

Templated base class for kinematic cloud.

- cloud function objects

Source files

Definition at line 96 of file KinematicCloud.H.

Member Typedef Documentation

Type of cloud this cloud was instantiated for.

Definition at line 106 of file KinematicCloud.H.

Type of parcel the cloud was instantiated for.

Definition at line 109 of file KinematicCloud.H.

Convenience typedef for this cloud type.

Definition at line 112 of file KinematicCloud.H.

Force models type.

Definition at line 115 of file KinematicCloud.H.

Function object type.

Definition at line 119 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 ( KinematicCloud< CloudType > &  c,
const word name 
)

Copy constructor with new name.

Definition at line 409 of file KinematicCloud.C.

KinematicCloud ( const fvMesh mesh,
const word name,
const KinematicCloud< CloudType > &  c 
)

Copy constructor with new name - creates bare cloud.

Definition at line 476 of file KinematicCloud.C.

~KinematicCloud ( )
virtual

Destructor.

Definition at line 538 of file KinematicCloud.C.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the caller graph for this function:

Member Function Documentation

void setModels ( )
protected

Set cloud sub-models.

Definition at line 40 of file KinematicCloud.C.

References Foam::compressible::New().

Here is the call graph for this function:

void solve ( TrackData &  td)
protected

Solve the cloud - calls all evolution functions.

Definition at line 91 of file KinematicCloud.C.

void buildCellOccupancy ( )
protected

Build the cellOccupancy.

Definition at line 130 of file KinematicCloud.C.

References List< T >::append(), cellOccupancy, List< T >::clear(), forAll, and forAllIter.

Here is the call graph for this function:

void updateCellOccupancy ( )
protected

Update (i.e. build) the cellOccupancy if it has.

already been used

Definition at line 162 of file KinematicCloud.C.

void evolveCloud ( TrackData &  td)
protected

Evolve the cloud.

Definition at line 176 of file KinematicCloud.C.

References surfaceFilm.

void postEvolve ( )
protected

Post-evolve.

Definition at line 219 of file KinematicCloud.C.

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

Here is the call graph for this function:

void cloudReset ( KinematicCloud< CloudType > &  c)
protected
virtual autoPtr<Cloud<parcelType> > clone ( const word name)
inlinevirtual

Construct and return clone based on (this) with new name.

Definition at line 297 of file KinematicCloud.H.

virtual autoPtr<Cloud<parcelType> > cloneBare ( const word name) const
inlinevirtual

Construct and return bare clone based on (this) with new name.

Definition at line 306 of file KinematicCloud.H.

const Foam::KinematicCloud< CloudType > & cloudCopy ( ) const
inline

Return a reference to the cloud copy.

Definition at line 33 of file KinematicCloudI.H.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the caller graph for this function:

bool hasWallImpactDistance ( ) const
virtual

Switch to specify if particles of the cloud can return.

non-zero wall distance values - true for kinematic parcels

Reimplemented from Cloud< ParcelType >.

Definition at line 545 of file KinematicCloud.C.

References KinematicCloud< CloudType >::setParcelThermoProperties().

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the call graph for this function:

Here is the caller graph for this function:

const Foam::fvMesh & mesh ( ) const
inline

Return reference to the mesh.

Definition at line 40 of file KinematicCloudI.H.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the caller graph for this function:

const Foam::IOdictionary & particleProperties ( ) const
inline

Return particle properties dictionary.

Definition at line 48 of file KinematicCloudI.H.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the caller graph for this function:

const Foam::IOdictionary & outputProperties ( ) const
inline

Return output properties dictionary.

Definition at line 56 of file KinematicCloudI.H.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the caller graph for this function:

Foam::IOdictionary & outputProperties ( )
inline

Return non-const access to the output properties dictionary.

Definition at line 63 of file KinematicCloudI.H.

const Foam::cloudSolution & solution ( ) const
inline

Return const access to the solution properties.

Definition at line 71 of file KinematicCloudI.H.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the caller graph for this function:

Return access to the solution properties.

Definition at line 78 of file KinematicCloudI.H.

const CloudType::particleType::constantProperties & constProps ( ) const
inline

Return the constant properties.

Definition at line 86 of file KinematicCloudI.H.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the caller graph for this function:

CloudType::particleType::constantProperties & constProps ( )
inline

Return access to the constant properties.

Definition at line 94 of file KinematicCloudI.H.

const Foam::dictionary & subModelProperties ( ) const
inline

Return reference to the sub-models dictionary.

Definition at line 102 of file KinematicCloudI.H.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the caller graph for this function:

Foam::cachedRandom & rndGen ( )
inline

Return reference to the random object.

Definition at line 501 of file KinematicCloudI.H.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the caller graph for this function:

Foam::List< Foam::DynamicList< typename CloudType::particleType * > > & cellOccupancy ( )
inline

Return the cell occupancy information for each.

parcel, non-const access, the caller is responsible for updating it for its own purposes if particles are removed or created.

Definition at line 509 of file KinematicCloudI.H.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the caller graph for this function:

const Foam::scalarField & cellLengthScale ( ) const
inline

Return the cell length scale.

Definition at line 522 of file KinematicCloudI.H.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the caller graph for this function:

const Foam::volVectorField & U ( ) const
inline

Return carrier gas velocity.

Definition at line 116 of file KinematicCloudI.H.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the caller graph for this function:

const Foam::volScalarField & rho ( ) const
inline

Return carrier gas density.

Definition at line 109 of file KinematicCloudI.H.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the caller graph for this function:

const Foam::volScalarField & mu ( ) const
inline

Return carrier gas dynamic viscosity.

Definition at line 123 of file KinematicCloudI.H.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the caller graph for this function:

const Foam::dimensionedVector & g ( ) const
inline

Gravity.

Definition at line 130 of file KinematicCloudI.H.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the caller graph for this function:

Foam::scalar pAmbient ( ) const
inline

Return const-access to the ambient pressure.

Definition at line 137 of file KinematicCloudI.H.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the caller graph for this function:

Foam::scalar & pAmbient ( )
inline

Return reference to the ambient pressure.

Definition at line 144 of file KinematicCloudI.H.

const Foam::KinematicCloud< CloudType >::forceType & forces ( ) const
inline

Optional particle forces.

inline const typename parcelType::forceType& forces() const;

Definition at line 153 of file KinematicCloudI.H.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the caller graph for this function:

Return the optional particle forces.

Definition at line 161 of file KinematicCloudI.H.

Foam::KinematicCloud< CloudType >::functionType & functions ( )
inline

Optional cloud function objects.

Definition at line 169 of file KinematicCloudI.H.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the caller graph for this function:

const Foam::InjectionModelList< Foam::KinematicCloud< CloudType > > & injectors ( ) const
inline

Return const access to the injection model.

Definition at line 177 of file KinematicCloudI.H.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the caller graph for this function:

Return reference to the injection model.

Definition at line 185 of file KinematicCloudI.H.

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

Return const-access to the dispersion model.

Definition at line 193 of file KinematicCloudI.H.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the caller graph for this function:

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

Return reference to the dispersion model.

Definition at line 201 of file KinematicCloudI.H.

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

Return const-access to the patch interaction model.

Definition at line 209 of file KinematicCloudI.H.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the caller graph for this function:

Foam::PatchInteractionModel< Foam::KinematicCloud< CloudType > > & patchInteraction ( )
inline

Return reference to the patch interaction model.

Definition at line 217 of file KinematicCloudI.H.

const Foam::StochasticCollisionModel< Foam::KinematicCloud< CloudType > > & stochasticCollision ( ) const
inline

Return const-access to the stochastic collision model.

Definition at line 225 of file KinematicCloudI.H.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the caller graph for this function:

Foam::StochasticCollisionModel< Foam::KinematicCloud< CloudType > > & stochasticCollision ( )
inline

Return reference to the stochastic collision model.

Definition at line 233 of file KinematicCloudI.H.

const Foam::SurfaceFilmModel< Foam::KinematicCloud< CloudType > > & surfaceFilm ( ) const
inline

Return const-access to the surface film model.

Definition at line 241 of file KinematicCloudI.H.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the caller graph for this function:

Foam::SurfaceFilmModel< Foam::KinematicCloud< CloudType > > & surfaceFilm ( )
inline

Return reference to the surface film model.

Definition at line 249 of file KinematicCloudI.H.

const Foam::vectorIntegrationScheme & UIntegrator ( ) const
inline

Return reference to velocity integration.

Definition at line 257 of file KinematicCloudI.H.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the caller graph for this function:

Return reference to momentum source.

Definition at line 530 of file KinematicCloudI.H.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare(), and KinematicCloud< CloudType >::relaxSources().

Here is the caller graph for this function:

const Foam::DimensionedField< Foam::vector, Foam::volMesh > & UTrans ( ) const
inline

Return const reference to momentum source.

Definition at line 538 of file KinematicCloudI.H.

Foam::DimensionedField< Foam::scalar, Foam::volMesh > & UCoeff ( )
inline

Return coefficient for carrier phase U equation.

Definition at line 546 of file KinematicCloudI.H.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare(), and KinematicCloud< CloudType >::relaxSources().

Here is the caller graph for this function:

const Foam::DimensionedField< Foam::scalar, Foam::volMesh > & UCoeff ( ) const
inline

Return const coefficient for carrier phase U equation.

Definition at line 554 of file KinematicCloudI.H.

Foam::tmp< Foam::fvVectorMatrix > SU ( volVectorField U) const
inline

Return tmp momentum source term.

Definition at line 562 of file KinematicCloudI.H.

References Foam::dimForce, Foam::endl(), Foam::Info, Foam::max(), Foam::min(), Foam::nl, fvMatrix< Type >::source(), Foam::fvc::Sp(), and U.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::label nParcels ( ) const
inlinevirtual

Total number of parcels.

Implements kinematicCloud.

Definition at line 264 of file KinematicCloudI.H.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the caller graph for this function:

Foam::scalar massInSystem ( ) const
inlinevirtual

Total mass in system.

Implements kinematicCloud.

Definition at line 271 of file KinematicCloudI.H.

References forAllConstIter(), and p.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::vector linearMomentumOfSystem ( ) const
inlinevirtual

Total linear momentum of the system.

Implements kinematicCloud.

Definition at line 286 of file KinematicCloudI.H.

References forAllConstIter(), and p.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::scalar linearKineticEnergyOfSystem ( ) const
inlinevirtual

Total linear kinetic energy in the system.

Implements kinematicCloud.

Definition at line 303 of file KinematicCloudI.H.

References KinematicCloud< CloudType >::Dij(), forAllConstIter(), and p.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the call graph for this function:

Here is the caller graph for this function:

scalar rotationalKineticEnergyOfSystem ( ) const
inline

Total rotational kinetic energy in the system.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the caller graph for this function:

Foam::scalar penetration ( const scalar  fraction) const
inline
Foam::scalar Dij ( const label  i,
const label  j 
) const
inlinevirtual

Mean diameter Dij.

Implements kinematicCloud.

Definition at line 320 of file KinematicCloudI.H.

References forAllConstIter(), Foam::max(), p, Foam::pow(), and Foam::reduce().

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare(), and KinematicCloud< CloudType >::linearKineticEnergyOfSystem().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::scalar Dmax ( ) const
inlinevirtual

Max diameter.

Implements kinematicCloud.

Definition at line 343 of file KinematicCloudI.H.

References forAllConstIter(), Foam::max(), p, KinematicCloud< CloudType >::penetration(), and Foam::reduce().

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the call graph for this function:

Here is the caller graph for this function:

const Foam::tmp< Foam::volScalarField > vDotSweep ( ) const
inlinevirtual

Volume swept rate of parcels per cell.

Implements kinematicCloud.

Definition at line 598 of file KinematicCloudI.H.

References GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), Foam::dimless, Foam::dimTime, forAllConstIter(), GeometricField< Type, PatchField, GeoMesh >::internalField(), Foam::mag(), Foam::name(), p, and timeName.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Return the particle volume fraction field.

Note: for particles belonging to this cloud only

Implements kinematicCloud.

Definition at line 637 of file KinematicCloudI.H.

References GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), Foam::dimless, forAllConstIter(), GeometricField< Type, PatchField, GeoMesh >::internalField(), Foam::name(), p, and timeName.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Return the particle mass fraction field.

Note: for particles belonging to this cloud only

Implements kinematicCloud.

Definition at line 676 of file KinematicCloudI.H.

References Foam::constant::atomic::alpha, Foam::dimless, forAllConstIter(), Foam::name(), p, and timeName.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Return the particle effective density field.

Note: for particles belonging to this cloud only

Implements kinematicCloud.

Definition at line 713 of file KinematicCloudI.H.

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

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the call graph for this function:

Here is the caller graph for this function:

void setParcelThermoProperties ( parcelType parcel,
const scalar  lagrangianDt 
)

Set parcel thermo properties.

Definition at line 553 of file KinematicCloud.C.

References KinematicCloud< CloudType >::checkParcelProperties().

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare(), and KinematicCloud< CloudType >::hasWallImpactDistance().

Here is the call graph for this function:

Here is the caller graph for this function:

void checkParcelProperties ( parcelType parcel,
const scalar  lagrangianDt,
const bool  fullyDescribed 
)

Check parcel properties.

Definition at line 564 of file KinematicCloud.C.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare(), and KinematicCloud< CloudType >::setParcelThermoProperties().

Here is the caller graph for this function:

void storeState ( )

Store the current cloud state.

Definition at line 581 of file KinematicCloud.C.

References Foam::name().

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the call graph for this function:

Here is the caller graph for this function:

void restoreState ( )

Reset the current cloud to the previously stored state.

Definition at line 594 of file KinematicCloud.C.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the caller graph for this function:

void resetSourceTerms ( )

Reset the cloud source terms.

Definition at line 602 of file KinematicCloud.C.

References KinematicCloud< CloudType >::relax().

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the call graph for this function:

Here is the caller graph for this function:

void relax ( DimensionedField< Type, volMesh > &  field,
const DimensionedField< Type, volMesh > &  field0,
const word name 
) const

Relax field.

Definition at line 612 of file KinematicCloud.C.

References KinematicCloud< CloudType >::scale().

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare(), and KinematicCloud< CloudType >::resetSourceTerms().

Here is the call graph for this function:

Here is the caller graph for this function:

void scale ( DimensionedField< Type, volMesh > &  field,
const word name 
) const

Scale field.

Definition at line 626 of file KinematicCloud.C.

References KinematicCloud< CloudType >::relaxSources().

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare(), and KinematicCloud< CloudType >::relax().

Here is the call graph for this function:

Here is the caller graph for this function:

void relaxSources ( const KinematicCloud< CloudType > &  cloudOldTime)

Apply relaxation to (steady state) cloud sources.

Definition at line 638 of file KinematicCloud.C.

References relax(), KinematicCloud< CloudType >::UCoeff(), and KinematicCloud< CloudType >::UTrans().

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare(), and KinematicCloud< CloudType >::scale().

Here is the call graph for this function:

Here is the caller graph for this function:

void scaleSources ( )

Apply scaling to (transient) cloud sources.

Definition at line 648 of file KinematicCloud.C.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the caller graph for this function:

void preEvolve ( )

Pre-evolve.

Definition at line 656 of file KinematicCloud.C.

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

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the call graph for this function:

Here is the caller graph for this function:

void evolve ( )

Evolve the cloud.

Definition at line 676 of file KinematicCloud.C.

References solve().

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the call graph for this function:

Here is the caller graph for this function:

void motion ( TrackData &  td)

Particle motion.

Definition at line 690 of file KinematicCloud.C.

References KinematicCloud< CloudType >::patchData().

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the call graph for this function:

Here is the caller graph for this function:

void patchData ( const parcelType p,
const polyPatch pp,
const scalar  trackFraction,
const tetIndices tetIs,
vector normal,
vector Up 
) const

Calculate the patch normal and velocity to interact with,.

accounting for patch motion if required.

Definition at line 701 of file KinematicCloud.C.

References Foam::asin(), GeometricField< Type, PatchField, GeoMesh >::boundaryField(), Vector< Cmpt >::centre(), tetIndices::faceTri(), patchIdentifier::index(), Foam::mag(), n, triangle< Point, PointRef >::normal(), tetIndices::oldFaceTri(), U, and polyPatch::whichFace().

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare(), and KinematicCloud< CloudType >::motion().

Here is the call graph for this function:

Here is the caller graph for this function:

void updateMesh ( )

Update mesh.

Definition at line 846 of file KinematicCloud.C.

References Foam::cbrt().

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the call graph for this function:

Here is the caller graph for this function:

void autoMap ( const mapPolyMesh mapper)
virtual

Remap the cells of particles corresponding to the.

mesh topology change with a default tracking data object

Reimplemented from DSMCCloud< ParcelType >.

Definition at line 855 of file KinematicCloud.C.

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the caller graph for this function:

void info ( )

Print cloud information.

Definition at line 868 of file KinematicCloud.C.

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

Referenced by KinematicCloud< Foam::DSMCCloud >::cloneBare().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

const fvMesh& mesh_
protected

References to the mesh and time databases.

Definition at line 144 of file KinematicCloud.H.

IOdictionary particleProperties_
protected

Dictionary of particle properties.

Definition at line 147 of file KinematicCloud.H.

IOdictionary outputProperties_
protected

Dictionary of output properties.

Definition at line 150 of file KinematicCloud.H.

cloudSolution solution_
protected

Solution properties.

Definition at line 153 of file KinematicCloud.H.

parcelType::constantProperties constProps_
protected

Parcel constant properties.

Definition at line 156 of file KinematicCloud.H.

const dictionary subModelProperties_
protected

Sub-models dictionary.

Definition at line 159 of file KinematicCloud.H.

cachedRandom rndGen_
protected

Random number generator - used by some injection routines.

Definition at line 162 of file KinematicCloud.H.

Referenced by KinematicCloud< CloudType >::cloudReset().

autoPtr<List<DynamicList<parcelType*> > > cellOccupancyPtr_
protected

Cell occupancy information for each parcel, (demand driven)

Definition at line 165 of file KinematicCloud.H.

scalarField cellLengthScale_
protected

Cell length scale.

Definition at line 168 of file KinematicCloud.H.

const volScalarField& rho_
protected

Density [kg/m3].

Definition at line 174 of file KinematicCloud.H.

const volVectorField& U_
protected

Velocity [m/s].

Definition at line 177 of file KinematicCloud.H.

const volScalarField& mu_
protected

Dynamic viscosity [Pa.s].

Definition at line 180 of file KinematicCloud.H.

const dimensionedVector& g_
protected

Gravity.

Definition at line 186 of file KinematicCloud.H.

scalar pAmbient_
protected

Averaged ambient domain pressure.

Definition at line 189 of file KinematicCloud.H.

forceType forces_
protected

Optional particle forces.

Definition at line 193 of file KinematicCloud.H.

Referenced by KinematicCloud< CloudType >::cloudReset().

functionType functions_
protected

Optional cloud function objects.

Definition at line 196 of file KinematicCloud.H.

Referenced by KinematicCloud< CloudType >::cloudReset().

InjectionModelList<KinematicCloud<CloudType> > injectors_
protected

Injector models.

Definition at line 202 of file KinematicCloud.H.

Referenced by KinematicCloud< CloudType >::cloudReset().

autoPtr<DispersionModel<KinematicCloud<CloudType> > > dispersionModel_
protected

Dispersion model.

Definition at line 206 of file KinematicCloud.H.

Referenced by KinematicCloud< CloudType >::cloudReset().

autoPtr<PatchInteractionModel<KinematicCloud<CloudType> > > patchInteractionModel_
protected

Patch interaction model.

Definition at line 210 of file KinematicCloud.H.

Referenced by KinematicCloud< CloudType >::cloudReset().

autoPtr<StochasticCollisionModel<KinematicCloud<CloudType> > > stochasticCollisionModel_
protected

Stochastic collision model.

Definition at line 214 of file KinematicCloud.H.

Referenced by KinematicCloud< CloudType >::cloudReset().

autoPtr<SurfaceFilmModel<KinematicCloud<CloudType> > > surfaceFilmModel_
protected

Surface film model.

Definition at line 218 of file KinematicCloud.H.

Referenced by KinematicCloud< CloudType >::cloudReset().

autoPtr<vectorIntegrationScheme> UIntegrator_
protected

Velocity integration.

Definition at line 224 of file KinematicCloud.H.

Referenced by KinematicCloud< CloudType >::cloudReset().

autoPtr<DimensionedField<vector, volMesh> > UTrans_
protected

Momentum.

Definition at line 230 of file KinematicCloud.H.

autoPtr<DimensionedField<scalar, volMesh> > UCoeff_
protected

Coefficient for carrier phase U equation.

Definition at line 233 of file KinematicCloud.H.


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