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

Templated base class for spray cloud. More...

Inheritance diagram for SprayCloud< CloudType >:
Inheritance graph
[legend]
Collaboration diagram for SprayCloud< 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 SprayCloud< CloudTypesprayCloudType
 Convenience typedef for this cloud 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 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...
 
enum  fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Enumeration defining the file checking 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< LListBase, T >
typedef T value_type
 Type of values the DLList contains. More...
 
typedef Treference
 Type that can be used for storing into DLList::value_type. More...
 
typedef const Tconst_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 LListBase::iterator LListBase_iterator
 
typedef LListBase::const_iterator LListBase_const_iterator
 

Public Member Functions

 SprayCloud (const word &cloudName, const volScalarField &rho, const volVectorField &U, const dimensionedVector &g, const SLGThermo &thermo, bool readFields=true)
 Construct given carrier gas fields. More...
 
 SprayCloud (SprayCloud< CloudType > &c, const word &name)
 Copy constructor with new name. More...
 
 SprayCloud (const fvMesh &mesh, const word &name, const SprayCloud< 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 ~SprayCloud ()
 Destructor. More...
 
const SprayCloudcloudCopy () const
 Return a reference to the cloud copy. More...
 
scalar averageParcelMass () const
 Return const-access to the average parcel mass. More...
 
scalar penetration (const scalar fraction) const
 Penetration for fraction [0-1] of the current total mass. More...
 
const AtomizationModel< SprayCloud< CloudType > > & atomization () const
 Return const-access to the atomization model. More...
 
AtomizationModel< SprayCloud< CloudType > > & atomization ()
 Return reference to the atomization model. More...
 
const BreakupModel< SprayCloud< CloudType > > & breakup () const
 Return const-access to the breakup model. More...
 
BreakupModel< SprayCloud< CloudType > > & breakup ()
 Return reference to the breakup model. 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 evolve ()
 Evolve the spray (inject, move) 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 references 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 references to the random object. More...
 
volScalarField::Boundary & qBF ()
 Return non-const heat flux boundary field reference. More...
 
volVectorField::Boundary & fDBF ()
 Return non-const force density at boundary field reference. More...
 
volScalarField::Boundary & rhoNBF ()
 Return non-const number density boundary field reference. More...
 
volScalarField::Boundary & rhoMBF ()
 Return non-const mass density boundary field reference. More...
 
volScalarField::Boundary & linearKEBF ()
 Return non-const linear kinetic energy density boundary. More...
 
volScalarField::Boundary & internalEBF ()
 Return non-const internal energy density boundary field. More...
 
volScalarField::Boundary & iDofBF ()
 Return non-const internal degree of freedom density boundary. More...
 
volVectorField::Boundary & 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 label celli, const vector &U, const scalar Ei, const label typeId)
 Add new parcel. More...
 
void evolve ()
 Evolve the cloud (move, collide) More...
 
void clear ()
 Clear the Cloud. More...
 
virtual void autoMap (const mapPolyMesh &)
 Remap the particles to the correct cells following mesh change. More...
 
- Public Member Functions inherited from Cloud< ParcelType >
 TypeName ("Cloud")
 Runtime type information. More...
 
 Cloud (const polyMesh &mesh, const word &cloudName, const IDLList< ParcelType > &particles)
 Construct from mesh and a list of particles. 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
 Return the number of particles in the cloud. 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 deleteLostParticles ()
 Remove lost particles from cloud and delete. More...
 
void cloudReset (const Cloud< ParcelType > &c)
 Reset the particles. More...
 
void move (TrackCloudType &cloud, typename ParcelType ::trackingData &td, const scalar trackTime)
 Move the particles. More...
 
void autoMap (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 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 bool valid) const
 Write using given format, version and compression. More...
 
void writePositions () const
 Write positions to <cloudName>_positions.obj file. More...
 
void storeGlobalPositions () const
 Call this before a topology change. Stores the particles global. More...
 
- Public Member Functions inherited from cloud
 TypeName ("cloud")
 Runtime type information. More...
 
 cloud (const objectRegistry &, const word &cloudName=defaultName)
 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...
 
template<class Type >
Type & lookupObjectRef (const word &name) const
 Lookup and return the object reference 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...
 
void clear ()
 Remove all regIOobject owned by the 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, transferring 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...
 
virtual void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) 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...
 
virtual fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool headerOk ()
 Read and check header info. More...
 
IstreamreadStream (const word &, const bool valid=true)
 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...
 
virtual label addWatch (const fileName &)
 Add file watch for fileName on object if not yet watched. Return. More...
 
const labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. More...
 
virtual bool write (const bool valid=true) const
 Write using setting from DB. More...
 
virtual bool global () const
 Is object global. 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, bool globalObject=false)
 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, bool globalObject=false)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Construct from copy resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Construct from copy resetting name. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. 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...
 
wordheaderClassName ()
 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...
 
bool & globalObject ()
 Is object same for all processors. More...
 
bool globalObject () const
 Is object same for all processors. 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 localFilePath (const word &typeName) const
 Helper for filePath that searches locally. More...
 
fileName globalFilePath (const word &typeName) const
 Helper for filePath that searches up if in parallel. More...
 
bool readHeader (Istream &)
 Read header. More...
 
template<class Type >
bool typeHeaderOk (const bool checkType=true)
 Read header (uses typeFilePath to find file) and check header. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. 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 (std::initializer_list< Tuple2< word, regIOobject * >>)
 Construct from an initializer list. 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...
 
Foam::label erase (const HashTable< AnyType, word, AnyHash > &rhs)
 
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...
 
void operator= (std::initializer_list< Tuple2< word, regIOobject * >>)
 Assignment to an initializer list. 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 ILList< LListBase, T >
 ILList ()
 Null construct. More...
 
 ILList (T *a)
 Construct given initial T. More...
 
 ILList (Istream &)
 Construct from Istream. More...
 
 ILList (const ILList< LListBase, T > &)
 Construct as copy. More...
 
template<class CloneArg >
 ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone. More...
 
template<class INew >
 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 (T *p)
 Remove the specified element from the list and delete it. More...
 
void clear ()
 Clear the contents of the list. More...
 
void transfer (ILList< LListBase, T > &)
 Transfer the contents of the argument into this List. More...
 
void operator= (const ILList< LListBase, T > &)
 Assignment operator. More...
 
- Public Member Functions inherited from UILList< LListBase, T >
 UILList ()
 Null construct. More...
 
 UILList (T *a)
 Construct given initial T. More...
 
 UILList (const UILList< LListBase, T > &)
 Construct as copy. More...
 
Tfirst ()
 Return the first entry. More...
 
const Tfirst () const
 Return the first entry. More...
 
Tlast ()
 Return the last entry. More...
 
const Tlast () const
 Return the last entry. More...
 
TremoveHead ()
 Remove and return head. More...
 
Tremove (T *p)
 Remove and return element. More...
 
Tremove (iterator &it)
 Remove and return specified by iterator. More...
 
void operator= (const UILList< LListBase, T > &)
 
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
 
bool operator== (const UILList< LListBase, T > &) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UILList< LListBase, T > &) const
 The opposite of the equality operation. Takes linear time. More...
 
- 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 sprayCloud
 TypeName ("sprayCloud")
 Runtime type information. More...
 
 sprayCloud ()
 Null constructor. More...
 
virtual ~sprayCloud ()
 Destructor. More...
 

Protected Member Functions

void setModels ()
 Set cloud sub-models. More...
 
void cloudReset (SprayCloud< CloudType > &c)
 Reset state of cloud. More...
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstream::streamFormat PstreamFormat, const word &typeName)
 Helper: check readOpt flags and read if necessary. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &)
 Set the object state to bad. More...
 

Protected Attributes

autoPtr< AtomizationModel< SprayCloud< CloudType > > > atomizationModel_
 Atomization model. More...
 
autoPtr< BreakupModel< SprayCloud< CloudType > > > breakupModel_
 Break-up model. 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)
 
static word group (const word &name)
 Return group (extension part of name) More...
 
static word member (const word &name)
 Return member (name without the extension) More...
 
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 float fileModificationSkew
 
- Static Public Attributes inherited from IOobject
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 
- 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::SprayCloud< CloudType >

Templated base class for spray cloud.

- sub-models:

Definition at line 57 of file SprayCloud.H.

Member Typedef Documentation

◆ cloudType

Type of cloud this cloud was instantiated for.

Definition at line 67 of file SprayCloud.H.

◆ parcelType

Type of parcel the cloud was instantiated for.

Definition at line 70 of file SprayCloud.H.

◆ sprayCloudType

Convenience typedef for this cloud type.

Definition at line 73 of file SprayCloud.H.

Constructor & Destructor Documentation

◆ SprayCloud() [1/3]

SprayCloud ( const word cloudName,
const volScalarField rho,
const volVectorField U,
const dimensionedVector g,
const SLGThermo thermo,
bool  readFields = true 
)

Construct given carrier gas fields.

Definition at line 72 of file SprayCloud.C.

◆ SprayCloud() [2/3]

SprayCloud ( SprayCloud< CloudType > &  c,
const word name 
)

Copy constructor with new name.

Definition at line 112 of file SprayCloud.C.

◆ SprayCloud() [3/3]

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

Copy constructor with new name - creates bare cloud.

Definition at line 128 of file SprayCloud.C.

◆ ~SprayCloud()

~SprayCloud ( )
virtual

Destructor.

Definition at line 146 of file SprayCloud.C.

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

Here is the caller graph for this function:

Member Function Documentation

◆ setModels()

void setModels ( )
protected

Set cloud sub-models.

Definition at line 33 of file SprayCloud.C.

◆ cloudReset()

void cloudReset ( SprayCloud< CloudType > &  c)
protected

Reset state of cloud.

Definition at line 57 of file SprayCloud.C.

Referenced by SprayCloud< Foam::DSMCCloud >::setModels().

Here is the caller graph for this function:

◆ clone()

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

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

Definition at line 152 of file SprayCloud.H.

◆ cloneBare()

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

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

Definition at line 161 of file SprayCloud.H.

◆ cloudCopy()

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

Return a reference to the cloud copy.

Definition at line 30 of file SprayCloudI.H.

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

Here is the caller graph for this function:

◆ averageParcelMass()

Foam::scalar averageParcelMass ( ) const
inline

Return const-access to the average parcel mass.

Definition at line 69 of file SprayCloudI.H.

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

Here is the caller graph for this function:

◆ penetration()

Foam::scalar penetration ( const scalar  fraction) const
inline

Penetration for fraction [0-1] of the current total mass.

Definition at line 77 of file SprayCloudI.H.

Referenced by SprayCloud< Foam::DSMCCloud >::averageParcelMass(), and SprayCloud< Foam::DSMCCloud >::cloneBare().

Here is the caller graph for this function:

◆ atomization() [1/2]

const Foam::AtomizationModel< Foam::SprayCloud< CloudType > > & atomization ( ) const
inline

Return const-access to the atomization model.

Definition at line 38 of file SprayCloudI.H.

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

Here is the caller graph for this function:

◆ atomization() [2/2]

Foam::AtomizationModel< Foam::SprayCloud< CloudType > > & atomization ( )
inline

Return reference to the atomization model.

Definition at line 46 of file SprayCloudI.H.

◆ breakup() [1/2]

const Foam::BreakupModel< Foam::SprayCloud< CloudType > > & breakup ( ) const
inline

Return const-access to the breakup model.

Definition at line 54 of file SprayCloudI.H.

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

Here is the caller graph for this function:

◆ breakup() [2/2]

Foam::BreakupModel< Foam::SprayCloud< CloudType > > & breakup ( )
inline

Return reference to the breakup model.

Definition at line 62 of file SprayCloudI.H.

◆ setParcelThermoProperties()

void setParcelThermoProperties ( parcelType parcel,
const scalar  lagrangianDt 
)

Set parcel thermo properties.

Definition at line 154 of file SprayCloud.C.

Referenced by SprayCloud< Foam::DSMCCloud >::cloneBare(), and SprayCloud< Foam::DSMCCloud >::~SprayCloud().

Here is the caller graph for this function:

◆ checkParcelProperties()

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

Check parcel properties.

Definition at line 177 of file SprayCloud.C.

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

Here is the caller graph for this function:

◆ storeState()

void storeState ( )

Store the current cloud state.

Definition at line 197 of file SprayCloud.C.

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

Here is the caller graph for this function:

◆ restoreState()

void restoreState ( )

Reset the current cloud to the previously stored state.

Definition at line 210 of file SprayCloud.C.

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

Here is the caller graph for this function:

◆ evolve()

void evolve ( )

Evolve the spray (inject, move)

Definition at line 218 of file SprayCloud.C.

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

Here is the caller graph for this function:

◆ info()

void info ( )

Print cloud information.

Definition at line 230 of file SprayCloud.C.

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

Here is the caller graph for this function:

Member Data Documentation

◆ atomizationModel_

autoPtr<AtomizationModel<SprayCloud<CloudType> > > atomizationModel_
protected

Atomization model.

Definition at line 104 of file SprayCloud.H.

Referenced by SprayCloud< Foam::DSMCCloud >::cloudReset().

◆ breakupModel_

autoPtr<BreakupModel<SprayCloud<CloudType> > > breakupModel_
protected

Break-up model.

Definition at line 107 of file SprayCloud.H.

Referenced by SprayCloud< Foam::DSMCCloud >::cloudReset().


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