Computes a histogram for the distribution of particle diameters and corresponding number of particles hitting on a given list of patches or face zones. More...

#include <ParticleHistogram.H>

Inheritance diagram for ParticleHistogram< CloudType >:

[legend]

Collaboration diagram for ParticleHistogram< CloudType >:

[legend]

Public Member Functions
	TypeName ("particleHistogram")
	Runtime type information.
	ParticleHistogram (const dictionary &dict, CloudType &owner, const word &modelName)
	Construct from dictionary.
	ParticleHistogram (const ParticleHistogram< CloudType > &ph)
	Copy construct.
void	operator= (const ParticleHistogram< CloudType > &)=delete
	No copy assignment.
virtual autoPtr< CloudFunctionObject< CloudType > >	clone () const
	Construct and return a clone.
virtual	~ParticleHistogram ()=default
	Destructor.
virtual bool	postPatch (const parcelType &p, const polyPatch &pp, const typename parcelType::trackingData &td)
	Post-patch hook.
virtual bool	postFace (const parcelType &p, const typename parcelType::trackingData &td)
	Post-face hook.
virtual void	write ()
	Write post-processing info.
Public Member Functions inherited from CloudFunctionObject< CloudType >
	TypeName ("cloudFunctionObject")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, CloudFunctionObject, dictionary,(const dictionary &dict, CloudType &owner, const word &modelName),(dict, owner, modelName))
	Declare runtime constructor selection table.
	CloudFunctionObject (CloudType &owner)
	Construct null from owner.
	CloudFunctionObject (const dictionary &dict, CloudType &owner, const word &objectType, const word &modelName)
	Construct from dictionary.
	CloudFunctionObject (const CloudFunctionObject< CloudType > &ppm)
	Construct copy.
virtual	~CloudFunctionObject ()=default
	Destructor.
virtual void	preEvolve (const typename parcelType::trackingData &td)
	Pre-evolve hook.
virtual void	postEvolve (const typename parcelType::trackingData &td)
	Post-evolve hook.
virtual bool	postMove (parcelType &p, const scalar dt, const point &position0, const typename parcelType::trackingData &td)
	Post-move hook.
virtual bool	postPatch (const parcelType &p, const polyPatch &pp, const typename parcelType::trackingData &td)
	Post-patch hook.
virtual bool	postFace (const parcelType &p, const typename parcelType::trackingData &td)
	Post-face hook.
const fileName &	outputDir () const
	Return the output path.
fileName	writeTimeDir () const
	Return the output time path.
