Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
shapeModel Class Referenceabstract

Base class for modelling the shape of the particles belonging to a size class through alternative diameters, e.g. a collisional diameter, which can then be utilised in population balance submodels, e.g. for modelling fractal aggregation. More...

Inheritance diagram for shapeModel:
Inheritance graph
[legend]
Collaboration diagram for shapeModel:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("shapeModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, shapeModel, dictionary,(const dictionary &dict, const sizeGroup &group),(dict, group))
 
 shapeModel (const dictionary &dict, const sizeGroup &group)
 Construct from dictionary and sizeGroup. More...
 
 shapeModel (const shapeModel &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~shapeModel ()
 Destructor. More...
 
const sizeGroup & SizeGroup () const
 Return reference to size group. More...
 
virtual const tmp< volScalarField > a () const =0
 Return representative surface area of the sizeGroup. More...
 
virtual const tmp< volScalarField > d () const =0
 Return representative diameter of the sizeGroup. More...
 
virtual void correct ()
 Correct physical diameter. 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 addDrift (const volScalarField &Su, const sizeGroup &fu, const driftModel &model)
 Add drift contribution to secondary property source. More...
 
virtual void addNucleation (const volScalarField &Su, const sizeGroup &fi, const nucleationModel &model)
 Add nucleation contribution to secondary property source. More...
 
virtual void reset ()
 Reset secondary property source. More...
 
void operator= (const shapeModel &)=delete
 Disallow default bitwise assignment. More...
 

Static Public Member Functions

static autoPtr< shapeModel > New (const dictionary &dict, const sizeGroup &group)
 

Protected Attributes

const sizeGroup & sizeGroup_
 Reference to sizeGroup. More...
 

Detailed Description

Base class for modelling the shape of the particles belonging to a size class through alternative diameters, e.g. a collisional diameter, which can then be utilised in population balance submodels, e.g. for modelling fractal aggregation.

See also
Foam::diameterModels::sizeGroup
Source files

Definition at line 60 of file shapeModel.H.

Constructor & Destructor Documentation

◆ shapeModel() [1/2]

shapeModel ( const dictionary &  dict,
const sizeGroup &  group 
)

Construct from dictionary and sizeGroup.

Definition at line 42 of file shapeModel.C.

◆ shapeModel() [2/2]

shapeModel ( const shapeModel &  )
delete

Disallow default bitwise copy construction.

◆ ~shapeModel()

~shapeModel ( )
virtual

Destructor.

Definition at line 82 of file shapeModel.C.

Member Function Documentation

◆ TypeName()

TypeName ( "shapeModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
shapeModel  ,
dictionary  ,
(const dictionary &dict, const sizeGroup &group)  ,
(dict, group)   
)

◆ New()

Foam::autoPtr< Foam::diameterModels::shapeModel > New ( const dictionary &  dict,
const sizeGroup &  group 
)
static

Definition at line 55 of file shapeModel.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::constant::atomic::group.

Referenced by sizeGroup::sizeGroup().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SizeGroup()

const Foam::diameterModels::sizeGroup & SizeGroup ( ) const

Return reference to size group.

Definition at line 88 of file shapeModel.C.

◆ a()

virtual const tmp<volScalarField> a ( ) const
pure virtual

Return representative surface area of the sizeGroup.

Implemented in spherical, and fractal.

◆ d()

virtual const tmp<volScalarField> d ( ) const
pure virtual

Return representative diameter of the sizeGroup.

Implemented in spherical, and fractal.

◆ correct()

void correct ( )
virtual

Correct physical diameter.

Reimplemented in fractal.

Definition at line 95 of file shapeModel.C.

◆ addCoalescence()

void addCoalescence ( const volScalarField &  Su,
const sizeGroup &  fj,
const sizeGroup &  fk 
)
virtual

Add coalescence contribution to secondary property source.

Reimplemented in SecondaryPropertyModel< shapeModel >.

Definition at line 99 of file shapeModel.C.

◆ addBreakup()

void addBreakup ( const volScalarField &  Su,
const sizeGroup &  fj 
)
virtual

Add breakup contribution to secondary property source.

Reimplemented in SecondaryPropertyModel< shapeModel >.

Definition at line 108 of file shapeModel.C.

◆ addDrift()

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

Add drift contribution to secondary property source.

Reimplemented in fractal, and SecondaryPropertyModel< shapeModel >.

Definition at line 116 of file shapeModel.C.

◆ addNucleation()

void addNucleation ( const volScalarField &  Su,
const sizeGroup &  fi,
const nucleationModel &  model 
)
virtual

Add nucleation contribution to secondary property source.

Reimplemented in SecondaryPropertyModel< shapeModel >.

Definition at line 125 of file shapeModel.C.

◆ reset()

void reset ( )
virtual

Reset secondary property source.

Reimplemented in SecondaryPropertyModel< shapeModel >.

Definition at line 134 of file shapeModel.C.

◆ operator=()

void operator= ( const shapeModel &  )
delete

Disallow default bitwise assignment.

Member Data Documentation

◆ sizeGroup_

const sizeGroup& sizeGroup_
protected

Reference to sizeGroup.

Definition at line 68 of file shapeModel.H.

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