Generates particle size information from Eulerian calculations, e.g. VoF. More...

#include <extractEulerianParticles.H>

Inheritance diagram for extractEulerianParticles:

[legend]

Collaboration diagram for extractEulerianParticles:

[legend]

Public Member Functions
	TypeName ("extractEulerianParticles")
	Runtime type information.
	extractEulerianParticles (const word &name, const Time &runTime, const dictionary &dict)
	Construct from components.
	extractEulerianParticles (const extractEulerianParticles &)=delete
	No copy construct.
void	operator= (const extractEulerianParticles &)=delete
	No copy assignment.
virtual	~extractEulerianParticles ()=default
	Destructor.
virtual bool	read (const dictionary &dict)
	Read the function-object dictionary.
virtual bool	execute ()
	Execute the function-object operations.
virtual bool	write ()
	Write the function-object results.
Public Member Functions inherited from fvMeshFunctionObject
	TypeName ("fvMeshFunctionObject")
	Runtime type information.
	fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary.
	fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary.
virtual	~fvMeshFunctionObject ()=default
	Destructor.
Public Member Functions inherited from regionFunctionObject
	TypeName ("regionFunctionObject")
	Runtime type information.
	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary.
	regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary.
virtual	~regionFunctionObject ()=default
	Destructor.
template<class ObjectType>
const ObjectType *	lookupObjectPtr (const word &fieldName) const
	Deprecated(2018-10).
template<class ObjectType>
ObjectType *	lookupObjectRefPtr (const word &fieldName) const
	Deprecated(2018-10).
Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)
	Construct from components.
virtual	~stateFunctionObject ()=default
	Destructor.
dictionary &	propertyDict ()
	Return access to the property dictionary.
bool	foundProperty (const word &entryName) const
	Return true if the property exists.
void	clearTrigger ()
	Remove the trigger index from the properties.
label	getTrigger () const
	Get the current trigger index.
bool	setTrigger (const label triggeri)
	Set new trigger index.
bool	getDict (const word &entryName, dictionary &dict) const
	Set dictionary, return true if set.
bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
	Set dictionary from named object, return true if set.
template<class Type>
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property.
template<class Type>
bool	getProperty (const word &entryName, Type &value) const
	Set generic property, return true if set.
template<class Type>
void	setProperty (const word &entryName, const Type &value)
	Add generic property.
template<class Type>
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from named object.
template<class Type>
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const
	Set generic property from named object, return true if set.
template<class Type>
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)
	Add generic property from named object.
bool	getObjectResultDict (const word &objectName, dictionary &dict) const
template<class Type>
void	setResult (const word &entryName, const Type &value)
	Add result.
template<class Type>
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)
	Add result from named object.
template<class Type>
Type	getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result.
template<class Type>
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result from named object.
template<class Type>
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const
	Set result from named object, return true if set.
word	resultType (const word &entryName) const
	Retrieve the result type.
word	objectResultType (const word &objectName, const word &entryName) const
	Return the type of result.
wordList	objectResultEntries () const
	Retrieve the result entries.
wordList	objectResultEntries (const word &objectName) const
	Return result entries for named object.
void	writeResultEntries (Ostream &os) const
	Write the results entries for all objects to stream.
void	writeResultEntries (const word &objectName, Ostream &os) const
	Write the results entries for named object to stream.
void	writeAllResultEntries (Ostream &os) const
	Write the results entries for all objects to stream.
Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)
	Construct from Time.
virtual	~timeFunctionObject ()=default
	Destructor.
const Time &	time () const
	Return time database.
objectRegistry &	storedObjects ()
	Write access to the output objects ("functionObjectObjects") registered on Time.
const objectRegistry &	storedObjects () const
	Const access to the output objects ("functionObjectObjects") registered on Time.
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.
autoPtr< functionObject >	clone () const
	Return clone.
virtual	~functionObject ()=default
	Destructor.
virtual const word &	type () const =0
	Runtime type information.
const word &	name () const noexcept
	Return the name of this functionObject.
bool	useNamePrefix () const noexcept
	Return the flag for adding a scoping name prefix.
bool	useNamePrefix (bool on) noexcept
	Modify the flag for adding a scoping name prefix.
virtual bool	execute (const label subIndex)
	Execute using the specified subIndex.
