Base class for modeling the transport of an additional secondary property in between size groups by means of coalescence, breakup, drift and nucleation. The default behavior is conserved transport of the property, which can be overwritten in a derived class. More...

Inheritance diagram for SecondaryPropertyModel< ModelType >:

[legend]

Collaboration diagram for SecondaryPropertyModel< ModelType >:

[legend]

Public Member Functions
	SecondaryPropertyModel (const dictionary &dict, const sizeGroup &group)
	Construct from dictionary and sizeGroup. More...

	SecondaryPropertyModel (const SecondaryPropertyModel< ModelType > &)=delete
	Disallow default bitwise copy construction. More...

virtual	~SecondaryPropertyModel ()
	Destructor. More...

const SpTable &	SecondaryPropertyModelTable ()
	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 const volScalarField &	fld () const =0
	Return reference to secondary property field. More...

virtual volScalarField &	src ()=0
	Access to secondary property source. 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 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< ModelType > &)=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 &, 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...

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...

label &	eventNo ()
	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...

virtual fileName	filePath () const
	Return complete path + object name if the file exists. More...

bool	headerOk ()
	Read and check header info. More...

Istream &	readStream (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...

virtual label	addWatch (const fileName &)
	Add file watch for fileName on object if not yet watched. Return. More...

const labelList &	watchIndices () const
	Return file-monitoring handles. More...

labelList &	watchIndices ()
	Return file-monitoring handles. More...

virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) More...

virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) More...

virtual bool	global () const
	Is object same for all processors. 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 &)

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< IOobject >	clone () const
	Clone. More...

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. More...

virtual	~IOobject ()
	Destructor. More...

const Time &	time () const
	Return time. More...

const objectRegistry &	db () const
	Return the local objectRegistry. More...

const word &	name () const
	Return name. More...

const word &	headerClassName () const
	Return name of the class name read from header. More...

word &	headerClassName ()
	Return name of the class name read from header. More...

string &	note ()
	Return non-constant access to the optional note. More...

const string &	note () 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

readOption &	readOpt ()

writeOption	writeOpt () const

writeOption &	writeOpt ()

word	group () const
	Return group (extension part of name) More...

word	member () const
	Return member (name without the extension) More...

word	modelName (const char *name) const
	Return the name of the object within this model. More...

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const

fileName &	instance ()

const fileName &	local () 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	localPath () const
	Return the path relative to the case. More...

fileName	objectPath () const
	Return complete path + object name. More...

fileName	localObjectPath () const
	Return complete localPath + 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< IOobject >	info () const
	Return info proxy. More...

void	operator= (const IOobject &)

template<class Name >
Foam::word	groupName (Name name, const word &group)

template<class Name >
Foam::word	modelName (Name name, const word &model)

Protected Types
using	SpTable = HashTable< const SecondaryPropertyModel< ModelType > * >

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

SpTable	SecondaryPropertyModelTable_
	Table with pointers to all secondary properties of ModelType. More...

Additional Inherited Members
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...

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 Name >
static word	modelName (Name name, const word &model)
	Return the name of the object within the given model. 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 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...

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...

Detailed Description

template<class ModelType>
class Foam::diameterModels::SecondaryPropertyModel< ModelType >

Base class for modeling the transport of an additional secondary property in between size groups by means of coalescence, breakup, drift and nucleation. The default behavior is conserved transport of the property, which can be overwritten in a derived class.

Source files

Definition at line 56 of file SecondaryPropertyModel.H.

Member Typedef Documentation

◆ SpTable

using SpTable = HashTable<const SecondaryPropertyModel<ModelType>*>

protected

Definition at line 66 of file SecondaryPropertyModel.H.

Constructor & Destructor Documentation

◆ SecondaryPropertyModel() [1/2]

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

Construct from dictionary and sizeGroup.

◆ SecondaryPropertyModel() [2/2]

SecondaryPropertyModel ( const SecondaryPropertyModel< ModelType > & )

delete

Disallow default bitwise copy construction.

◆ ~SecondaryPropertyModel()

virtual ~SecondaryPropertyModel ( )

virtual

Destructor.

Member Function Documentation

◆ SecondaryPropertyModelTable()

const SpTable& SecondaryPropertyModelTable ( )

Return table with pointers to all secondary properties of.

ModelType available in the registry

◆ SecondaryPropertyName()

const word SecondaryPropertyName ( const sizeGroup & fi ) const

Return name of the secondary property of another class for.

for lookup in registry

◆ fld()

virtual const volScalarField& fld ( ) const

pure virtual

Return reference to secondary property field.

Implemented in fractal.

◆ src()

virtual volScalarField& src ( )

pure virtual

Access to secondary property source.

Implemented in fractal.

◆ addCoalescence()

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

virtual

Add coalescence contribution to secondary property source.

◆ addBreakup()

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

virtual

Add breakup contribution to secondary property source.

◆ addDrift()

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

virtual

Add drift contribution to secondary property source.

Reimplemented in fractal.

◆ addNucleation()

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

virtual

Add drift contribution to secondary property source.

◆ reset()

virtual void reset ( )

virtual

Reset secondary property source.

◆ writeData()

bool writeData ( Ostream & ) const

virtual

Dummy write for regIOobject.

Implements regIOobject.

◆ operator=()

void operator= ( const SecondaryPropertyModel< ModelType > & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ sizeGroup_

const sizeGroup& sizeGroup_

protected

Reference to sizeGroup.

Definition at line 71 of file SecondaryPropertyModel.H.

◆ SecondaryPropertyModelTable_

SpTable SecondaryPropertyModelTable_

protected

Table with pointers to all secondary properties of ModelType.

available in the registry

Definition at line 75 of file SecondaryPropertyModel.H.

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

applications/solvers/multiphase/multiphaseEulerFoam/phaseSystems/diameterModels/velocityGroup/sizeGroup/SecondaryPropertyModel/SecondaryPropertyModel.H

Public Member Functions

Protected Types

Protected Attributes

Additional Inherited Members

Detailed Description

template<class ModelType> class Foam::diameterModels::SecondaryPropertyModel< ModelType >

Member Typedef Documentation

◆ SpTable

Constructor & Destructor Documentation

◆ SecondaryPropertyModel() [1/2]

◆ SecondaryPropertyModel() [2/2]

◆ ~SecondaryPropertyModel()

Member Function Documentation

◆ SecondaryPropertyModelTable()

◆ SecondaryPropertyName()

◆ fld()

◆ src()

◆ addCoalescence()

◆ addBreakup()

◆ addDrift()

◆ addNucleation()

◆ reset()

◆ writeData()

◆ operator=()

Member Data Documentation

◆ sizeGroup_

◆ SecondaryPropertyModelTable_

template<class ModelType>
class Foam::diameterModels::SecondaryPropertyModel< ModelType >