fractal Class Reference

Class for modelling the shape of particle aggregates using the concept of fractal geometry. Returns a collisional diameter. More...

Inheritance diagram for fractal:
Collaboration diagram for fractal:

Public Types

enum  surfaceGrowthTypes { sgHardSphere , sgParkRogak , sgConserved }
 Surface growth type enumeration. 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...
 
enum  fileCheckTypes { timeStamp , timeStampMaster , inotify , inotifyMaster }
 Enumeration defining the file checking options. More...
 

Public Member Functions

 TypeName ("fractal")
 Runtime type information. More...
 
 fractal (const dictionary &dict, const sizeGroup &group, const dictionary &groupDict)
 Construct from dictionaries and sizeGroup. More...
 
 fractal (const fractal &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~fractal ()
 Destructor. More...
 
virtual const volScalarFieldfld () const
 Return reference to secondary property field. More...
 
virtual volScalarFieldsrc ()
 Access to secondary property source. More...
 
virtual const tmp< volScalarFielda () const
 Return representative surface area of the sizeGroup. More...
 
virtual const tmp< volScalarFieldd () const
 Return representative diameter of the sizeGroup. More...
 
virtual void correct ()
 Correct the collisional diameter. More...
 
virtual void addDrift (const volScalarField &Su, const sizeGroup &fu, const driftModel &model)
 Add drift contribution to secondary property source. More...
 
void operator= (const fractal &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from SecondaryPropertyModel< shapeModel >
 SecondaryPropertyModel (const sizeGroup &group)
 Construct from sizeGroup. More...
 
 SecondaryPropertyModel (const SecondaryPropertyModel< shapeModel > &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~SecondaryPropertyModel ()
 Destructor. More...
 
const sizeGroupgroup () const
 Access the sizeGroup. More...
 
const SpTableSecondaryPropertyModelTable ()
 Return table with pointers to all secondary properties of. More...
 
const word SecondaryPropertyName (const sizeGroup &fi) const
 Return name of the secondary property of another class for. More...
 
virtual void addCoalescence (const volScalarField &Su, const sizeGroup &fj, const sizeGroup &fk)
 Add coalescence contribution to secondary property source. More...
 
virtual void addBreakup (const volScalarField &Su, const sizeGroup &fj)
 Add breakup contribution to secondary property source. More...
 
virtual void addNucleation (const volScalarField &Su, const sizeGroup &fi, const nucleationModel &model)
 Add drift contribution to secondary property source. More...
 
virtual void reset ()
 Reset secondary property source. More...
 
bool writeData (Ostream &) const
 Dummy write for regIOobject. More...
 
void operator= (const SecondaryPropertyModel< shapeModel > &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from shapeModel
 TypeName ("shapeModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, shapeModel, dictionary,(const dictionary &dict, const sizeGroup &group, const dictionary &groupDict),(dict, group, groupDict))
 
 shapeModel (const sizeGroup &group)
 Construct from sizeGroup. More...
 
 shapeModel (const shapeModel &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~shapeModel ()
 Destructor. More...
 
const sizeGroupgroup () const
 Return reference to size group. More...
 
void operator= (const shapeModel &)=delete
 Disallow default bitwise assignment. More...
 
- 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 &)
 Copy constructor. More...
 
 regIOobject (const regIOobject &&)
 Move constructor. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Copy constructor, transferring registry registration to copy. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Copy constructor with new name, transferring registry registration. More...
 
 regIOobject (const IOobject &, const regIOobject &)
 Copy constructor with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
virtual bool global () const
 Return true if object is global, i.e. same for all processors. More...
 
virtual bool globalFile () const
 Return true if object is global, i.e. same for all processors. More...
 
const fileNamecaseName () const
 
fileName path () const
 Return complete path. More...
 
fileName objectPath () const
 Return complete path + object name. More...
 
fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from registry. More...
 
void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) More...
 
bool registered () const
 Is this object registered with the 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...
 
virtual void rename (const word &newName)
 Rename. More...
 
bool headerOk ()
 Read and check header info. More...
 
IstreamreadStream (const word &, const bool read=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...
 
const labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. More...
 
virtual bool modified () const
 Return true if the object's file (or files for objectRegistry) More...
 
virtual bool dependenciesModified () const
 Return true if the object's dependencies have been modified. More...
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const
 Write using given format, version and compression. More...
 
virtual bool write (const bool write=true) const
 Write using setting from DB. More...
 
void operator= (const IOobject &)
 Assign to IOobject. More...
 
void operator= (const regIOobject &)=delete
 Disallow default assignment. More...
 
const fileNamecaseName (const bool global) const
 
fileName path (const bool global) const
 Return complete path including the processor sub-directory. More...
 
fileName objectPath (const bool global) const
 Return complete path + object name including the processor. More...
 
fileName filePath (const word &typeName, const bool global) const
 Return complete path + object name if the file exists. More...
 
- 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...
 
 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...
 
 IOobject (const IOobject &io)=default
 Copy constructor. 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...
 
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 bool global) const
 
fileNameinstance () const
 Return the instance directory, constant, system, <time> etc. More...
 
void updateInstance () const
 If the instance is a time directory update to the current time. More...
 
const fileNamelocal () const
 
fileName path (const bool global) const
 Return complete path including the processor sub-directory. More...
 
fileName objectPath (const bool global) const
 Return complete path + object name including the processor. More...
 
fileName relativePath () const
 Return the path relative to the case directory. More...
 
fileName relativeObjectPath () const
 Return complete relativePath + object name. More...
 
fileName filePath (const word &typeName, const bool global) const
 Return complete path + object name if the file exists. More...
 
bool readHeader (Istream &)
 Read header. More...
 
bool headerOk ()
 Read header of local object without type-checking. 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)
 

Static Public Attributes

static const NamedEnum< surfaceGrowthTypes, 3 > sgTypeNames_
 Surface growth type names. More...
 
- Static Public Attributes inherited from regIOobject
static float fileModificationSkew
 
- Static Public Attributes inherited from IOobject
static constexpr const char * foamFile = "FoamFile"
 Keyword for the FoamFile header sub-dictionary. More...
 
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from shapeModel
static autoPtr< shapeModelNew (const dictionary &dict, const sizeGroup &group, const dictionary &groupDict)
 
- 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...
 
- Protected Types inherited from SecondaryPropertyModel< shapeModel >
using SpTable = HashTable< const SecondaryPropertyModel< shapeModel > * >
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName)
 Read header, check readOpt flags and read data if necessary. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &)
 Set the object state to bad. More...
 
template<class Type >
bool typeHeaderOk (const bool checkType)
 Read header using typeGlobalFile to find file. More...
 
- Protected Attributes inherited from SecondaryPropertyModel< shapeModel >
const sizeGroupgroup_
 Reference to sizeGroup. More...
 
SpTable SecondaryPropertyModelTable_
 Table with pointers to all secondary properties of ModelType. More...
 
- Protected Attributes inherited from shapeModel
const sizeGroupgroup_
 Reference to sizeGroup. More...
 

Detailed Description

Class for modelling the shape of particle aggregates using the concept of fractal geometry. Returns a collisional diameter.

\[ d_{c_i} = \frac{6}{\kappa_i} \left( \frac{v_i \kappa_i^3}{36 \pi \alpha_c} \right)^{1/D_{f_i}}\,, \]

computed from a constant fractal dimension $D_{f_i}$ and a field-dependent surface area to volume ratio $\kappa_i$, assuming that the primary particles in an aggregate have the same size.

The effect of sintering, i.e. the coalescence of primary particles resulting in a loss of surface area, is taken into account by a separate source term in the transport equation for $\kappa_i$.

Usage
Property Description Required Default value
kappa Initial and boundary condition value yes
Df Fractal dimension yes
alphaC Scaling prefactor yes
See also
Foam::diameterModels::shapeModel
Source files

Definition at line 103 of file fractal.H.

Member Enumeration Documentation

◆ surfaceGrowthTypes

Surface growth type enumeration.

Enumerator
sgHardSphere 
sgParkRogak 
sgConserved 

Definition at line 112 of file fractal.H.

Constructor & Destructor Documentation

◆ fractal() [1/2]

fractal ( const dictionary dict,
const sizeGroup group,
const dictionary groupDict 
)

◆ fractal() [2/2]

fractal ( const fractal )
delete

Disallow default bitwise copy construction.

◆ ~fractal()

~fractal ( )
virtual

Destructor.

Definition at line 148 of file fractal.C.

Member Function Documentation

◆ TypeName()

TypeName ( "fractal"  )

Runtime type information.

◆ fld()

const Foam::volScalarField & fld ( ) const
virtual

Return reference to secondary property field.

Implements SecondaryPropertyModel< shapeModel >.

Definition at line 155 of file fractal.C.

◆ src()

Foam::volScalarField & src ( )
virtual

Access to secondary property source.

Implements SecondaryPropertyModel< shapeModel >.

Definition at line 162 of file fractal.C.

◆ a()

const Foam::tmp< Foam::volScalarField > a ( ) const
virtual

Return representative surface area of the sizeGroup.

Implements shapeModel.

Definition at line 226 of file fractal.C.

References Foam::constant::atomic::group.

◆ d()

virtual const tmp<volScalarField> d ( ) const
inlinevirtual

Return representative diameter of the sizeGroup.

Implements shapeModel.

Definition at line 190 of file fractal.H.

Referenced by fractal::addDrift().

Here is the caller graph for this function:

◆ correct()

◆ addDrift()

void addDrift ( const volScalarField Su,
const sizeGroup fu,
const driftModel model 
)
virtual

◆ operator=()

void operator= ( const fractal )
delete

Disallow default bitwise assignment.

Member Data Documentation

◆ sgTypeNames_

Surface growth type names.

Definition at line 120 of file fractal.H.


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