virtual bool	end ()
	Called when Time::run() determines that the time-loop exits.
virtual bool	adjustTimeStep ()
	Called at the end of Time::adjustDeltaT() if adjustTime is true.
virtual bool	filesModified () const
	Did any file get changed during execution?
virtual void	updateMesh (const mapPolyMesh &mpm)
	Update for changes of mesh.
virtual void	movePoints (const polyMesh &mesh)
	Update for changes of mesh.
Public Member Functions inherited from writeFile
	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name="undefined", const bool writeToFile=true, const string &ext=".dat")
	Construct from objectRegistry, prefix, fileName.
	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name, const dictionary &dict, const bool writeToFile=true, const string &ext=".dat")
	Construct from objectRegistry, prefix, fileName and read options from dictionary.
	writeFile (const writeFile &wf)
	Construct copy.
virtual	~writeFile ()=default
	Destructor.
virtual const string &	setExt (const string &ext)
	Set extension.
virtual OFstream &	file ()
	Return access to the file (if only 1).
virtual bool	writeToFile () const
	Flag to allow writing to file.
virtual bool	canWriteToFile () const
	Flag to allow writing to the file.
virtual bool	canResetFile () const
	Flag to allow resetting the file.
virtual bool	canWriteHeader () const
	Flag to allow writing the header.
virtual label	charWidth () const
	Return width of character stream output.
virtual void	writeCommented (Ostream &os, const string &str) const
	Write a commented string to stream.
virtual void	writeTabbed (Ostream &os, const string &str) const
	Write a tabbed string to stream.
virtual void	writeHeader (Ostream &os, const string &str) const
	Write a commented header to stream.
virtual void	writeCurrentTime (Ostream &os) const
	Write the current time to stream.
virtual void	writeBreak (Ostream &os) const
	Write a break marker to the stream.
template<class Type>
void	writeHeaderValue (Ostream &os, const string &property, const Type &value) const
	Write a (commented) header property and value pair.
template<class Type>
void	writeValue (Ostream &os, const Type &val) const
	Write a given value to stream with the space delimiter.

Protected Member Functions
virtual void	checkFaceZone ()
	Check that the faceZone is valid.
virtual void	initialiseBins ()
	Initialise the particle collection bins.
virtual tmp< surfaceScalarField >	phiU () const
	Return the volumetric flux.
virtual void	setBlockedFaces (const surfaceScalarField &alphaf, const faceZone &fz, boolList &blockedFaces)
	Set the blocked faces, i.e. where alpha > alpha threshold value.
virtual void	calculateAddressing (const label nRegionsNew, const scalar time, labelList &regionFaceIDs)
	Calculate the addressing between regions between iterations Returns the number of active regions (particles).
virtual void	collectParticle (const scalar time, const label regioni)
	Collect particles that have passed through the faceZone.
virtual void	accumulateParticleInfo (const surfaceScalarField &alphaf, const surfaceScalarField &phi, const labelList &regionFaceIDs, const faceZone &fz)
	Process latest region information.
template<class Type>
Type	faceValue (const GeometricField< Type, fvsPatchField, surfaceMesh > &field, const label localFaceI, const label globalFaceI) const
Protected Member Functions inherited from fvMeshFunctionObject
	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	No copy construct.
void	operator= (const fvMeshFunctionObject &)=delete
	No copy assignment.
Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry &	obr () const
	The region or sub-region registry being used.
template<class ObjectType>
bool	foundObject (const word &fieldName) const
	Find object (eg, a field) in the (sub) objectRegistry.
template<class ObjectType>
const ObjectType *	cfindObject (const word &fieldName) const
	Return const pointer to the object (eg, a field) in the (sub) objectRegistry.
template<class ObjectType>
const ObjectType *	findObject (const word &fieldName) const
	Return const pointer to the object (eg, a field) in the (sub) objectRegistry.
template<class ObjectType>
ObjectType *	findObject (const word &fieldName)
	Return non-const pointer to the object of the given Type, (sub) objectRegistry.
template<class ObjectType>
ObjectType *	getObjectPtr (const word &fieldName) const
	Return non-const pointer to the object of the given Type, using a const-cast to have it behave like a mutable.
