Creates a droplet size distribution via interrogating a continuous phase fraction field. More...

Inheritance diagram for regionSizeDistribution:

Collaboration diagram for regionSizeDistribution:

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

	regionSizeDistribution (const word &name, const Time &runTime, const dictionary &)
	Construct for given objectRegistry and dictionary. More...

	regionSizeDistribution (const regionSizeDistribution &)=delete
	No copy construct. More...

void	operator= (const regionSizeDistribution &)=delete
	No copy assignment. More...

virtual	~regionSizeDistribution ()=default

virtual bool	read (const dictionary &)
	Read the regionSizeDistribution data. More...

virtual bool	execute ()
	Do nothing. More...

virtual bool	write ()
	Calculate the regionSizeDistribution and write. More...

template<class Type >
Foam::Map< Type >	regionSum (const regionSplit &regions, const Field< Type > &fld) const

template<class Type >
Foam::List< Type >	extractData (const labelUList &keys, const Map< Type > &regionData) const

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, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

virtual	~fvMeshFunctionObject ()=default
	Destructor. 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, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

virtual	~regionFunctionObject ()=default
	Destructor. More...

template<class ObjectType >
const ObjectType *	lookupObjectPtr (const word &fieldName) const
	Deprecated(2018-10) More...

template<class ObjectType >
ObjectType *	lookupObjectRefPtr (const word &fieldName) const
	Deprecated(2018-10) More...

Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)
	Construct from components. More...

virtual	~stateFunctionObject ()=default
	Destructor. More...

dictionary &	propertyDict ()
	Return access to the property dictionary. More...

bool	foundProperty (const word &entryName) const
	Return true if the property exists. More...

void	clearTrigger ()
	Remove the trigger index from the properties. More...

label	getTrigger () const
	Get the current trigger index. More...

bool	setTrigger (const label triggeri, bool increaseOnly=true)
	Set the trigger index. Normally only if greater than current. More...

bool	getDict (const word &entryName, dictionary &dict) const
	Set dictionary, return true if set. More...

bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
	Set dictionary from named object, return true if set. More...

template<class Type >
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property. More...

template<class Type >
bool	getProperty (const word &entryName, Type &value) const
	Set generic property, return true if set. More...

template<class Type >
void	setProperty (const word &entryName, const Type &value)
	Add generic property. More...

template<class Type >
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from named object. More...

template<class Type >
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const
	Set generic property from named object, return true if set. More...

template<class Type >
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)
	Add generic property from named object. More...

template<class Type >
void	setResult (const word &entryName, const Type &value)
	Add result. More...

template<class Type >
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)
	Add result from named object. More...

template<class Type >
Type	getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result. More...

template<class Type >
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result from named object. More...

template<class Type >
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const
	Set result from named object, return true if set. More...

word	resultType (const word &entryName) const
	Retrieve the result type. More...

word	objectResultType (const word &objectName, const word &entryName) const
	Return the type of result. More...

wordList	objectResultEntries () const
	Retrieve the result entries. More...

wordList	objectResultEntries (const word &objectName) const
	Return result entries for named object. More...

void	writeResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

void	writeResultEntries (const word &objectName, Ostream &os) const
	Write the results entries for named object to stream. More...

void	writeAllResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)
	Construct from Time. More...

virtual	~timeFunctionObject ()=default
	Destructor. More...

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

objectRegistry &	storedObjects ()

const objectRegistry &	storedObjects () const

Public Member Functions inherited from functionObject
	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix)
	Construct from components. More...

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

virtual	~functionObject ()=default
	Destructor. More...

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

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

bool	useNamePrefix () const noexcept
	Return the flag for adding a scoping name prefix. More...

bool	useNamePrefix (bool on) noexcept
	Modify the flag for adding a scoping name prefix. More...

virtual bool	execute (const label subIndex)
	Execute using the specified subIndex. More...

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

virtual bool	adjustTimeStep ()
	Called at the end of Time::adjustDeltaT() if adjustTime is true. More...

virtual bool	filesModified () const
	Did any file get changed during execution? More...

virtual void	updateMesh (const mapPolyMesh &mpm)
	Update for changes of mesh. More...

