Sets the population balance size distribution by overwriting the values in the size-group fraction fields with values obtained by integrating a given distribution. More...

Inheritance diagram for populationBalanceSetSizeDistribution:

[legend]

Collaboration diagram for populationBalanceSetSizeDistribution:

[legend]

Public Member Functions
	TypeName ("populationBalanceSetSizeDistribution")
	Runtime type information. More...

	populationBalanceSetSizeDistribution (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	populationBalanceSetSizeDistribution (const populationBalanceSetSizeDistribution &)=delete
	Disallow default bitwise copy construction. More...

virtual	~populationBalanceSetSizeDistribution ()
	Destructor. More...

virtual wordList	fields () const
	Return the list of fields required. More...

virtual bool	execute ()
	Execute. Does nothing. More...

virtual bool	write ()
	Calculate and write the size group fraction fields. More...

void	operator= (const populationBalanceSetSizeDistribution &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from fvMeshFunctionObject
	TypeName ("fvMeshFunctionObject")
	Runtime type information. More...

	fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	fvMeshFunctionObject (const word &name, const objectRegistry &obr)
	Construct from the region objectRegistry. More...

	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~fvMeshFunctionObject ()
	Destructor. More...

const fvMesh &	mesh () const
	Return a reference to the mesh. More...

void	operator= (const fvMeshFunctionObject &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from regionFunctionObject
	TypeName ("regionFunctionObject")
	Runtime type information. More...

	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	regionFunctionObject (const word &name, const objectRegistry &obr)
	Construct from the region objectRegistry. More...

	regionFunctionObject (const regionFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~regionFunctionObject ()
	Destructor. More...

void	operator= (const regionFunctionObject &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from objectRegistryFunctionObject
	TypeName ("objectRegistryFunctionObject")
	Runtime type information. More...

	objectRegistryFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from an objectRegistry and dictionary. More...

	objectRegistryFunctionObject (const word &name, const objectRegistry &obr)
	Construct from an objectRegistry. More...

	objectRegistryFunctionObject (const objectRegistryFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~objectRegistryFunctionObject ()
	Destructor. More...

virtual bool	read (const dictionary &)
	Read optional controls. More...

void	operator= (const objectRegistryFunctionObject &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from functionObject
	ClassName ("functionObject")

virtual const word &	type () const =0
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name, const Time &runTime)
	Construct from components. More...

	functionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from dictionary. More...

autoPtr< functionObject >	clone () const
	Return clone. More...

	functionObject (const functionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~functionObject ()
	Destructor. More...

const word &	name () const
	Return the name of this functionObject. More...

virtual bool	executeAtStart () const
	Return true if the functionObject should be executed at the start. More...

virtual bool	end ()
	Called when Time::run() determines that the time-loop exits. More...

virtual scalar	timeToNextAction ()
	Called by Time::adjustTimeStep(). Allows the functionObject to. More...

virtual scalar	maxDeltaT () const
	Return the maximum time-step for stable operation. More...

virtual void	movePoints (const polyMesh &mesh)
	Update topology using the given map. More...

virtual void	topoChange (const polyTopoChangeMap &map)
	Update topology using the given map. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

virtual void	distribute (const polyDistributionMap &)
	Redistribute or update using the given distribution map. More...

void	operator= (const functionObject &)=delete
	Disallow default bitwise assignment. More...

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &, const dictionary &)
	Select from dictionary, based on its "type" entry. More...

Public Attributes inherited from functionObject
Switch	log
	Switch write log to Info. More...

Switch	executeAtStart_
	Switch execute at start time. More...

Static Public Attributes inherited from functionObject
static bool	postProcess
	Global post-processing mode switch. More...

Protected Member Functions inherited from objectRegistryFunctionObject
template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find field in the objectRegistry. More...

template<class ObjectType >
void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

void	cannotFindObjects (const wordList &fieldNames)
	Prints a warning message that fieldNames cannot be found. More...

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup object from the objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName)
	Lookup non-const object reference from the objectRegistry. More...

template<class ObjectType >
ObjectType &	store (const tmp< ObjectType > &tfield)
	Store the given field in the objectRegistry. More...

template<class ObjectType >
ObjectType &	store (const word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
	Store the given field in the objectRegistry under the given name. More...

bool	writeObject (const word &fieldName)
	Write field if present in objectRegistry. More...

bool	clearObject (const word &fieldName)
	Clear field from the objectRegistry if present. More...

Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
	Reference to the fvMesh. More...

Protected Attributes inherited from objectRegistryFunctionObject
const objectRegistry &	obr_
	Reference to the objectRegistry. More...

Protected Attributes inherited from functionObject
const Time &	time_
	Reference to time. More...

Detailed Description

Sets the population balance size distribution by overwriting the values in the size-group fraction fields with values obtained by integrating a given distribution.

This function will only execute in post-processing mode.

Example of function object specification:

populationBalanceSetSizeDistribution
{
    type        populationBalanceSetSizeDistribution;
    libs        ("libmultiphaseEulerFunctionObjects.so");

    populationBalance bubbles;

    //phase       air1; // <-- alternative to specifying
                        //     'populationBalance' if only a single phase's
                        //     size group fractions are to be set

    distribution
    {
        type        tabulatedDensity;
        Q           3;
        file        "constant/initialDistribution.bubbles";
    }
}

Usage

Property	Description	Required
`populationBalance`	population balance name	if phase is not </td>
`specified`
`phase`	phase name	if populationBalance is </td>
`not` specified
`distribution`	the distribution	yes

See also: Foam::diameterModels::populationBalanceModel Foam::functionObjects::fvMeshFunctionObject Foam::functionObject

Source files

Definition at line 116 of file populationBalanceSetSizeDistribution.H.

Constructor & Destructor Documentation

◆ populationBalanceSetSizeDistribution() [1/2]

populationBalanceSetSizeDistribution	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict
	)

Construct from Time and dictionary.

Definition at line 50 of file populationBalanceSetSizeDistribution.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, word::null, and objectRegistryFunctionObject::read().

Here is the call graph for this function:

◆ populationBalanceSetSizeDistribution() [2/2]

populationBalanceSetSizeDistribution ( const populationBalanceSetSizeDistribution & )

delete

Disallow default bitwise copy construction.

◆ ~populationBalanceSetSizeDistribution()

~populationBalanceSetSizeDistribution ( )

virtual

Destructor.

Definition at line 83 of file populationBalanceSetSizeDistribution.C.

Member Function Documentation

◆ TypeName()

TypeName ( "populationBalanceSetSizeDistribution" )

Runtime type information.

◆ fields()

virtual wordList fields ( ) const

inlinevirtual

Return the list of fields required.

Implements functionObject.

Definition at line 164 of file populationBalanceSetSizeDistribution.H.

References List< word >::null().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Execute. Does nothing.

Implements functionObject.

Definition at line 90 of file populationBalanceSetSizeDistribution.C.

◆ write()

bool write ( )

virtual

Calculate and write the size group fraction fields.

Implements functionObject.

Definition at line 96 of file populationBalanceSetSizeDistribution.C.

References alpha(), token::COLON, Foam::decrIndent(), Foam::dimless, Foam::endl(), populationBalanceModel::etaV(), forAll, forAllConstIter, sizeGroup::group(), IOobject::groupName(), Foam::incrIndent(), Foam::indent(), Foam::Info, mesh, phaseModel::name(), IOobject::name(), Foam::name(), GeometricField< Type, GeoMesh, PrimitiveField >::New(), Foam::nl, word::null, sizeGroup::phase(), phaseSystem::phases(), velocityGroup::popBal(), functionObject::postProcess, phaseSystem::propertiesName, tmp< T >::ref(), velocityGroup::sizeGroups(), populationBalanceModel::sizeGroups(), WarningInFunction, and regIOobject::write().

Here is the call graph for this function:

◆ operator=()

void operator= ( const populationBalanceSetSizeDistribution & )

delete

Disallow default bitwise assignment.

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

applications/modules/multiphaseEuler/functionObjects/populationBalanceSetSizeDistribution/populationBalanceSetSizeDistribution.H
applications/modules/multiphaseEuler/functionObjects/populationBalanceSetSizeDistribution/populationBalanceSetSizeDistribution.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ populationBalanceSetSizeDistribution() [1/2]

◆ populationBalanceSetSizeDistribution() [2/2]

◆ ~populationBalanceSetSizeDistribution()

Member Function Documentation

◆ TypeName()

◆ fields()

◆ execute()

◆ write()

◆ operator=()