template<class ObjectType>
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry.
template<class ObjectType>
ObjectType &	lookupObjectRef (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry.
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.
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.
bool	writeObject (const word &fieldName)
	Write field if present in the (sub) objectRegistry.
bool	clearObject (const word &fieldName)
	Clear field from the (sub) objectRegistry if present.
void	clearObjects (const wordList &objNames)
	Clear fields from the (sub) objectRegistry if present.
	regionFunctionObject (const regionFunctionObject &)=delete
	No copy construct.
void	operator= (const regionFunctionObject &)=delete
	No copy assignment.
Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties &	stateDict () const
	Return a const reference to the state dictionary.
functionObjects::properties &	stateDict ()
	Return non-const access to the state dictionary.
	stateFunctionObject (const stateFunctionObject &)=delete
	No copy construct.
void	operator= (const stateFunctionObject &)=delete
	No copy assignment.
Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)
	Remove specified items from "functionObjectObjects".
	timeFunctionObject (const timeFunctionObject &)=delete
	No copy construct.
void	operator= (const timeFunctionObject &)=delete
	No copy assignment.
Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
	Return a scoped (prefixed) name.
Protected Member Functions inherited from writeFile
void	initStream (Ostream &os) const
	Initialise the output stream for writing.
fileName	baseFileDir () const
	Return the base directory for output.
fileName	baseTimeDir () const
	Return the base directory for the current time value.
fileName	filePath (const fileName &fName) const
	Return the full path for the supplied file name.
virtual autoPtr< OFstream >	newFile (const fileName &fName) const
	Return autoPtr to a new file using file name.
virtual autoPtr< OFstream >	newFileAtTime (const word &name, scalar timeValue) const
	Return autoPtr to a new file for a given time.
virtual autoPtr< OFstream >	newFileAtStartTime (const word &name) const
	Return autoPtr to a new file using the simulation start time.
virtual void	resetFile (const word &name)
	Reset internal file pointer to new file with new name.
Omanip< int >	valueWidth (const label offset=0) const
	Return the value width when writing to stream with optional offset.
void	operator= (const writeFile &)=delete
	No copy assignment.
virtual autoPtr< OFstream >	createFile (const word &name, scalar timeValue) const
	Deprecated(2022-09) Return autoPtr to a new file for a given time.
virtual autoPtr< OFstream >	createFile (const word &name) const
	Deprecated(2022-09) Return autoPtr to a new file using the simulation start time.

Protected Attributes
injectedParticleCloud	cloud_
	Storage for collected particles.
word	faceZoneName_
	Name of faceZone to sample.
label	zoneID_
	Index of the faceZone.
labelList	patchIDs_
	Patch indices where faceZone face intersect patch.
labelList	patchFaceIDs_
	Patch face indices where faceZone face intersect patch.
word	alphaName_
	Name of phase fraction field.
scalar	alphaThreshold_
	Value of phase fraction used to identify particle boundaries.
word	UName_
	Name of the velocity field, default = U.
word	rhoName_
	Name of the density field, default = rho.
word	phiName_
	Name of the flux field, default ="rho".
label	nInjectorLocations_
	Number of sample locations to generate.
labelList	fineToCoarseAddr_
	Agglomeration addressing from fine to coarse (local proc only).
globalIndex	globalCoarseFaces_
	Global coarse face addressing.
labelList	regions0_
	Region indices in faceZone faces from last iteration.
List< eulerianParticle >	particles_
	Particle properties (partial, being accumulated).
Map< label >	regionToParticleMap_
	Map from region to index in particles_ list.
scalar	minDiameter_
	Minimum diameter (optional).
scalar	maxDiameter_
	Maximum diameter (optional).
label	nCollectedParticles_
	Total number of collected particles.
scalar	collectedVolume_
	Total collected volume [m3].
label	nDiscardedParticles_
	Total number of discarded particles.
scalar	discardedVolume_
	Total discarded volume [m3].
Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
	Reference to the fvMesh.
Protected Attributes inherited from regionFunctionObject
word	subRegistryName_
	Name for alternative object registry.
const objectRegistry &	obr_
	Reference to the region objectRegistry.
const objectRegistry *	obrPtr_
	Pointer to alternative (eg, sub-region) objectRegistry.
Protected Attributes inherited from timeFunctionObject
const Time &	time_
	Reference to the time database.
Protected Attributes inherited from writeFile
const objectRegistry &	fileObr_
	Reference to the region objectRegistry.
const fileName	prefix_
	Prefix.