virtual void	movePoints (const polyMesh &mesh)
	Update for changes of mesh. More...

Public Member Functions inherited from writeFile
	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name="undefined", const bool writeToFile=true)
	Construct from objectRegistry, prefix, fileName. More...

	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name, const dictionary &dict, const bool writeToFile=true)

	writeFile (const writeFile &wf)
	Construct copy. More...

virtual	~writeFile ()=default
	Destructor. More...

virtual OFstream &	file ()
	Return access to the file (if only 1) More...

virtual bool	writeToFile () const
	Flag to allow writing to file. More...

virtual bool	canWriteHeader () const
	Flag to allow writing the header. More...

virtual label	charWidth () const
	Return width of character stream output. More...

virtual void	writeCommented (Ostream &os, const string &str) const
	Write a commented string to stream. More...

virtual void	writeTabbed (Ostream &os, const string &str) const
	Write a tabbed string to stream. More...

virtual void	writeHeader (Ostream &os, const string &str) const
	Write a commented header to stream. More...

virtual void	writeCurrentTime (Ostream &os) const
	Write the current time to stream. More...

virtual void	writeBreak (Ostream &os) const
	Write a break marker to the stream. More...

template<class Type >
void	writeHeaderValue (Ostream &os, const string &property, const Type &value) const
	Write a (commented) header property and value pair. More...

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

Public Attributes inherited from functionObject
bool	log
	Flag to write log into Info. More...

Static Public Attributes inherited from functionObject
static int	debug
	Flag to execute debug content. More...

static bool	postProcess
	Global post-processing mode switch. More...

static bool	defaultUseNamePrefix
	Global default for useNamePrefix. More...

static word	outputPrefix
	Directory prefix. More...

Static Public Attributes inherited from writeFile
static label	addChars = 8
	Additional characters for writing. More...

Protected Member Functions inherited from fvMeshFunctionObject
	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	No copy construct. More...

void	operator= (const fvMeshFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry &	obr () const
	The region or sub-region registry being used. More...

template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find object (eg, a field) in the (sub) objectRegistry. More...

template<class ObjectType >
const ObjectType *	cfindObject (const word &fieldName) const

template<class ObjectType >
const ObjectType *	findObject (const word &fieldName) const

template<class ObjectType >
ObjectType *	findObject (const word &fieldName)

template<class ObjectType >
ObjectType *	getObjectPtr (const word &fieldName) const

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry. More...

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

template<class ObjectType >
bool	storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr)
	Store the field in an optional objectRegistry under the given name. More...

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

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

void	clearObjects (const wordList &objNames)
	Clear fields from the (sub) objectRegistry if present. More...

	regionFunctionObject (const regionFunctionObject &)=delete
	No copy construct. More...

