Public Member Functions | Protected Member Functions | List of all members
ParticleErosion< CloudType > Class Template Reference

Creates particle erosion field, Q. More...

Inheritance diagram for ParticleErosion< CloudType >:
Inheritance graph
[legend]
Collaboration diagram for ParticleErosion< CloudType >:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("particleErosion")
 
 ParticleErosion (const dictionary &dict, CloudType &owner, const word &modelName)
 
 ParticleErosion (const ParticleErosion< CloudType > &pe)
 
virtual autoPtr< CloudFunctionObject< CloudType > > clone () const
 
virtual ~ParticleErosion ()=default
 
virtual void preEvolve (const typename parcelType::trackingData &td)
 
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 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 fileNameoutputDir () 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 CloudTypeowner () const
 
virtual bool writeTime () const
 
virtual fileName localPath () const
 
CloudTypeowner ()
 
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 wordmodelName () const
 
const dictionarydict () const
 
const wordbaseName () const
 
const wordmodelType () const
 
const dictionarycoeffDict () const
 
const dictionaryproperties () 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 resetQ ()
 
label applyToPatch (const label globalPatchi) const
 
virtual 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 >
CloudTypeowner_
 
- Protected Attributes inherited from subModelBase
const word modelName_
 
dictionaryproperties_
 
const dictionary dict_
 
const word baseName_
 
const word modelType_
 
const dictionary coeffDict_
 

Detailed Description

template<class CloudType>
class Foam::ParticleErosion< CloudType >

Creates particle erosion field, Q.

Source files

Definition at line 52 of file ParticleErosion.H.

Constructor & Destructor Documentation

◆ ParticleErosion() [1/2]

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

◆ ParticleErosion() [2/2]

Definition at line 129 of file ParticleErosion.C.

◆ ~ParticleErosion()

virtual ~ParticleErosion ( )
virtualdefault

Member Function Documentation

◆ resetQ()

void resetQ
protected

Definition at line 27 of file ParticleErosion.C.

References Foam::dimVolume, mesh, Foam::name(), and Foam::Zero.

Here is the call graph for this function:

◆ applyToPatch()

Foam::label applyToPatch ( const label  globalPatchi) const
protected

Definition at line 59 of file ParticleErosion.C.

◆ write()

void write
protectedvirtual

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 68 of file ParticleErosion.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "particleErosion"  )

◆ clone()

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

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 114 of file ParticleErosion.H.

◆ preEvolve()

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

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 146 of file ParticleErosion.C.

◆ postPatch()

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

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