word	fileName_
	Name of file.
autoPtr< OFstream >	filePtr_
	File pointer.
label	writePrecision_
	Write precision.
bool	writeToFile_
	Flag to enable/disable writing to file.
bool	updateHeader_
	Flag to update the header, e.g. on mesh changes. Default is true.
bool	writtenHeader_
	Flag to identify whether the header has been written.
bool	useUserTime_
	Flag to use the specified user time, e.g. CA deg instead of seconds. Default = true.
scalar	startTime_
	Start time value.
string	ext_
	File extension; default = .dat.

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.
Public Attributes inherited from functionObject
bool	log
	Flag to write log into Info.
Static Public Attributes inherited from functionObject
static int	debug
	Flag to execute debug content.
static bool	postProcess
	Global post-processing mode switch.
static bool	defaultUseNamePrefix
	Global default for useNamePrefix.
static word	outputPrefix
	Directory prefix.
Static Public Attributes inherited from writeFile
static label	addChars = 8
	Additional characters for writing.

Detailed Description

Generates particle size information from Eulerian calculations, e.g. VoF.

Operands:

Operand	Type	Location
`input`	-	-
`output` file	-	-
`output` field 1	scalarField	$OUTPUT/d
`output` field 2	scalarField	$OUTPUT/soi
`output` field 3	labelField	$OUTPUT/tag
`output` field 4	vectorField	$OUTPUT/U

where $OUTPUT= <time>/lagrangian/eulerianParticleCloud

Usage

Minimal example by using system/controlDict.functions:

