FreeFOAM The Cross-Platform CFD Toolkit
spray Class Reference

A spray is a cloud of parcels. More...

#include <dieselSpray/spray.H>


Detailed Description

A spray is a cloud of parcels.

Definition at line 66 of file spray.H.

+ Inheritance diagram for spray:
+ Collaboration diagram for spray:

List of all members.

Public Member Functions

 spray (const volVectorField &U, const volScalarField &rho, const volScalarField &p, const volScalarField &T, const basicMultiComponentMixture &composition, const PtrList< gasThermoPhysics > &gasProperties, const dictionary &thermophysicalProperties, const dimensionedVector &g, bool readFields=true)
 Construct from components.
 ~spray ()
void evolve ()
 Evolve the spray (move, inject and breakup)
void move ()
 Move the spray parcels.
void inject ()
 Inject more parcels.
void atomizationLoop ()
 Primary breakup droplets.
void breakupLoop ()
 Secondary breakup droplets.
const TimerunTime () const
const fvMeshmesh () const
const volVectorFieldU () const
const volScalarFieldrho () const
const volScalarFieldp () const
const volScalarFieldT () const
PtrList< injector > & injectors ()
const PtrList< injector > & injectors () const
const atomizationModelatomization () const
const breakupModelbreakup () const
const collisionModelcollisions () const
const dispersionModeldispersion () const
const dragModeldrag () const
const evaporationModelevaporation () const
const heatTransferModelheatTransfer () const
const injectorModelinjection () const
const wallModelwall () const
tmp< volVectorFieldmomentumSource () const
tmp< volScalarFieldevaporationSource (const label i) const
tmp< volScalarFieldheatTransferSource () const
RandomrndGen ()
label subCycles () const
const vectorg () const
const liquidMixturefuels () const
const PtrList< gasThermoPhysics > & gasProperties () const
const basicMultiComponentMixturecomposition () const
const List< label > & liquidToGasIndex () const
const List< label > & gasToLiquidIndex () const
const List< bool > & isLiquidFuel () const
const bool & twoD () const
const vectoraxisOfSymmetry () const
const vectoraxisOfWedge () const
const vectoraxisOfWedgeNormal () const
const scalar & angleOfWedge () const
const interpolation< vector > & UInterpolator () const
const interpolation< scalar > & rhoInterpolator () const
const interpolation< scalar > & pInterpolator () const
const interpolation< scalar > & TInterpolator () const
vectorFieldsms ()
const vectorFieldsms () const
scalarFieldshs ()
const scalarFieldshs () const
PtrList< scalarField > & srhos ()
const PtrList< scalarField > & srhos () const
const scalar & ambientPressure () const
const scalar & ambientTemperature () const
scalar injectedMass (const scalar t) const
 Returns the liquid mass that has been injected.
scalar totalMassToInject () const
 Returns the liquid mass that will be injected by the injectors.
scalar injectedEnthalpy (const scalar t) const
 Returns the injected enthalpy.
scalar liquidMass () const
 Returns current total liquid mass in the domain.
scalar liquidEnthalpy () const
 Returns the enthalpy of all the liquid in the domain.
scalar liquidTotalEnthalpy () const
 Returns the enthalpy (total) of all the liquid in the domain.
scalar liquidKineticEnergy () const
 Returns the kinetic energy of the liquid phase.
scalar injectedLiquidKineticEnergy () const
 Returns the injected kinetic energy of the liquid phase.
scalar liquidPenetration (const label nozzlei, const scalar prc) const
 Returns the droplet penetration for 'prc' percent of the.
scalar liquidPenetration (const scalar prc) const
 Returns the droplet penetration for 'prc' percent of the.
scalar smd () const
 Return Sauter Mean Diameter.
scalar maxD () const
 Return Maximum Diameter.
void calculateAmbientPressure ()
 Return Ambient Pressure.
void calculateAmbientTemperature ()
 Return Ambient Temperature.
- Public Member Functions inherited from Cloud< parcel >
 TypeName ("Cloud")
 Runtime type information.
 Cloud (const polyMesh &mesh, const IDLList< parcel > &particles)
 Construct from mesh and a list of particles.
 Cloud (const polyMesh &mesh, const word &cloudName, const IDLList< parcel > &particles)
 Construct from mesh, cloud name, and a list of particles.
 Cloud (const polyMesh &mesh, const bool checkClass=true)
 Construct from mesh by reading from file.
 Cloud (const polyMesh &pMesh, const word &cloudName, const bool checkClass=true)
 Construct from mesh by reading from file with given cloud instance.
const polyMeshpMesh () const
 Return the polyMesh reference.
bool internalFace (const label facei) const
 Is this global face an internal face?
bool boundaryFace (const label facei) const
 Is this global face a boundary face?
label facePatch (const label facei) const
 Which patch is this global face on.
label patchFace (const label patchi, const label facei) const
 Which face of this patch is this global face.
label size () const
 Return number of elements in table.
const const_iterator begin () const
 const_iterator set to the beginning of the HashTable
iterator begin ()
 iterator set to the begining of the HashTable
const const_iterator cbegin () const
 const_iterator set to the beginning of the HashTable
const const_iterator end () const
 const_iterator set to beyond the end of the HashTable
iterator end ()
 iterator set to beyond the end of the HashTable
const const_iterator cend () const
 const_iterator set to beyond the end of the HashTable
void clear ()
 Clear the contents of the list.
label getNewParticleID () const
 Get unique particle creation id.
void addParticle (parcel *pPtr)
 Transfer particle to cloud.
void deleteParticle (parcel &)
 Remove particle from cloud and delete.
void move (TrackingData &td)
 Move the particles.
virtual void autoMap (const mapPolyMesh &)
 Remap the cells of particles corresponding to the.
IOobject fieldIOobject (const word &fieldName, const IOobject::readOption r) const
 Helper to construct IOobject for field and current time.
void checkFieldIOobject (const Cloud< parcel > &c, const IOField< DataType > &data) const
 Check lagrangian data field.
virtual void readFields ()
 Read the field data for the cloud of particles. Dummy at.
virtual void writeFields () const
 Write the field data for the cloud of particles Dummy at.
virtual bool writeObject (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::compressionType cmp) const
 Write using given format, version and compression.
void writePositions () const
 Write positions to <cloudName>_positions.obj file.
- Public Member Functions inherited from cloud
 TypeName ("cloud")
 Runtime type information.
 cloud (const objectRegistry &, const word &cloudName="")
 Construct for the given objectRegistry and named cloud instance.
virtual ~cloud ()
 Destructor.
- Public Member Functions inherited from objectRegistry
 TypeName ("objectRegistry")
 Declare type name for this IOobject.
 objectRegistry (const Time &db, const label nIoObjects=128)
 Construct the time objectRegistry given an initial estimate.
 objectRegistry (const IOobject &io, const label nIoObjects=128)
 Construct a sub-registry given an IObject to describe the registry.
virtual ~objectRegistry ()
const Timetime () const
 Return time.
const objectRegistryparent () const
 Return the parent objectRegistry.
virtual const fileNamedbDir () const
 Local directory path of this objectRegistry relative to the time.
wordList names () const
 Return the list of names of the IOobjects.
wordList names (const word &className) const
 Return the list of names of the IOobjects of given class name.
template<class Type >
wordList names () const
 Return the list of names of the IOobjects of given type.
const objectRegistrysubRegistry (const word &name) const
 Lookup and return a const sub-objectRegistry.
template<class Type >
HashTable< const Type * > lookupClass () const
 Lookup and return all the object of the given Type.
template<class Type >
bool foundObject (const word &name) const
 Is the named Type.
template<class Type >
const Type & lookupObject (const word &name) const
 Lookup and return the object of the given Type.
label getEvent () const
 Return new event number.
virtual void rename (const word &newName)
 Rename.
bool checkIn (regIOobject &) const
 Add an regIOobject to registry.
bool checkOut (regIOobject &) const
 Remove an regIOobject from registry.
virtual bool modified () const
 Return true if any of the object's files have been modified.
void readModifiedObjects ()
 Read the objects that have been modified.
virtual bool readIfModified ()
 Read object if modified.
virtual bool writeData (Ostream &) const
 writeData function required by regIOobject but not used
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information.
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the.
 regIOobject (const regIOobject &)
 Construct as copy.
 regIOobject (const regIOobject &, bool registerCopy)
 Construct as copy, and transferring registry registration to copy.
virtual ~regIOobject ()
bool checkIn ()
 Add object to registry.
bool checkOut ()
 Remove object from registry.
bool ownedByRegistry () const
 Is this object owned by the registry?
void store ()
 Transfer ownership of this object to its registry.
void release ()
 Release ownership of this object from its registry.
label eventNo () const
 Event number at last update.
label & eventNo ()
 Event number at last update.
bool upToDate (const word &) const
 Am I uptodate with respect to other regIOobjects.
bool upToDate (const word &, const word &) const
bool upToDate (const word &, const word &, const word &) const
bool upToDate (const word &, const word &, const word &, const word &) const
void setUpToDate ()
 Flag me as up to date.
IstreamreadStream (const word &)
 Return Istream and check object type against that given.
void close ()
 Close Istream.
virtual bool readData (Istream &)
 Virtual readData function.
virtual bool read ()
 Read object.
virtual bool write () const
 Write using setting from DB.
void operator= (const IOobject &)
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information.
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, registry, io options.
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, local, registry, io options.
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options.
Foam::autoPtr< IOobjectclone () const
 Clone.
virtual ~IOobject ()
const objectRegistrydb () const
 Return the local objectRegistry.
const wordname () const
 Return name.
const wordheaderClassName () const
 Return name of the class name read from header.
stringnote ()
 Return non-constant access to the optional note.
const stringnote () const
 Return the optional note.
bool registerObject () const
 Register object created from this IOobject with registry if true.
readOption readOpt () const
readOptionreadOpt ()
writeOption writeOpt () const
writeOptionwriteOpt ()
const fileNamerootPath () const
const fileNamecaseName () const
const fileNameinstance () const
fileNameinstance ()
const fileNamelocal () const
fileName path () const
 Return complete path.
fileName path (const word &instance, const fileName &local="") const
 Return complete path with alternative instance and local.
fileName objectPath () const
 Return complete path + object name.
fileName filePath () const
 Return complete path + object name if the file exists.
bool readHeader (Istream &)
 Read header.
bool headerOk ()
 Read and check header info.
bool writeHeader (Ostream &) const
 Write header.
bool good () const
bool bad () const
InfoProxy< IOobjectinfo () const
 Return info proxy.
- Public Member Functions inherited from HashTable< regIOobject * >
bool set (const word &, const regIOobject *&newElmt)
 Assign a new hashedEntry, overwriting existing entries.
 HashTable (const label size=128)
 Construct given initial table size.
 HashTable (Istream &, const label size=128)
 Construct from Istream.
 HashTable (const HashTable< regIOobject *, word, string::hash > &)
 Construct as copy.
 HashTable (const Xfer< HashTable< regIOobject *, word, string::hash > > &)
 Construct by transferring the parameter contents.
 ~HashTable ()
bool empty () const
 Return true if the hash table is empty.
bool found (const word &) const
 Return true if hashedEntry is found in table.
iterator find (const word &)
 Find and return an iterator set at the hashedEntry.
const_iterator find (const word &) const
 Find and return an const_iterator set at the hashedEntry.
List< wordtoc () const
 Return the table of contents.
List< wordsortedToc () const
 Return the table of contents as a sorted list.
OstreamprintInfo (Ostream &) const
 Print information.
bool insert (const word &, const regIOobject *&newElmt)
 Insert a new hashedEntry.
bool erase (const iterator &)
 Erase an hashedEntry specified by given iterator.
bool erase (const word &)
 Erase an hashedEntry specified by given key if in table.
label erase (const UList< word > &)
 Remove entries given by the listed keys from this HashTable.
label erase (const HashTable< AnyType, word, AnyHash > &)
 Remove entries given by the given keys from this HashTable.
void resize (const label newSize)
 Resize the hash table for efficiency.
void clearStorage ()
 Clear the table entries and the table itself.
void transfer (HashTable< regIOobject *, word, string::hash > &)
 Transfer the contents of the argument table into this table.
Xfer< HashTable< regIOobject
*, word, string::hash > > 
xfer ()
 Transfer contents to the Xfer container.
regIOobject *& operator[] (const word &)
 Find and return an hashedEntry.
const regIOobject *& operator[] (const word &) const
 Find and return an hashedEntry.
regIOobject *& operator() (const word &)
 Find and return an hashedEntry, create it null if not present.
void operator= (const HashTable< regIOobject *, word, string::hash > &)
 Assignment.
bool operator== (const HashTable< regIOobject *, word, string::hash > &) const
 Equality. Two hash tables are equal if all contents of first are.
bool operator!= (const HashTable< regIOobject *, word, string::hash > &) const
 The opposite of the equality operation. Takes linear time.
- Public Member Functions inherited from IDLList< parcel >
 IDLList ()
 Null construct.
 IDLList (const parcel &a)
 Construct given initial T.
 IDLList (Istream &is, const INew &inewt)
 Construct from Istream using given Istream constructor class.
 IDLList (Istream &is)
 Construct from Istream.
 IDLList (const IDLList< parcel > &idll, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone.
- Public Member Functions inherited from ILList< DLListBase, parcel >
 ILList ()
 Null construct.
 ILList (parcel *a)
 Construct given initial T.
 ILList (Istream &)
 Construct from Istream.
 ILList (const ILList< DLListBase, parcel > &)
 Construct as copy.
 ILList (const ILList< DLListBase, parcel > &lst, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone.
 ILList (Istream &, const INew &)
 Construct from Istream using given Istream constructor class.
 ~ILList ()
bool eraseHead ()
 Remove the head element specified from the list and delete it.
bool erase (parcel *p)
 Remove the specified element from the list and delete it.
void transfer (ILList< DLListBase, parcel > &)
 Transfer the contents of the argument into this List.
void operator= (const ILList< DLListBase, parcel > &)
- Public Member Functions inherited from UILList< DLListBase, parcel >
 UILList ()
 Null construct.
 UILList (parcel *a)
 Construct given initial T.
 UILList (const UILList< DLListBase, parcel > &)
 Construct as copy.
parcelfirst ()
 Return the first entry.
const parcelfirst () const
 Return the first entry.
parcellast ()
 Return the last entry.
const parcellast () const
 Return the last entry.
parcelremoveHead ()
 Remove and return head.
parcelremove (parcel *p)
 Remove and return element.
parcelremove (iterator &it)
 Remove and return specified by iterator.
void operator= (const UILList< DLListBase, parcel > &)
bool operator== (const UILList< DLListBase, parcel > &) const
 Equality operation on ULists of the same type.
bool operator!= (const UILList< DLListBase, parcel > &) const
 The opposite of the equality operation. Takes linear time.
- Public Member Functions inherited from DLListBase
 DLListBase ()
 Null construct.
 DLListBase (link *)
 Construct given initial entry.
 ~DLListBase ()
bool empty () const
 Return true if the list is empty.
void insert (link *)
 Add at head of list.
void append (link *)
 Add at tail of list.
bool swapUp (link *)
 Swap this element with the one above unless it is at the top.
bool swapDown (link *)
 Swap this element with the one below unless it is at the bottom.
linkremove (link *)
 Remove and return element.
linkreplace (link *oldLink, link *newLink)
 Replace oldLink with newLink and return element.
linkreplace (iterator &oldIter, link *newLink)
 Replace oldIter with newLink and return element.
void transfer (DLListBase &)
 Transfer the contents of the argument into this List.

Additional Inherited Members

- Public Types inherited from Cloud< parcel >
typedef parcel particleType
typedef IDLList< parcel >::iterator iterator
typedef IDLList< parcel >
::const_iterator 
const_iterator
- Static Public Attributes inherited from Cloud< parcel >
static word cloudPropertiesName
 Name of cloud properties dictionary.
- Static Public Attributes inherited from cloud
static const word prefix
 The prefix to local: lagrangian.
static word defaultName
 The default cloud name: defaultCloud.

Constructor & Destructor Documentation

spray ( const volVectorField U,
const volScalarField rho,
const volScalarField p,
const volScalarField T,
const basicMultiComponentMixture composition,
const PtrList< gasThermoPhysics > &  gasProperties,
const dictionary thermophysicalProperties,
const dimensionedVector g,
bool  readFields = true 
)

Construct from components.

~spray ( )

Definition at line 357 of file spray.C.


Member Function Documentation

void move ( )

Move the spray parcels.

Definition at line 75 of file sprayOps.C.

References forAll, and Vector< scalar >::zero.

Referenced by spray::evolve().

const fvMesh & mesh ( ) const
inline

Definition at line 39 of file sprayI.H.

Referenced by parcel::move().

const volScalarField & rho ( ) const
inline

Definition at line 51 of file sprayI.H.

Referenced by spray::liquidTotalEnthalpy(), and spray::smd().

const volScalarField & T ( ) const
inline

Definition at line 63 of file sprayI.H.

Referenced by spray::liquidEnthalpy(), spray::liquidTotalEnthalpy(), and spray::smd().

const PtrList< injector > & injectors ( ) const
inline

Definition at line 75 of file sprayI.H.

const atomizationModel & atomization ( ) const
inline

Definition at line 81 of file sprayI.H.

Referenced by spray::atomizationLoop().

const breakupModel & breakup ( ) const
inline

Definition at line 87 of file sprayI.H.

Referenced by spray::breakupLoop(), and spray::inject().

const collisionModel & collisions ( ) const
inline

Definition at line 93 of file sprayI.H.

Referenced by spray::evolve().

const dispersionModel & dispersion ( ) const
inline

Definition at line 99 of file sprayI.H.

Referenced by spray::evolve().

const dragModel & drag ( ) const
inline

Definition at line 105 of file sprayI.H.

const evaporationModel & evaporation ( ) const
inline

Definition at line 111 of file sprayI.H.

const heatTransferModel & heatTransfer ( ) const
inline

Definition at line 117 of file sprayI.H.

const injectorModel & injection ( ) const
inline

Definition at line 123 of file sprayI.H.

Referenced by spray::inject().

const wallModel & wall ( ) const
inline

Definition at line 129 of file sprayI.H.

tmp< volScalarField > evaporationSource ( const label  i) const
inline
tmp< volScalarField > heatTransferSource ( ) const
inline
Random & rndGen ( )
inline
label subCycles ( ) const
inline

Definition at line 230 of file sprayI.H.

Referenced by parcel::move().

const vector & g ( ) const
inline

Definition at line 236 of file sprayI.H.

const PtrList< gasThermoPhysics > & gasProperties ( ) const
inline

Definition at line 248 of file sprayI.H.

Referenced by spray::liquidEnthalpy(), spray::liquidTotalEnthalpy(), and parcel::move().

const basicMultiComponentMixture & composition ( ) const
inline

Definition at line 254 of file sprayI.H.

Referenced by parcel::move().

const List< label > & liquidToGasIndex ( ) const
inline

Definition at line 260 of file sprayI.H.

Referenced by parcel::move().

const List< label > & gasToLiquidIndex ( ) const
inline

Definition at line 266 of file sprayI.H.

Referenced by parcel::move().

const List< bool > & isLiquidFuel ( ) const
inline

Definition at line 272 of file sprayI.H.

Referenced by parcel::move().

const vector & axisOfSymmetry ( ) const
inline

Definition at line 284 of file sprayI.H.

Referenced by parcel::move().

const vector & axisOfWedge ( ) const
inline

Definition at line 290 of file sprayI.H.

const vector & axisOfWedgeNormal ( ) const
inline

Definition at line 296 of file sprayI.H.

const scalar & angleOfWedge ( ) const
inline
const interpolation< vector > & UInterpolator ( ) const
inline

Definition at line 308 of file sprayI.H.

Referenced by spray::atomizationLoop(), spray::breakupLoop(), and parcel::move().

const interpolation< scalar > & rhoInterpolator ( ) const
inline

Definition at line 314 of file sprayI.H.

Referenced by parcel::move().

const interpolation< scalar > & pInterpolator ( ) const
inline

Definition at line 320 of file sprayI.H.

Referenced by parcel::move().

const interpolation< scalar > & TInterpolator ( ) const
inline

Definition at line 326 of file sprayI.H.

Referenced by parcel::move().

vectorField & sms ( )
inline

Definition at line 332 of file sprayI.H.

Referenced by parcel::move().

const vectorField & sms ( ) const
inline

Definition at line 338 of file sprayI.H.

scalarField & shs ( )
inline

Definition at line 344 of file sprayI.H.

Referenced by parcel::move().

const scalarField & shs ( ) const
inline

Definition at line 350 of file sprayI.H.

PtrList< scalarField > & srhos ( )
inline

Definition at line 356 of file sprayI.H.

Referenced by parcel::move().

const PtrList< scalarField > & srhos ( ) const
inline

Definition at line 362 of file sprayI.H.

const scalar & ambientPressure ( ) const
inline

Definition at line 368 of file sprayI.H.

Referenced by hollowConeInjector::hollowConeInjector().

const scalar & ambientTemperature ( ) const
inline

Definition at line 374 of file sprayI.H.

scalar injectedMass ( const scalar  t) const

Returns the liquid mass that has been injected.

Definition at line 36 of file sprayFunctions.C.

References forAll, and Foam::sum().

scalar totalMassToInject ( ) const

Returns the liquid mass that will be injected by the injectors.

Definition at line 49 of file sprayFunctions.C.

References forAll, and Foam::sum().

scalar injectedEnthalpy ( const scalar  t) const

Returns the injected enthalpy.

Definition at line 63 of file sprayFunctions.C.

References forAll, gasProperties(), k(), Foam::mathematicalConstant::pi(), Foam::sum(), and Foam::T().

scalar liquidMass ( ) const

Returns current total liquid mass in the domain.

Definition at line 92 of file sprayFunctions.C.

References spray::angleOfWedge(), Cloud< parcel >::begin(), elmnt, Cloud< parcel >::end(), Foam::mathematicalConstant::pi(), Foam::reduce(), Foam::sum(), and spray::twoD().

scalar liquidKineticEnergy ( ) const
scalar injectedLiquidKineticEnergy ( ) const

Returns the injected kinetic energy of the liquid phase.

Definition at line 230 of file sprayFunctions.C.

scalar liquidPenetration ( const label  nozzlei,
const scalar  prc 
) const

Returns the droplet penetration for 'prc' percent of the.

liquid from nozzle 'nozzlei'

Definition at line 243 of file sprayFunctions.C.

References d, dist, elmnt, Foam::mag(), mTot, Foam::reduce(), and Vector< scalar >::zero.

Referenced by spray::liquidPenetration().

scalar liquidPenetration ( const scalar  prc) const

Returns the droplet penetration for 'prc' percent of the.

liquid from nozzle 0

Definition at line 236 of file sprayFunctions.C.

References spray::liquidPenetration().

scalar smd ( ) const
scalar maxD ( ) const

Return Maximum Diameter.

Definition at line 400 of file sprayFunctions.C.

References Cloud< parcel >::begin(), d, elmnt, Cloud< parcel >::end(), Foam::max(), and Foam::reduce().

void calculateAmbientPressure ( )

Return Ambient Pressure.

Definition at line 420 of file sprayFunctions.C.

References DimensionedField< Type, GeoMesh >::average(), and dimensioned< Type >::value().

Referenced by spray::evolve().

void calculateAmbientTemperature ( )

Return Ambient Temperature.

Definition at line 426 of file sprayFunctions.C.

References DimensionedField< Type, GeoMesh >::average(), and dimensioned< Type >::value().

Referenced by spray::evolve().


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