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

Inheritance diagram for PatchParticleHistogram< CloudType >:

[legend]

Collaboration diagram for PatchParticleHistogram< CloudType >:

[legend]

Public Member Functions
	TypeName ("patchParticleHistogram")

	PatchParticleHistogram ()=delete

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

	PatchParticleHistogram (const PatchParticleHistogram< CloudType > &ppm)

void	operator= (const PatchParticleHistogram< CloudType > &)=delete

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

virtual	~PatchParticleHistogram ()=default

virtual void	postPatch (const parcelType &p, const polyPatch &pp, bool &keepParticle)

Public Member Functions inherited from CloudFunctionObject< CloudType >
	TypeName ("cloudFunctionObject")

	declareRunTimeSelectionTable (autoPtr, CloudFunctionObject, dictionary,(const dictionary &dict, CloudType &owner, const word &modelName),(dict, owner, modelName))

	CloudFunctionObject (CloudType &owner)

	CloudFunctionObject (const dictionary &dict, CloudType &owner, const word &objectType, const word &modelName)

	CloudFunctionObject (const CloudFunctionObject< CloudType > &ppm)

virtual	~CloudFunctionObject ()=default

virtual void	preEvolve (const typename parcelType::trackingData &td)

virtual void	postEvolve (const typename parcelType::trackingData &td)

virtual void	postMove (parcelType &p, const scalar dt, const point &position0, bool &keepParticle)

virtual void	postFace (const parcelType &p, bool &keepParticle)

const fileName &	outputDir () const

fileName	writeTimeDir () const

Public Member Functions inherited from CloudSubModelBase< CloudType >
	CloudSubModelBase (CloudType &owner)

	CloudSubModelBase (CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")

	CloudSubModelBase (const word &modelName, CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType)

	CloudSubModelBase (const CloudSubModelBase< CloudType > &smb)

virtual	~CloudSubModelBase ()

const CloudType &	owner () const

virtual bool	writeTime () const

virtual fileName	localPath () const

CloudType &	owner ()

virtual void	write (Ostream &os) const

Public Member Functions inherited from subModelBase
	subModelBase (dictionary &properties)

	subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")

	subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)

	subModelBase (const subModelBase &smb)

virtual	~subModelBase ()

const word &	modelName () const

const dictionary &	dict () const

const word &	baseName () const

const word &	modelType () const

const dictionary &	coeffDict () const

const dictionary &	properties () const

virtual bool	defaultCoeffs (const bool printMsg) const

virtual bool	active () const

virtual void	cacheFields (const bool store)

template<class Type >
Type	getBaseProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const

template<class Type >
void	getBaseProperty (const word &entryName, Type &value) const

template<class Type >
void	setBaseProperty (const word &entryName, const Type &value)

bool	getModelDict (const word &entryName, dictionary &dict) const

template<class Type >
void	getModelProperty (const word &entryName, Type &value) const

template<class Type >
Type	getModelProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const

template<class Type >
void	setModelProperty (const word &entryName, const Type &value)

Protected Member Functions
void	write ()

Protected Member Functions inherited from subModelBase
bool	inLine () const

Additional Inherited Members
Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType	cloudType

Static Public Member Functions inherited from CloudFunctionObject< CloudType >
static autoPtr< CloudFunctionObject< CloudType > >	New (const dictionary &dict, CloudType &owner, const word &objectType, const word &modelName)

Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudType &	owner_

Protected Attributes inherited from subModelBase
const word	modelName_

dictionary &	properties_

const dictionary	dict_

const word	baseName_

const word	modelType_

const dictionary	coeffDict_

Detailed Description

template<class CloudType>
class Foam::PatchParticleHistogram< CloudType >

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

Operands:

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

The output file contains two columns, the first is the bin edges of the particle diameter (i.e. d), and the second is the number of particles whose diameter falling into the corresponding bin (i.e. nParticles).

Usage

Minimal example by using constant/reactingCloud1Properties.cloudFunctions:

patchParticleHistogram1
{
    // Mandatory entries (unmodifiable)
    type             patchParticleHistogram;
    patches          (<patch1> <patch2> ... <patchN>);
    nBins            10;
    min              0.1;
    max              10.0;
    maxStoredParcels 20;
}

where the entries mean:

Property	Description	Type	Reqd	Dflt
`type`	Type name: patchParticleHistogram	word	yes	-
`patches`	Names of operand patches	wordList	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	-

Note

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

Source files

Definition at line 149 of file PatchParticleHistogram.H.

Constructor & Destructor Documentation

◆ PatchParticleHistogram() [1/3]

PatchParticleHistogram ( )

delete

◆ PatchParticleHistogram() [2/3]

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

Definition at line 139 of file PatchParticleHistogram.C.

References polyMesh::boundaryMesh(), dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::flatOutput(), wordRes::matching(), DSMCCloud< ParcelType >::mesh(), polyBoundaryMesh::names(), Foam::nl, List::setSize(), and Foam::Zero.

Here is the call graph for this function:

◆ PatchParticleHistogram() [3/3]

PatchParticleHistogram ( const PatchParticleHistogram< CloudType > & ppm )

Definition at line 206 of file PatchParticleHistogram.C.

◆ ~PatchParticleHistogram()

virtual ~PatchParticleHistogram ( )

virtualdefault

Member Function Documentation

◆ write()

void write

protectedvirtual

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 42 of file PatchParticleHistogram.C.

References Foam::endl(), forAll, mesh, Foam::mkDir(), Foam::nl, and Foam::Zero.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "patchParticleHistogram" )

◆ operator=()

void operator= ( const PatchParticleHistogram< CloudType > & )

delete

◆ clone()

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

inlinevirtual

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 233 of file PatchParticleHistogram.H.

◆ postPatch()

void postPatch	(	const parcelType &	p,
		const polyPatch &	pp,
		bool &	keepParticle
	)

virtual

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 229 of file PatchParticleHistogram.C.

References patchIdentifier::index(), and p.

Here is the call graph for this function:

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

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

template<class CloudType> class Foam::PatchParticleHistogram< CloudType >

Constructor & Destructor Documentation

◆ PatchParticleHistogram() [1/3]

◆ PatchParticleHistogram() [2/3]

◆ PatchParticleHistogram() [3/3]

◆ ~PatchParticleHistogram()

Member Function Documentation

◆ write()

◆ TypeName()

◆ operator=()

◆ clone()

◆ postPatch()

template<class CloudType>
class Foam::PatchParticleHistogram< CloudType >