Public Member Functions inherited from CloudSubModelBase< CloudType >
	CloudSubModelBase (CloudType &owner)
	Construct null from owner cloud.
	CloudSubModelBase (CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from owner cloud without name.
	CloudSubModelBase (const word &modelName, CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from owner cloud with name.
	CloudSubModelBase (const CloudSubModelBase< CloudType > &smb)
	Construct as copy.
virtual	~CloudSubModelBase ()=default
	Destructor.
const CloudType &	owner () const
	Return const access to the owner cloud.
virtual bool	writeTime () const
	Flag to indicate when to write a property.
virtual fileName	localPath () const
	Output directory.
CloudType &	owner ()
	Return non-const access to the owner cloud for manipulation.
virtual void	info ()
	Write to info.
virtual void	write (Ostream &os) const
	Write to os.
Public Member Functions inherited from subModelBase
	subModelBase (dictionary &properties)
	Construct null.
	subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from components without name.
	subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from components with name.
	subModelBase (const subModelBase &smb)
	Construct as copy.
virtual	~subModelBase ()=default
	Destructor.
const word &	modelName () const
	Return const access to the name of the sub-model.
const dictionary &	dict () const
	Return const access to the cloud dictionary.
const word &	baseName () const
	Return const access to the base name of the sub-model.
const word &	modelType () const
	Return const access to the sub-model type.
const dictionary &	coeffDict () const
	Return const access to the coefficients dictionary.
const dictionary &	properties () const
	Return const access to the properties dictionary.
virtual bool	defaultCoeffs (const bool printMsg) const
	Returns true if defaultCoeffs is true and outputs on printMsg.
virtual bool	active () const
	Return the model 'active' status - default active = true.
virtual void	cacheFields (const bool store)
	Cache dependent sub-model fields.
template<class Type>
Type	getBaseProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from the base model.
template<class Type>
void	getBaseProperty (const word &entryName, Type &value) const
	Retrieve generic property from the base model.
template<class Type>
void	setBaseProperty (const word &entryName, const Type &value)
	Add generic property to the base model.
bool	getModelDict (const word &entryName, dictionary &dict) const
	Retrieve dictionary, return true if set.
template<class Type>
bool	getModelProperty (const word &entryName, Type &value) const
	Retrieve generic property from the sub-model.
template<class Type>
Type	getModelProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from the sub-model.
template<class Type>
void	setModelProperty (const word &entryName, const Type &value)
	Add generic property to the sub-model.
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 bool	read (const dictionary &dict)
	Read.
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.

Additional Inherited Members
Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType	cloudType
	Type of cloud this model was instantiated for.
Static Public Member Functions inherited from CloudFunctionObject< CloudType >
static autoPtr< CloudFunctionObject< CloudType > >	New (const dictionary &dict, CloudType &owner, const word &objectType, const word &modelName)
	Selector.
Public Attributes inherited from subModelBase
bool	log
	Flag to write log into Info.
Static Public Attributes inherited from writeFile
static label	addChars = 8
	Additional characters for writing.
Protected Member Functions inherited from subModelBase
bool	inLine () const
	Flag to indicate whether data is/was read in-line.
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 inherited from CloudSubModelBase< CloudType >
CloudType &	owner_
	Reference to the cloud.
Protected Attributes inherited from subModelBase
const word	modelName_
	Name of the sub-model.
dictionary &	properties_
	Reference to properties dictionary e.g. for restart.
const dictionary	dict_
	Copy of dictionary used during construction.
const word	baseName_
	Name of the sub-model base class.
const word	modelType_
	Type of the sub-model.
const dictionary	coeffDict_
	Coefficients dictionary.
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.

Detailed Description

template<class CloudType>
class Foam::ParticleHistogram< CloudType >

Computes a histogram for the distribution of particle diameters and corresponding number of particles hitting on a given list of patches or face zones.

Operands:

Operand	Type	Location
`input`	-	-
`output` file	dat	<case>/postProcessing/<FO>/<time>/<file>
`output` field	-	-

The output file contains four columns, from the first to the last:

	=	Left bin-edge of particle diameter
	=	Right bin-edge of particle diameter
	=	Number of particles falling into the corresponding bin
	=	Cumulative number of binned particles

Usage

Minimal example by using constant/reactingCloud1Properties.cloudFunctions:

particleHistogram1
{
    // Mandatory entries
    type                 particleHistogram;
    nBins                <label>;
    min                  <scalar>;
    max                  <scalar>;
    maxStoredParcels     <scalar>;

    // Conditional entries

        // Option-1
        patches          (<wordRes>);

        // Option-2
        faceZones        (<wordRes>);

    // Inherited entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`type`	Type name: particleHistogram	word	yes	-
`nBins`	Number of histogram bins	label	yes	-
`max`	Maximum value of histogram data	scalar	yes	-
`min`	Minimum value of histogram data	scalar	yes	-
`maxStoredParcels`	Maximum number of parcels to process	label	yes	-
`patches`	Names of operand patches	wordRes	choice	-
`faceZones`	Names of operand face zones	wordRes	choice	-

The inherited entries are elaborated in:

Note

The underlying type of maxStoredParcels is set as a scalar for I/O.

Source files

Definition at line 193 of file ParticleHistogram.H.

Constructor & Destructor Documentation

◆ ParticleHistogram() [1/2]

template<class CloudType>

ParticleHistogram	(	const dictionary &	dict,
		CloudType &	owner,
		const word &	modelName )

Construct from dictionary.

Definition at line 46 of file ParticleHistogram.C.

References CloudFunctionObject< CloudType >::CloudFunctionObject(), subModelBase::coeffDict(), delta, subModelBase::dict(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, CloudSubModelBase< CloudType >::localPath(), mesh, subModelBase::modelName(), CloudSubModelBase< CloudType >::owner(), writeFile::writeFile(), and Foam::Zero.

Referenced by clone(), operator=(), ParticleHistogram(), and TypeName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ParticleHistogram() [2/2]

template<class CloudType>

ParticleHistogram ( const ParticleHistogram< CloudType > & ph )

Copy construct.

Definition at line 110 of file ParticleHistogram.C.

References CloudFunctionObject< CloudType >::CloudFunctionObject(), ParticleHistogram(), and writeFile::writeFile().

Here is the call graph for this function:

◆ ~ParticleHistogram()

template<class CloudType>

virtual ~ParticleHistogram ( )

virtualdefault

Destructor.

References p, pp(), and td().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

template<class CloudType>

TypeName ( "particleHistogram" )

Runtime type information.

References subModelBase::dict(), subModelBase::modelName(), CloudSubModelBase< CloudType >::owner(), and ParticleHistogram().

Here is the call graph for this function:

◆ operator=()

template<class CloudType>

void operator= ( const ParticleHistogram< CloudType > & )

delete

No copy assignment.

References ParticleHistogram().

Here is the call graph for this function:

◆ clone()

template<class CloudType>

virtual autoPtr< CloudFunctionObject< CloudType > > clone ( ) const

inlinevirtual

Construct and return a clone.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 286 of file ParticleHistogram.H.

References ParticleHistogram().

Here is the call graph for this function:

◆ postPatch()

template<class CloudType>

bool postPatch	(	const parcelType &	p,
		const polyPatch &	pp,
		const typename parcelType::trackingData &	td )

virtual

Post-patch hook.

Definition at line 131 of file ParticleHistogram.C.

References p, pp(), and td().

Here is the call graph for this function:

◆ postFace()

template<class CloudType>

bool postFace	(	const parcelType &	p,
		const typename parcelType::trackingData &	td )

virtual

Post-face hook.

Definition at line 161 of file ParticleHistogram.C.

References forAll, CloudSubModelBase< CloudType >::owner(), p, and td().

Here is the call graph for this function:

◆ write()

template<class CloudType>

void write ( )

virtual

Write post-processing info.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 203 of file ParticleHistogram.C.

References Foam::ListListOps::combine(), delta, forAll, UPstream::gatherList, UPstream::master(), UPstream::myProcNo(), names, writeFile::newFileAtTime(), Foam::nl, UPstream::nProcs(), os(), CloudSubModelBase< CloudType >::owner(), autoPtr< T >::ref(), Foam::tab, writeFile::writeToFile(), and Foam::Zero.

Here is the call graph for this function:

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

src/lagrangian/intermediate/submodels/CloudFunctionObjects/ParticleHistogram/ParticleHistogram.H
src/lagrangian/intermediate/submodels/CloudFunctionObjects/ParticleHistogram/ParticleHistogram.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ParticleHistogram() [1/2]

◆ ParticleHistogram() [2/2]

◆ ~ParticleHistogram()

Member Function Documentation

◆ TypeName()

◆ operator=()

◆ clone()

◆ postPatch()

◆ postFace()

◆ write()