PatchParticleHistogram< CloudType > Class Template Reference

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

Protected Member Functions

void write ()
 Write post-processing info. More...
 
- Protected Member Functions inherited from subModelBase
bool inLine () const
 Flag to indicate whether data is/was read in-line. More...
 

Additional Inherited Members

- Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType cloudType
 Type of cloud this model was instantiated for. More...
 
- 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. More...
 
- Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudTypeowner_
 Reference to the cloud. More...
 
- Protected Attributes inherited from subModelBase
const word modelName_
 Name of the sub-model. More...
 
dictionaryproperties_
 Reference to properties dictionary e.g. for restart. More...
 
const dictionary dict_
 Copy of dictionary used during construction. More...
 
const word baseName_
 Name of the sub-model base class. More...
 
const word modelType_
 Type of the sub-model. More...
 
const dictionary coeffDict_
 Coefficients dictionary. More...
 

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 153 of file PatchParticleHistogram.H.

Constructor & Destructor Documentation

◆ PatchParticleHistogram() [1/3]

No default construct.

◆ PatchParticleHistogram() [2/3]

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

Construct from dictionary.

Definition at line 146 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< T >::setSize(), and Foam::Zero.

Here is the call graph for this function:

◆ PatchParticleHistogram() [3/3]

Copy construct.

Definition at line 213 of file PatchParticleHistogram.C.

◆ ~PatchParticleHistogram()

virtual ~PatchParticleHistogram ( )
virtualdefault

Destructor.

Member Function Documentation

◆ write()

void write ( )
protectedvirtual

Write post-processing info.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 49 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"  )

Runtime type information.

◆ operator=()

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

No copy assignment.

◆ clone()

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

Construct and return a clone.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 237 of file PatchParticleHistogram.H.

◆ postPatch()

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

Post-patch hook.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 236 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: