Class that solves the univariate population balance equation by means of a class method (also called sectional or discrete method). The internal coordinate is set to the particle volume, so the equation is based on a transport equation of the volume-based number density function. The discretization is done using the fixed pivot technique of Kumar and Ramkrishna (1996). The source terms are written in a way that particle number and mass are preserved. Coalescence (aggregation), breakup, drift (growth and surface loss) as well as nucleation are supported. For the discrete breakup term two recipes are available, depending on the model choice. For models which state a total breakup rate and a separate daughter size distribution function, the formulation of Kumar and Ramkrishna (1996) is applied which is applicable for binary and multiple breakup events. The second formulation is given by Liao et al. (2018). It is useful for binary breakup models which give the breakup rate between a sizeGroup pair directly, without an explicit expression for the daughter size distribution. The drift term is implemented using a finite difference upwind scheme. Although it is diffusive, it ensures a stable and number-conservative solution. More...
Classes | |
class | iNew |
Return a pointer to a new populationBalanceModel object created on. More... | |
Public Member Functions | |
populationBalanceModel (const phaseSystem &fluid, const word &name, HashPtrTable< volScalarField, phasePairKey, phasePairKey::hash > &pDmdt) | |
autoPtr< populationBalanceModel > | clone () const |
Return clone. More... | |
virtual | ~populationBalanceModel () |
Destructor. More... | |
bool | writeData (Ostream &) const |
Dummy write for regIOobject. More... | |
const phaseSystem & | fluid () const |
Return reference to the phaseSystem. More... | |
const fvMesh & | mesh () const |
Return reference to the mesh. More... | |
const dictionary & | dict () const |
Return populationBalanceCoeffs dictionary. More... | |
const phaseModel & | continuousPhase () const |
Return continuous phase. More... | |
const UPtrList< velocityGroup > & | velocityGroups () const |
Return the velocityGroups belonging to this populationBalance. More... | |
const UPtrList< sizeGroup > & | sizeGroups () const |
Return the sizeGroups belonging to this populationBalance. More... | |
const phasePairTable & | phasePairs () const |
Return list of unordered phasePairs in this populationBalance. More... | |
const PtrList< dimensionedScalar > & | v () const |
Return the sizeGroup boundaries. More... | |
const volScalarField & | alphas () const |
Return total void of phases belonging to this populationBalance. More... | |
const volVectorField & | U () const |
Return average velocity. More... | |
const dimensionedScalar | gamma (const label i, const dimensionedScalar &v) const |
Return allocation coefficient. More... | |
const tmp< volScalarField > | sigmaWithContinuousPhase (const phaseModel &dispersedPhase) const |
Return the surface tension coefficient between a given dispersed. More... | |
const phaseCompressibleTurbulenceModel & | continuousTurbulence () const |
Return reference to turbulence model of the continuous phase. More... | |
void | solve () |
Solve the population balance equation. More... | |
Public Member Functions inherited from regIOobject | |
TypeName ("regIOobject") | |
Runtime type information. More... | |
regIOobject (const IOobject &io, const bool isTimeObject=false) | |
regIOobject (const regIOobject &rio) | |
Copy construct. More... | |
regIOobject (const regIOobject &rio, bool registerCopy) | |
regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
regIOobject (const IOobject &io, const regIOobject &rio) | |
Copy construct with new IO parameters. More... | |
virtual | ~regIOobject () |
Destructor. More... | |
bool | checkIn () |
Add object to registry, if not already registered. More... | |
bool | checkOut () |
Remove all file watches and remove object from registry. More... | |
virtual void | addWatch () |
Add file watch on object (if registered and READ_IF_MODIFIED) More... | |
bool | registered () const noexcept |
bool | ownedByRegistry () const noexcept |
Is this object owned by the registry? More... | |
bool | store () |
void | release (const bool unregister=false) noexcept |
Set object as not ownedByRegistry. More... | |
label | eventNo () const noexcept |
Event number at last update. More... | |
label & | eventNo () noexcept |
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 as up-to-date. More... | |
virtual void | rename (const word &newName) |
Rename. More... | |
const dictionary * | findMetaData () const noexcept |
Return pointer to meta-data or nullptr. More... | |
dictionary & | getMetaData () noexcept |
Get or create meta-data. More... | |
void | removeMetaData () |
Remove meta-data. More... | |
virtual void | updateMetaData () |
Update internal meta-data (eg, prior to writing) More... | |
virtual fileName | filePath () const |
Return complete path + object name if the file exists. More... | |
bool | headerOk () |
Read and check header info. Does not check the headerClassName. More... | |
Istream & | readStream (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. More... | |
const labelList & | watchIndices () const noexcept |
Read access to file-monitoring handles. More... | |
labelList & | watchIndices () noexcept |
Write access to file-monitoring handles. More... | |
virtual bool | modified () const |
virtual bool | readIfModified () |
Read object if modified (as set by call to modified) More... | |
virtual bool | writeData (Ostream &) const =0 |
Pure virtual writeData function. More... | |
virtual bool | writeObject (IOstreamOption streamOpt, const bool valid) const |
Write using stream options. 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 &io) |
Copy assignment. More... | |
virtual bool | writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const |
Write using given format, version and compression. More... | |
Public Member Functions inherited from IOobject | |
TypeName ("IOobject") | |
Declare type-name, virtual type (with debug switch) More... | |
IOobject (const IOobject &)=default | |
Copy construct. More... | |
virtual | ~IOobject ()=default |
Destructor. More... | |
IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from name, instance, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from name, instance, local, registry, io options. More... | |
IOobject (const fileName &path, const objectRegistry ®istry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from path, registry, io options. More... | |
IOobject (const IOobject &io, const objectRegistry ®istry) | |
Copy construct, resetting registry. More... | |
IOobject (const IOobject &io, const word &name) | |
Copy construct, resetting name. More... | |
IOobject (const IOobject &io, const word &name, const fileName &local) | |
Copy construct, resetting name and local component. More... | |
IOobject (const IOobject &io, readOption rOpt, writeOption wOpt) | |
Copy construct, resetting read/write options. More... | |
autoPtr< IOobject > | clone () const |
Clone. More... | |
autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
Clone resetting registry. More... | |
const objectRegistry & | db () const noexcept |
Return the local objectRegistry. More... | |
const Time & | time () const |
Return Time associated with the objectRegistry. More... | |
const word & | name () const noexcept |
Return the object name. More... | |
const word & | headerClassName () const noexcept |
Return name of the class name read from header. More... | |
word & | headerClassName () noexcept |
Return non-constant access to the class name read from header. More... | |
const string & | note () const noexcept |
Return the optional note. More... | |
string & | note () noexcept |
Modifiable access to the optional note. More... | |
virtual void | rename (const word &newName) |
Rename the object. More... | |
bool | registerObject () const noexcept |
Should object created with this IOobject be registered? More... | |
bool | registerObject (bool on) noexcept |
Change registration preference, return previous value. More... | |
bool | globalObject () const noexcept |
Is object same for all processors? More... | |
bool | globalObject (bool on) noexcept |
Change global-object status, return previous value. More... | |
unsigned | labelByteSize () const noexcept |
The sizeof (label) in bytes, possibly read from the header. More... | |
unsigned | scalarByteSize () const noexcept |
The sizeof (scalar) in bytes, possibly read from the header. More... | |
bool | hasHeaderClass () const noexcept |
True if headerClassName() is non-empty (after reading) More... | |
template<class Type > | |
bool | isHeaderClass () const |
Check if headerClassName() equals Type::typeName. More... | |
template<class Type > | |
bool | isHeaderClassName () const |
Same as isHeaderClass() More... | |
virtual const dictionary * | findMetaData () const noexcept |
Return pointer to meta-data (if any) or nullptr. More... | |
readOption | readOpt () const noexcept |
The read option. More... | |
readOption | readOpt (readOption opt) noexcept |
Change the read option, return previous value. More... | |
writeOption | writeOpt () const noexcept |
The write option. More... | |
writeOption | writeOpt (writeOption opt) noexcept |
Change the write option, return previous value. More... | |
word | group () const |
Return group (extension part of name) More... | |
word | member () const |
Return member (name without the extension) More... | |
const fileName & | rootPath () const |
Return the Time::rootPath() More... | |
const fileName & | caseName () const |
Return the Time::caseName() More... | |
const fileName & | instance () const noexcept |
Read access to instance path component. More... | |
fileName & | instance () noexcept |
Write access to instance path component. More... | |
const fileName & | local () const noexcept |
Read access to local path component. More... | |
fileName | path () const |
The complete path. More... | |
fileName | path (const word &instance, const fileName &local=fileName::null) const |
The complete path with alternative instance and local. More... | |
fileName | objectPath () const |
The complete path + object name. More... | |
fileName | objectRelPath () const |
The object path relative to the root. More... | |
fileName | localFilePath (const word &typeName, const bool search=true) const |
Helper for filePath that searches locally. More... | |
fileName | globalFilePath (const word &typeName, const bool search=true) const |
Helper for filePath that searches up if in parallel. More... | |
IOstreamOption | parseHeader (const dictionary &headerDict) |
bool | readHeader (Istream &is) |
bool | readHeader (dictionary &headerDict, Istream &is) |
template<class Type > | |
bool | typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true) |
Read header (uses typeFilePath to find file) and check its info. More... | |
template<class Type > | |
void | warnNoRereading () const |
Helper: warn that type does not support re-reading. More... | |
bool | writeHeader (Ostream &os) const |
Write header with current type() More... | |
bool | writeHeader (Ostream &os, const word &objectType) const |
Write header with override of type. More... | |
void | writeHeader (dictionary &dict, IOstreamOption streamOpt) const |
void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
bool | good () const noexcept |
Did last readHeader() succeed? More... | |
bool | bad () const noexcept |
Did last readHeader() fail? More... | |
InfoProxy< IOobject > | info () const |
Return info proxy, for printing information to a stream. More... | |
void | operator= (const IOobject &io) |
Copy assignment, copies all values (except the registry) More... | |
readOption & | readOpt () noexcept |
Access to the read option. More... | |
writeOption & | writeOpt () noexcept |
Access to the write option. More... | |
bool & | registerObject () noexcept |
Access to the register object option. More... | |
bool & | globalObject () noexcept |
Access to the global object option. More... | |
template<> | |
bool | isHeaderClass () const |
Specialization for void always returns true (no headerClassName check). More... | |
template<class StringType > | |
Foam::word | groupName (StringType base, const word &group) |
Friends | |
class | sizeGroup |
class | velocityGroup |
Additional Inherited Members | |
Public Types inherited from IOobject | |
enum | readOption : char { NO_READ = 0 , MUST_READ = 1 , MUST_READ_IF_MODIFIED = 3 , READ_IF_PRESENT = 4 } |
Enumeration defining the read options. More... | |
enum | writeOption : char { NO_WRITE = 0 , AUTO_WRITE = 0x10 } |
Enumeration defining the write options. More... | |
enum | objectState : char { GOOD , BAD } |
Enumeration defining the valid states of an IOobject. More... | |
enum | fileCheckTypes : char { timeStamp , timeStampMaster , inotify , inotifyMaster } |
Enumeration defining the file checking options. More... | |
Static Public Member Functions inherited from regIOobject | |
template<class Type > | |
static Type & | store (Type *p) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (autoPtr< Type > &ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (autoPtr< Type > &&ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (refPtr< Type > &ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (refPtr< Type > &&ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (tmp< Type > &ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (tmp< Type > &&ptr) |
Transfer pointer ownership to its registry. More... | |
Static Public Member Functions inherited from IOobject | |
static bool | bannerEnabled () noexcept |
Status of output file banner. More... | |
static bool | bannerEnabled (bool on) noexcept |
Enable/disable output file banner. More... | |
static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
Split path into instance, local, name components. More... | |
template<class StringType > | |
static word | groupName (StringType base, const word &group) |
Create dot-delimited name.group string. More... | |
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... | |
static word | scopedName (const std::string &scope, const word &name) |
Create scope:name or scope_name string. More... | |
static IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
Return the IOobject, but also consider an alternative file name. More... | |
static Ostream & | writeBanner (Ostream &os, const bool noSyntaxHint=false) |
Write the standard OpenFOAM file/dictionary banner. More... | |
static Ostream & | writeDivider (Ostream &os) |
Write the standard file section divider. More... | |
static Ostream & | writeEndDivider (Ostream &os) |
Write the standard end file divider. More... | |
Static Public Attributes inherited from IOobject | |
static const Enum< fileCheckTypes > | fileCheckTypesNames |
Names for the fileCheckTypes. More... | |
static char | scopeSeparator |
Character for scoping object names (':' or '_') More... | |
static fileCheckTypes | fileModificationChecking |
Type of file modification checking. More... | |
static float | fileModificationSkew |
Time skew (seconds) for file modification checks. More... | |
static int | maxFileModificationPolls |
Max number of times to poll for file modification changes. More... | |
Protected Member Functions inherited from regIOobject | |
bool | readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName) |
Helper: check readOpt flags and read if necessary. More... | |
Protected Member Functions inherited from IOobject | |
void | setBad (const string &s) |
Set the object state to bad. More... | |
Static Protected Member Functions inherited from IOobject | |
static void | writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr) |
static void | writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr) |
Static Protected Attributes inherited from regIOobject | |
static bool | masterOnlyReading = false |
To flag master-only reading of objects. More... | |
Class that solves the univariate population balance equation by means of a class method (also called sectional or discrete method). The internal coordinate is set to the particle volume, so the equation is based on a transport equation of the volume-based number density function. The discretization is done using the fixed pivot technique of Kumar and Ramkrishna (1996). The source terms are written in a way that particle number and mass are preserved. Coalescence (aggregation), breakup, drift (growth and surface loss) as well as nucleation are supported. For the discrete breakup term two recipes are available, depending on the model choice. For models which state a total breakup rate and a separate daughter size distribution function, the formulation of Kumar and Ramkrishna (1996) is applied which is applicable for binary and multiple breakup events. The second formulation is given by Liao et al. (2018). It is useful for binary breakup models which give the breakup rate between a sizeGroup pair directly, without an explicit expression for the daughter size distribution. The drift term is implemented using a finite difference upwind scheme. Although it is diffusive, it ensures a stable and number-conservative solution.
The implementation allows to split the population balance over multiple velocity fields using the capability of reactingMultiphaseEulerFoam to solve for n momentum equations. It is also possible to define multiple population balances, e.g. bubbles and droplets simultaneously.
References:
Coalescence and breakup term formulation: Kumar, S., & Ramkrishna, D. (1996). On the solution of population balance equations by discretization-I. A fixed pivot technique. Chemical Engineering Science, 51(8), 1311-1332.
Binary breakup term formulation: Liao, Y., Oertel, R., Kriebitzsch, S., Schlegel, F., & Lucas, D. (2018). A discrete population balance equation for binary breakage. International Journal for Numerical Methods in Fluids, 87(4), 202-215.
type populationBalanceTwoPhaseSystem; phases (air water); populationBalances (bubbles); air { type purePhaseModel; diameterModel velocityGroup; velocityGroupCoeffs { populationBalance bubbles; formFactor 0.5235987756; sizeGroups ( f0{d 1.00e-3; value 0;} f1{d 1.08e-3; value 0;} f2{d 1.16e-3; value 0.25;} f3{d 1.25e-3; value 0.5;} f4{d 1.36e-3; value 0.25;} f5{d 1.46e-3; value 0;} ... ); } residualAlpha 1e-6; } populationBalanceCoeffs { bubbles { continuousPhase water; coalescenceModels ( hydrodynamic { C 0.25; } ); binaryBreakupModels (); breakupModels ( exponential { C 0.5; exponent 0.01; daughterSizeDistributionModel uniformBinary; } ); driftModels ( densityChange{} ); nucleationModels (); } }
Definition at line 179 of file populationBalanceModel.H.
populationBalanceModel | ( | const phaseSystem & | fluid, |
const word & | name, | ||
HashPtrTable< volScalarField, phasePairKey, phasePairKey::hash > & | pDmdt | ||
) |
Definition at line 852 of file populationBalanceModel.C.
References IOobject::AUTO_WRITE, Foam::dimLength, Foam::dimless, Foam::dimTime, Foam::dimVelocity, Foam::dimVolume, Foam::exit(), Foam::FatalError, FatalErrorInFunction, IOobject::groupName(), Foam::inv(), IOobject::name(), IOobject::NO_READ, fvMesh::time(), IOobject::time(), Time::timeName(), and Foam::Zero.
|
virtual |
Destructor.
Definition at line 1141 of file populationBalanceModel.C.
Foam::autoPtr< Foam::diameterModels::populationBalanceModel > clone | ( | ) | const |
Dummy write for regIOobject.
Implements regIOobject.
Definition at line 1155 of file populationBalanceModel.C.
References os(), and populationBalanceModel::writeData().
Referenced by populationBalanceModel::writeData().
|
inline |
Return reference to the phaseSystem.
Definition at line 49 of file populationBalanceModelI.H.
Referenced by phaseChange::phaseChange().
|
inline |
Return reference to the mesh.
Definition at line 56 of file populationBalanceModelI.H.
Referenced by phaseChange::phaseChange().
|
inline |
Return populationBalanceCoeffs dictionary.
Definition at line 63 of file populationBalanceModelI.H.
|
inline |
Return continuous phase.
Definition at line 70 of file populationBalanceModelI.H.
|
inline |
Return the velocityGroups belonging to this populationBalance.
Definition at line 77 of file populationBalanceModelI.H.
|
inline |
Return the sizeGroups belonging to this populationBalance.
Definition at line 84 of file populationBalanceModelI.H.
|
inline |
Return list of unordered phasePairs in this populationBalance.
Definition at line 91 of file populationBalanceModelI.H.
Referenced by PopulationBalancePhaseSystem< BasePhaseSystem >::PopulationBalancePhaseSystem().
|
inline |
Return the sizeGroup boundaries.
Definition at line 98 of file populationBalanceModelI.H.
|
inline |
Return total void of phases belonging to this populationBalance.
Definition at line 105 of file populationBalanceModelI.H.
|
inline |
Return average velocity.
Definition at line 119 of file populationBalanceModelI.H.
const Foam::dimensionedScalar gamma | ( | const label | i, |
const dimensionedScalar & | v | ||
) | const |
Return allocation coefficient.
Definition at line 1162 of file populationBalanceModel.C.
References populationBalanceModel::gamma(), and dimensioned< Type >::value().
Referenced by populationBalanceModel::gamma().
const Foam::tmp< Foam::volScalarField > sigmaWithContinuousPhase | ( | const phaseModel & | dispersedPhase | ) | const |
Return the surface tension coefficient between a given dispersed.
and the continuous phase
Definition at line 1206 of file populationBalanceModel.C.
const Foam::phaseCompressibleTurbulenceModel & continuousTurbulence | ( | ) | const |
Return reference to turbulence model of the continuous phase.
Definition at line 1220 of file populationBalanceModel.C.
References IOobject::groupName(), and turbulenceModel::propertiesName.
void solve | ( | ) |
Solve the population balance equation.
Definition at line 1234 of file populationBalanceModel.C.
References alpha, correct(), Foam::fvc::ddt(), Foam::fvm::ddt(), Foam::fvc::div(), velocityGroup::dmdt(), Foam::endl(), forAll, dictionary::get(), dictionary::getOrDefault(), Foam::Info, Foam::max(), mesh, velocityGroup::mvConvection(), Foam::name(), nCorr, sizeGroup::phase(), fvMatrix< Type >::relax(), rho, phase::rho(), fvMatrix< Type >::solve(), Foam::fvm::Sp(), Foam::fvc::Su(), Foam::fvm::SuSp(), sizeGroup::VelocityGroup(), and DimensionedField< Type, GeoMesh >::weightedAverage().
|
friend |
Definition at line 335 of file populationBalanceModel.H.
|
friend |
Definition at line 336 of file populationBalanceModel.H.