void	operator= (const regionFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties &	stateDict () const
	Return a const reference to the state dictionary. More...

functionObjects::properties &	stateDict ()
	Return non-const access to the state dictionary. More...

	stateFunctionObject (const stateFunctionObject &)=delete
	No copy construct. More...

void	operator= (const stateFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)
	Remove specified items from "functionObjectObjects". More...

	timeFunctionObject (const timeFunctionObject &)=delete
	No copy construct. More...

void	operator= (const timeFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
	Return a scoped (prefixed) name. More...

Protected Member Functions inherited from writeFile
void	initStream (Ostream &os) const
	Initialise the output stream for writing. More...

fileName	baseFileDir () const
	Return the base directory for output. More...

fileName	baseTimeDir () const
	Return the base directory for the current time value. More...

virtual autoPtr< OFstream >	createFile (const word &name, scalar timeValue) const
	Return autoPtr to a new file for a given time. More...

virtual autoPtr< OFstream >	createFile (const word &name) const
	Return autoPtr to a new file using the simulation start time. More...

virtual void	resetFile (const word &name)
	Reset internal file pointer to new file with new name. More...

Omanip< int >	valueWidth (const label offset=0) const
	Return the value width when writing to stream with optional offset. More...

void	operator= (const writeFile &)=delete
	No copy assignment. More...

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

Protected Attributes inherited from regionFunctionObject
word	subRegistryName_
	Name for alternative object registry. More...

const objectRegistry &	obr_
	Reference to the region objectRegistry. More...

const objectRegistry *	obrPtr_
	Pointer to alternative (eg, sub-region) objectRegistry. More...

Protected Attributes inherited from timeFunctionObject
const Time &	time_
	Reference to the time database. More...

Protected Attributes inherited from writeFile
const objectRegistry &	fileObr_
	Reference to the region objectRegistry. More...

const fileName	prefix_
	Prefix. More...

word	fileName_
	Name of file. More...

autoPtr< OFstream >	filePtr_
	File pointer. More...

label	writePrecision_
	Write precision. More...

bool	writeToFile_
	Flag to enable/disable writing to file. More...

bool	updateHeader_

bool	writtenHeader_
	Flag to identify whether the header has been written. More...

bool	useUserTime_

scalar	startTime_
	Start time value. More...

Detailed Description

Creates a droplet size distribution via interrogating a continuous phase fraction field.

Looks up a phase-fraction (alpha) field and splits the mesh into regions based on where the field is below the threshold value. These regions ("droplets") can now be analysed.

Regions:

print the regions connected to a user-defined set of patches. (in spray calculation these form the liquid core)
print the regions with too large volume. These are the 'background' regions.
(debug) write regions as a volScalarField
(debug) print for all regions the sum of volume and alpha*volume

Output (volume scalar) fields include:

alpha_liquidCore : alpha with outside liquid core set to 0
alpha_background : alpha with outside background set to 0.

Histogram:

determine histogram of diameter (given minDiameter, maxDiameter, nBins)
write graph of number of droplets per bin
write graph of sum, average and deviation of droplet volume per bin
write graph of sum, average and deviation of user-defined fields. For volVectorFields these are those of the 3 components and the magnitude.
(optional) write graph of histogram of centroids on iso planes downstream of the injector determined by origin, direction and maxDiameter up to maxDownstream

Operands:

Operand	Type	Location
`input`	-	-
`output` file	-	$FOAM_CASE/postProcessing/<FO>/<time>/<files>
`output` field	-	-

Usage

Minimal example by using system/controlDict.functions:

regionSizeDistribution1
{
    // Mandatory entries (unmodifiable)
    type            regionSizeDistribution;
    libs            (fieldFunctionObjects);

    // Mandatory entries (runtime modifiable)
    field           alpha;
    patches         (inlet);
    fields          (p U);
    threshold       0.4;
    maxDiameter     5e-5;
    nBins           100;
    setFormat       gnuplot;

    // Optional entries (runtime modifiable)
    minDiameter     0.0;
    coordinateSystem
    {
        origin  (0 0 0);
        rotation
        {
            type    axes;
            e3      (0 0 1);
            e1      (1 0 0);
        }
    }

    // Optional downstream iso-plane bins
    isoPlanes       true;

        // Mandatory entries if isoPlanes=true   (runtime modifiable)
        // Plane normal and point definition
        origin          (1e-4 0 5e-4);
        direction       (1 0 1);

        // Maximum diameter of the cylinder formed by the origin point
        // and direction
        maxD            3e-4;

        // Maximum downstream distance
        maxDownstream   6e-4;

        // Number of iso-plane bins
        nDownstreamBins 20;

    // Optional (inherited) entries
    ...
}

where the entries mean:

Property	Description	Type	Req'd	Dflt
`type`	Type name: regionSizeDistribution	word	yes	-
`libs`	Library name: fieldFunctionObjects	word	yes	-
`field`	Phase field to interrogate	word	yes	-
`patches`	Patches wherefrom the liquid core is identified	wordList	yes	-
`fields`	Fields to sample	wordList	yes	-
`threshold`	Phase fraction applied to delimit regions	scalar	yes	-
`maxDiameter`	Maximum droplet diameter	scalar	yes	-
`minDiameter`	Minimum droplet diameter	scalar	no	0.0
`nBins`	Number of bins for histogram	label	yes	-
`setFormat`	Output format	word	yes	-
`isoPlanes`	Flag for isoPlanes	bool	no	false
`origin`	Origin of the plane when isoPlanes is used	vector	yes	-
`direction`	Direction of the plane when isoPlanes is used	vector	yes	-
`maxD`	Maximum diameter of the sampling cylinder when isoPlanes is used	vector	yes	-
`nDownstreamBins`	Number of bins when isoPlanes is used	label	yes	-
`maxDownstream`	Maximum distance from origin when isoPlanes is used	scalar	yes	-

The inherited entries are elaborated in:

Usage by the postProcess utility is not available.

See also

Foam::functionObject
Foam::functionObjects::fvMeshFunctionObject
Foam::functionObjects::writeFile
ExtendedCodeGuide::functionObjects::field::regionSizeDistribution

Source files

Definition at line 331 of file regionSizeDistribution.H.

Constructor & Destructor Documentation

◆ regionSizeDistribution() [1/2]

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

Construct for given objectRegistry and dictionary.

Allow the possibility to load fields from files

Definition at line 314 of file regionSizeDistribution.C.

References dict, and Foam::read().

Here is the call graph for this function:

◆ regionSizeDistribution() [2/2]

regionSizeDistribution ( const regionSizeDistribution & )

delete

No copy construct.

◆ ~regionSizeDistribution()

virtual ~regionSizeDistribution ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "regionSizeDistribution" )

Runtime type information.

◆ operator=()

void operator= ( const regionSizeDistribution & )

delete

No copy assignment.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the regionSizeDistribution data.

Reimplemented from writeFile.

Definition at line 332 of file regionSizeDistribution.C.

References dict, Foam::endl(), format(), Foam::Info, writer< Type >::New(), coordinateSystem::New(), regionFunctionObject::read(), and writeFile::read().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Do nothing.

Implements functionObject.

Definition at line 378 of file regionSizeDistribution.C.

◆ write()

bool write ( )

virtual

Calculate the regionSizeDistribution and write.

Implements functionObject.

Definition at line 384 of file regionSizeDistribution.C.

References Foam::constant::atomic::alpha, alphaPtr, Foam::cbrt(), VectorSpace< Vector< scalar >, scalar, 3 >::componentNames, fvPatchField< Type >::coupled(), Foam::expressions::patchExpr::debug, delta, Foam::dimless, Foam::fvc::domainIntegrate(), Foam::endl(), fld, forAll, forAllConstIters(), forAllIters, Foam::gSum(), Foam::Info, Log, Foam::mag(), UPstream::master(), IOobject::MUST_READ, Foam::name(), dimensioned< Type >::name(), VectorSpace< Vector< scalar >, scalar, 3 >::nComponents, Foam::nl, IOobject::NO_READ, IOobject::NO_WRITE, regionSplit::nRegions(), fvPatch::patch(), fvPatchField< Type >::patch(), fvPatchField< Type >::patchInternalField(), fvPatchField< Type >::patchNeighbourField(), Foam::constant::mathematical::pi(), Foam::pow3(), polyPatch::start(), token::TAB, Foam::type(), regIOobject::write(), x, and Foam::Zero.

Here is the call graph for this function:

◆ regionSum()

Foam::Map<Type> regionSum	(	const regionSplit &	regions,
		const Field< Type > &	fld
	)		const

Definition at line 37 of file regionSizeDistributionTemplates.C.

References fld, forAll, regionSplit::nRegions(), and Foam::Zero.

Here is the call graph for this function:

◆ extractData()

Foam::List<Type> extractData	(	const labelUList &	keys,
		const Map< Type > &	regionData
	)		const

Definition at line 60 of file regionSizeDistributionTemplates.C.

References forAll, and UList< T >::size().

Here is the call graph for this function:

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

src/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H
src/functionObjects/field/regionSizeDistribution/regionSizeDistribution.C
src/functionObjects/field/regionSizeDistribution/regionSizeDistributionTemplates.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ regionSizeDistribution() [1/2]

◆ regionSizeDistribution() [2/2]

◆ ~regionSizeDistribution()

Member Function Documentation

◆ TypeName()

◆ operator=()

◆ read()

◆ execute()

◆ write()

◆ regionSum()

◆ extractData()