particleDistribution Class Reference

Generates a particle distribution for lagrangian data at a given time. More...

Inheritance diagram for particleDistribution:

Collaboration diagram for particleDistribution:

Public Member Functions
	TypeName ("particleDistribution")
	particleDistribution (const word &name, const Time &runTime, const dictionary &dict)
	particleDistribution (const particleDistribution &)=delete
void	operator= (const particleDistribution &)=delete
virtual	~particleDistribution ()=default
virtual bool	read (const dictionary &)
virtual bool	execute ()
virtual bool	write ()
Public Member Functions inherited from fvMeshFunctionObject
	TypeName ("fvMeshFunctionObject")
	fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
virtual	~fvMeshFunctionObject ()=default
Public Member Functions inherited from regionFunctionObject
	TypeName ("regionFunctionObject")
	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
virtual	~regionFunctionObject ()=default
template<class ObjectType >
const ObjectType *	lookupObjectPtr (const word &fieldName) const
template<class ObjectType >
ObjectType *	lookupObjectRefPtr (const word &fieldName) const
Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)
virtual	~stateFunctionObject ()=default
dictionary &	propertyDict ()
bool	foundProperty (const word &entryName) const
void	clearTrigger ()
label	getTrigger () const
bool	setTrigger (const label triggeri, bool increaseOnly=true)
bool	getDict (const word &entryName, dictionary &dict) const
bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
template<class Type >
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
template<class Type >
bool	getProperty (const word &entryName, Type &value) const
template<class Type >
void	setProperty (const word &entryName, const Type &value)
template<class Type >
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
template<class Type >
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const
template<class Type >
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)
template<class Type >
void	setResult (const word &entryName, const Type &value)
template<class Type >
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)
template<class Type >
Type	getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const
template<class Type >
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
template<class Type >
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const
word	resultType (const word &entryName) const
word	objectResultType (const word &objectName, const word &entryName) const
wordList	objectResultEntries () const
wordList	objectResultEntries (const word &objectName) const
void	writeResultEntries (Ostream &os) const
void	writeResultEntries (const word &objectName, Ostream &os) const
void	writeAllResultEntries (Ostream &os) const
Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)
virtual	~timeFunctionObject ()=default
const Time &	time () const
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)
autoPtr< functionObject >	clone () const
virtual	~functionObject ()=default
virtual const word &	type () const =0
const word &	name () const noexcept
bool	useNamePrefix () const noexcept
bool	useNamePrefix (bool on) noexcept
virtual bool	execute (const label subIndex)
virtual bool	end ()
virtual bool	adjustTimeStep ()
virtual bool	filesModified () const
virtual void	updateMesh (const mapPolyMesh &mpm)
virtual void	movePoints (const polyMesh &mesh)
Public Member Functions inherited from writeFile
	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name="undefined", const bool writeToFile=true)
	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name, const dictionary &dict, const bool writeToFile=true)
	writeFile (const writeFile &wf)
virtual	~writeFile ()=default
virtual OFstream &	file ()
virtual bool	writeToFile () const
virtual bool	canWriteHeader () const
virtual label	charWidth () const
virtual void	writeCommented (Ostream &os, const string &str) const
virtual void	writeTabbed (Ostream &os, const string &str) const
virtual void	writeHeader (Ostream &os, const string &str) const
virtual void	writeCurrentTime (Ostream &os) const
virtual void	writeBreak (Ostream &os) const
template<class Type >
void	writeHeaderValue (Ostream &os, const string &property, const Type &value) const

Protected Member Functions
void	generateDistribution (const word &fieldName, const scalarField &field, const scalar binWidth, const label tag=-1)
template<class Type >
bool	processField (const objectRegistry &obr, const label fieldi, const List< DynamicList< label >> &addr)
Protected Member Functions inherited from fvMeshFunctionObject
	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
void	operator= (const fvMeshFunctionObject &)=delete
Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry &	obr () const
template<class ObjectType >
bool	foundObject (const word &fieldName) const
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
template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName) const
template<class ObjectType >
bool	store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
template<class ObjectType >
bool	storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr)
bool	writeObject (const word &fieldName)
bool	clearObject (const word &fieldName)
void	clearObjects (const wordList &objNames)
	regionFunctionObject (const regionFunctionObject &)=delete
void	operator= (const regionFunctionObject &)=delete
Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties &	stateDict () const
functionObjects::properties &	stateDict ()
	stateFunctionObject (const stateFunctionObject &)=delete
void	operator= (const stateFunctionObject &)=delete
Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)
	timeFunctionObject (const timeFunctionObject &)=delete
void	operator= (const timeFunctionObject &)=delete
Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
Protected Member Functions inherited from writeFile
void	initStream (Ostream &os) const
fileName	baseFileDir () const
fileName	baseTimeDir () const
virtual autoPtr< OFstream >	createFile (const word &name, scalar timeValue) const
virtual autoPtr< OFstream >	createFile (const word &name) const
virtual void	resetFile (const word &name)
Omanip< int >	valueWidth (const label offset=0) const
void	operator= (const writeFile &)=delete

Protected Attributes
word	cloudName_
word	tagFieldName_
Random	rndGen_
List< Tuple2< word, scalar > >	nameVsBinWidth_
autoPtr< writer< scalar > >	writerPtr_
Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
Protected Attributes inherited from regionFunctionObject
word	subRegistryName_
const objectRegistry &	obr_
const objectRegistry *	obrPtr_
Protected Attributes inherited from timeFunctionObject
const Time &	time_
Protected Attributes inherited from writeFile
const objectRegistry &	fileObr_
const fileName	prefix_
word	fileName_
autoPtr< OFstream >	filePtr_
label	writePrecision_
bool	writeToFile_
bool	updateHeader_
bool	writtenHeader_
bool	useUserTime_
scalar	startTime_

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &runTime, const dictionary &dict)
Public Attributes inherited from functionObject
bool	log
Static Public Attributes inherited from functionObject
static int	debug
static bool	postProcess
static bool	defaultUseNamePrefix
static word	outputPrefix
Static Public Attributes inherited from writeFile
static label	addChars = 8

Detailed Description

Generates a particle distribution for lagrangian data at a given time.

Operands:

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

Usage

Minimal example by using system/controlDict.functions:

particleDistribution1
{
    // Mandatory entries (unmodifiable)
    type        particleDistribution;
    libs        (fieldFunctionObjects);

    // Mandatory entries (runtime modifiable)
    cloud       <cloudName>;
    nameVsBinWidth
    (
        (d 0.1)
        (U 10)
    );
    setFormat   raw;

    // Optional entries (runtime modifiable)
    tagField    none;

    // Optional (inherited) entries
    ...
}

where the entries mean:

Property	Description	Type	Req'd	Dflt
type	Type name: particleDistribution	word	yes	-
libs	Library name: fieldFunctionObjects	word	yes	-
cloud	Name of cloud to process	word	yes	-
nameVsBinWidth	List of cloud field-bin width	wordHashTable	yes	-
setFormat	Output format	word	yes	-
tagField	Name of cloud field to use group particles	word	no	none

The inherited entries are elaborated in:

• functionObject.H
• writeFile.H

Usage by the postProcess utility is not available.

See also

• Foam::functionObject
• Foam::functionObjects::fvMeshFunctionObject
• Foam::functionObjects::writeFile
• ExtendedCodeGuide::functionObjects::field::particleDistribution

Source files

• particleDistribution.H
• particleDistribution.C
• particleDistributionTemplates.C

Definition at line 172 of file particleDistribution.H.

Constructor & Destructor Documentation

particleDistribution() [1/2]

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

Definition at line 47 of file particleDistribution.C.

References dict, and Foam::blockMeshTools::read().

Here is the call graph for this function:

particleDistribution() [2/2]

particleDistribution ( const particleDistribution &  )

delete

~particleDistribution()

virtual ~particleDistribution ( )

virtualdefault

Member Function Documentation

generateDistribution()

void generateDistribution ( const word &  fieldName, const scalarField &  field, const scalar  binWidth, const label  tag = -1  )

protected

Definition at line 173 of file particleDistribution.C.

References Foam::endl(), field(), fieldNames(), Log, Foam::mkDir(), OFstream::name(), Foam::name(), Field::replace(), and Foam::Zero.

Here is the call graph for this function:

processField()

bool processField ( const objectRegistry &  obr, const label  fieldi, const List< DynamicList< label >> &  addr  )

protected

Definition at line 25 of file particleDistributionTemplates.C.

References Field::component(), field(), forAll, objectRegistry::foundObject(), and objectRegistry::lookupObject().

Here is the call graph for this function:

TypeName()

TypeName

(

"particleDistribution"

)

operator=()

void operator= ( const particleDistribution &  )

delete

read()

bool read ( const dictionary &  dict )

virtual

Reimplemented from writeFile.

Definition at line 67 of file particleDistribution.C.

References particleDistribution::cloudName_, dict, Foam::endl(), format(), Foam::Info, functionObject::name(), particleDistribution::nameVsBinWidth_, writer< Type >::New(), Foam::nl, regionFunctionObject::read(), writeFile::read(), particleDistribution::tagFieldName_, functionObject::type(), and particleDistribution::writerPtr_.

Here is the call graph for this function:

execute()

bool execute ( )

virtual

Implements functionObject.

Definition at line 88 of file particleDistribution.C.

write()

bool write ( )

virtual

Implements functionObject.

Definition at line 94 of file particleDistribution.C.

References List::append(), Foam::constant::universal::c, Foam::endl(), forAll, Log, Foam::name(), IOobject::NO_READ, IOobject::NO_WRITE, cloud::prefix, Foam::type(), and WarningInFunction.

Here is the call graph for this function:

Member Data Documentation

cloudName_

word cloudName_

protected

Definition at line 182 of file particleDistribution.H.

Referenced by particleDistribution::read().

tagFieldName_

word tagFieldName_

protected

Definition at line 185 of file particleDistribution.H.

Referenced by particleDistribution::read().

rndGen_

Random rndGen_

protected

Definition at line 188 of file particleDistribution.H.

nameVsBinWidth_

List<Tuple2<word, scalar> > nameVsBinWidth_

protected

Definition at line 191 of file particleDistribution.H.

Referenced by particleDistribution::read().

writerPtr_

autoPtr<writer<scalar> > writerPtr_

protected

Definition at line 194 of file particleDistribution.H.

Referenced by particleDistribution::read().

---

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

• src/functionObjects/field/particleDistribution/particleDistribution.H
• src/functionObjects/field/particleDistribution/particleDistribution.C
• src/functionObjects/field/particleDistribution/particleDistributionTemplates.C