extractEulerianParticlesFO
{
    // Mandatory entries
    type            extractEulerianParticles;
    libs            (fieldFunctionObjects);
    faceZone        <word>;  // f0;
    alpha           <word>;  // alpha.water;

    // Optional entries
    alphaThreshold  <scalar>;
    nLocations      <label>;
    U               <word>;
    rho             <word>;
    phi             <word>;
    minDiameter     <scalar>;
    maxDiameter     <scalar>;

    // Inherited entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`type`	Type name: extractEulerianParticles	word	yes	-
`libs`	Library name: fieldFunctionObjects	word	yes	-
`faceZone`	Name of faceZone used as collection surface	word	yes	-
`alpha`	Name of phase indicator field	word	yes	-
`alphaThreshold`	Threshold for alpha field	scalar	no	0.1
`nLocations`	Number of injection bins to generate	label	no	0
`U`	Name of velocity field	word	no	U
`rho`	Name of density field	word	no	rho
`phi`	Name of flux field	word	no	phi
`minDiameter`	Minimum diameter	scalar	no	SMALL
`maxDiameter`	Maximum diameter	scalar	no	GREAT

The inherited entries are elaborated in:

Source files

Definition at line 216 of file extractEulerianParticles.H.

Constructor & Destructor Documentation

◆ extractEulerianParticles() [1/2]

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

Construct from components.

Definition at line 439 of file extractEulerianParticles.C.

References alphaName_, alphaThreshold_, cloud_, collectedVolume_, dict, discardedVolume_, faceZoneName_, fineToCoarseAddr_, fvMeshFunctionObject::fvMeshFunctionObject(), stateFunctionObject::getProperty(), globalCoarseFaces_, maxDiameter_, fvMeshFunctionObject::mesh_, minDiameter_, Foam::name(), nCollectedParticles_, nDiscardedParticles_, nInjectorLocations_, particles_, patchFaceIDs_, patchIDs_, phiName_, read(), regions0_, regionToParticleMap_, rhoName_, runTime, UName_, writeFile::writeFile(), and zoneID_.

Referenced by extractEulerianParticles(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ extractEulerianParticles() [2/2]

extractEulerianParticles ( const extractEulerianParticles & )

delete

No copy construct.

References extractEulerianParticles().

Here is the call graph for this function:

◆ ~extractEulerianParticles()

virtual ~extractEulerianParticles ( )

virtualdefault

Destructor.

References dict.

Member Function Documentation

◆ checkFaceZone()

void checkFaceZone ( )

protectedvirtual

Check that the faceZone is valid.

Definition at line 51 of file extractEulerianParticles.C.

References DebugInFunction, Foam::endl(), Foam::exit(), faceZoneName_, Foam::FatalError, FatalErrorInFunction, Foam::Info, fvMeshFunctionObject::mesh_, functionObject::name(), nInjectorLocations_, Foam::nl, regions0_, Foam::returnReduce(), UList< T >::size(), functionObject::type(), and zoneID_.

Referenced by read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initialiseBins()

void initialiseBins ( )

protectedvirtual

Initialise the particle collection bins.

Definition at line 89 of file extractEulerianParticles.C.

References pairPatchAgglomeration::agglomerate(), DebugInFunction, Foam::endl(), fineToCoarseAddr_, globalCoarseFaces_, Foam::Info, Foam::labelMax, Foam::max(), fvMeshFunctionObject::mesh_, nInjectorLocations_, UPstream::parRun(), Foam::Pout, pairPatchAgglomeration::restrictTopBottomAddressing(), Foam::returnReduce(), UList< T >::size(), and zoneID_.

Referenced by read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ phiU()

Foam::tmp< Foam::surfaceScalarField > phiU ( ) const

protectedvirtual

Return the volumetric flux.

Definition at line 153 of file extractEulerianParticles.C.

References DebugInFunction, Foam::dimMass, Foam::dimTime, Foam::endl(), Foam::fvc::interpolate(), fvMeshFunctionObject::mesh_, phi, phiName_, rho, and rhoName_.

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setBlockedFaces()

void setBlockedFaces	(	const surfaceScalarField &	alphaf,
		const faceZone &	fz,
		boolList &	blockedFaces )

protectedvirtual

Set the blocked faces, i.e. where alpha > alpha threshold value.

Definition at line 170 of file extractEulerianParticles.C.

References alphaThreshold_, GeometricField< Type, PatchField, GeoMesh >::boundaryField(), DebugInFunction, Foam::endl(), forAll, Foam::isA(), fvMeshFunctionObject::mesh_, patchFaceIDs_, patchIDs_, pp(), and UList< T >::size().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calculateAddressing()

void calculateAddressing	(	const label	nRegionsNew,
		const scalar	time,
		labelList &	regionFaceIDs )

protectedvirtual

Calculate the addressing between regions between iterations Returns the number of active regions (particles).

Definition at line 294 of file extractEulerianParticles.C.

References collectParticle(), DebugInfo, DebugInFunction, Foam::endl(), forAll, Foam::identity(), HashSet< Key, Hash >::insert(), HashTable< T, Key, Hash >::insert(), Pstream::listReduce(), Foam::max(), particles_, regions0_, regionToParticleMap_, HashTable< T, Key, Hash >::size(), and timeFunctionObject::time().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ collectParticle()

void collectParticle	(	const scalar	time,
		const label	regioni )

protectedvirtual

Collect particles that have passed through the faceZone.

Definition at line 232 of file extractEulerianParticles.C.

References Foam::cbrt(), cloud_, collectedVolume_, DebugInFunction, discardedVolume_, Foam::endl(), fineToCoarseAddr_, globalCoarseFaces_, UPstream::master(), maxDiameter_, fvMeshFunctionObject::mesh_, minDiameter_, nCollectedParticles_, nDiscardedParticles_, nInjectorLocations_, p, particles_, Foam::constant::mathematical::pi(), Foam::reduce(), regionToParticleMap_, timeFunctionObject::time(), and U.

Referenced by calculateAddressing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ accumulateParticleInfo()

void accumulateParticleInfo	(	const surfaceScalarField &	alphaf,
		const surfaceScalarField &	phi,
		const labelList &	regionFaceIDs,
		const faceZone &	fz )

protectedvirtual

Process latest region information.

Definition at line 391 of file extractEulerianParticles.C.

References DebugInFunction, Foam::endl(), faceValue(), forAll, Foam::fvc::interpolate(), Foam::mag(), fvMeshFunctionObject::mesh_, p, particles_, phi, regionToParticleMap_, U, Uf, UName_, and VectorSpace< Form, Cmpt, Ncmpts >::zero.

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ faceValue()

template<class Type>

Type faceValue	(	const GeometricField< Type, fvsPatchField, surfaceMesh > &	field,
		const label	localFaceI,
		const label	globalFaceI ) const

inlineprotected

Definition at line 24 of file extractEulerianParticlesTemplates.C.

References field(), fvMeshFunctionObject::mesh_, patchFaceIDs_, and patchIDs_.

Referenced by accumulateParticleInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "extractEulerianParticles" )

Runtime type information.

References dict, Foam::name(), and runTime.

Here is the call graph for this function:

◆ operator=()

void operator= ( const extractEulerianParticles & )

delete

No copy assignment.

References extractEulerianParticles().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Read the function-object dictionary.

Reimplemented from regionFunctionObject.

Definition at line 484 of file extractEulerianParticles.C.

References alphaName_, alphaThreshold_, checkFaceZone(), DebugInFunction, dict, Foam::endl(), faceZoneName_, initialiseBins(), maxDiameter_, minDiameter_, nInjectorLocations_, phiName_, functionObject::read(), writeFile::read(), rhoName_, and UName_.

Referenced by extractEulerianParticles().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ execute()

bool execute ( )

virtual

Execute the function-object operations.

Implements functionObject.

Definition at line 518 of file extractEulerianParticles.C.

References accumulateParticleInfo(), alpha, alphaName_, calculateAddressing(), collectedVolume_, DebugInFunction, discardedVolume_, Foam::endl(), Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, Foam::fvc::interpolate(), Log, fvMeshFunctionObject::mesh_, name, nCollectedParticles_, nDiscardedParticles_, GeometricField< scalar, fvsPatchField, surfaceMesh >::New(), Foam::nl, IOobjectOption::NO_REGISTER, regionSplit2D::nRegions(), particles_, phiU(), IOobject::scopedName(), setBlockedFaces(), UList< T >::size(), Foam::type(), and zoneID_.

Here is the call graph for this function:

◆ write()

bool write ( )

virtual

Write the function-object results.

Implements functionObject.

Definition at line 577 of file extractEulerianParticles.C.

References cloud_, collectedVolume_, DebugInFunction, discardedVolume_, Foam::endl(), nCollectedParticles_, nDiscardedParticles_, and stateFunctionObject::setProperty().

Here is the call graph for this function:

Member Data Documentation

◆ cloud_

injectedParticleCloud cloud_

protected

Storage for collected particles.

Definition at line 228 of file extractEulerianParticles.H.

Referenced by collectParticle(), extractEulerianParticles(), and write().

◆ faceZoneName_

word faceZoneName_

protected

Name of faceZone to sample.

Definition at line 236 of file extractEulerianParticles.H.

Referenced by checkFaceZone(), extractEulerianParticles(), and read().

◆ zoneID_

label zoneID_

protected

Index of the faceZone.

Definition at line 241 of file extractEulerianParticles.H.

Referenced by checkFaceZone(), execute(), extractEulerianParticles(), and initialiseBins().

◆ patchIDs_

labelList patchIDs_

protected

Patch indices where faceZone face intersect patch.

Definition at line 246 of file extractEulerianParticles.H.

Referenced by extractEulerianParticles(), faceValue(), and setBlockedFaces().

◆ patchFaceIDs_

labelList patchFaceIDs_

protected

Patch face indices where faceZone face intersect patch.

Definition at line 251 of file extractEulerianParticles.H.

Referenced by extractEulerianParticles(), faceValue(), and setBlockedFaces().

◆ alphaName_

word alphaName_

protected

Name of phase fraction field.

Definition at line 259 of file extractEulerianParticles.H.

Referenced by execute(), extractEulerianParticles(), and read().

◆ alphaThreshold_

scalar alphaThreshold_

protected

Value of phase fraction used to identify particle boundaries.

Definition at line 264 of file extractEulerianParticles.H.

Referenced by extractEulerianParticles(), read(), and setBlockedFaces().

◆ UName_

word UName_

protected

Name of the velocity field, default = U.

Definition at line 269 of file extractEulerianParticles.H.

Referenced by accumulateParticleInfo(), extractEulerianParticles(), and read().

◆ rhoName_

word rhoName_

protected

Name of the density field, default = rho.

Definition at line 274 of file extractEulerianParticles.H.

Referenced by extractEulerianParticles(), phiU(), and read().

◆ phiName_

word phiName_

protected

Name of the flux field, default ="rho".

Definition at line 279 of file extractEulerianParticles.H.

Referenced by extractEulerianParticles(), phiU(), and read().

◆ nInjectorLocations_

label nInjectorLocations_

protected

Number of sample locations to generate.

Definition at line 287 of file extractEulerianParticles.H.

Referenced by checkFaceZone(), collectParticle(), extractEulerianParticles(), initialiseBins(), and read().

◆ fineToCoarseAddr_

labelList fineToCoarseAddr_

protected

Agglomeration addressing from fine to coarse (local proc only).

Definition at line 292 of file extractEulerianParticles.H.

Referenced by collectParticle(), extractEulerianParticles(), and initialiseBins().

◆ globalCoarseFaces_

globalIndex globalCoarseFaces_

protected

Global coarse face addressing.

Definition at line 297 of file extractEulerianParticles.H.

Referenced by collectParticle(), extractEulerianParticles(), and initialiseBins().

◆ regions0_

labelList regions0_

protected

Region indices in faceZone faces from last iteration.

Definition at line 305 of file extractEulerianParticles.H.

Referenced by calculateAddressing(), checkFaceZone(), and extractEulerianParticles().

◆ particles_

List<eulerianParticle> particles_

protected

Particle properties (partial, being accumulated).

Definition at line 310 of file extractEulerianParticles.H.

Referenced by accumulateParticleInfo(), calculateAddressing(), collectParticle(), execute(), and extractEulerianParticles().

◆ regionToParticleMap_

Map<label> regionToParticleMap_

protected

Map from region to index in particles_ list.

Definition at line 315 of file extractEulerianParticles.H.

Referenced by accumulateParticleInfo(), calculateAddressing(), collectParticle(), and extractEulerianParticles().

◆ minDiameter_

scalar minDiameter_

protected

Minimum diameter (optional).

Can be used to filter out 'small' particles

Definition at line 322 of file extractEulerianParticles.H.

Referenced by collectParticle(), extractEulerianParticles(), and read().

◆ maxDiameter_

scalar maxDiameter_

protected

Maximum diameter (optional).

Can be used to filter out 'large' particles

Definition at line 329 of file extractEulerianParticles.H.

Referenced by collectParticle(), extractEulerianParticles(), and read().

◆ nCollectedParticles_

label nCollectedParticles_

protected

Total number of collected particles.

Definition at line 337 of file extractEulerianParticles.H.

Referenced by collectParticle(), execute(), extractEulerianParticles(), and write().

◆ collectedVolume_

scalar collectedVolume_

protected

Total collected volume [m3].

Definition at line 342 of file extractEulerianParticles.H.

Referenced by collectParticle(), execute(), extractEulerianParticles(), and write().

◆ nDiscardedParticles_

label nDiscardedParticles_

protected

Total number of discarded particles.

Definition at line 347 of file extractEulerianParticles.H.

Referenced by collectParticle(), execute(), extractEulerianParticles(), and write().

◆ discardedVolume_

scalar discardedVolume_

protected

Total discarded volume [m3].

Definition at line 352 of file extractEulerianParticles.H.

Referenced by collectParticle(), execute(), extractEulerianParticles(), and write().

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

src/functionObjects/field/extractEulerianParticles/extractEulerianParticles/extractEulerianParticles.H
src/functionObjects/field/extractEulerianParticles/extractEulerianParticles/extractEulerianParticles.C
src/functionObjects/field/extractEulerianParticles/extractEulerianParticles/extractEulerianParticlesTemplates.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ extractEulerianParticles() [1/2]

◆ extractEulerianParticles() [2/2]

◆ ~extractEulerianParticles()

Member Function Documentation

◆ checkFaceZone()

◆ initialiseBins()

◆ phiU()

◆ setBlockedFaces()

◆ calculateAddressing()

◆ collectParticle()

◆ accumulateParticleInfo()

◆ faceValue()

◆ TypeName()

◆ operator=()

◆ read()

◆ execute()

◆ write()

Member Data Documentation

◆ cloud_

◆ faceZoneName_

◆ zoneID_

◆ patchIDs_

◆ patchFaceIDs_

◆ alphaName_

◆ alphaThreshold_

◆ UName_

◆ rhoName_

◆ phiName_

◆ nInjectorLocations_

◆ fineToCoarseAddr_

◆ globalCoarseFaces_

◆ regions0_

◆ particles_

◆ regionToParticleMap_

◆ minDiameter_

◆ maxDiameter_

◆ nCollectedParticles_

◆ collectedVolume_

◆ nDiscardedParticles_

◆ discardedVolume_