Traps particles within a given phase fraction for multi-phase cases. More...

Inheritance diagram for ParticleTrap< CloudType >:

Collaboration diagram for ParticleTrap< CloudType >:

Public Member Functions
	TypeName ("particleTrap")

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

	ParticleTrap (const ParticleTrap< CloudType > &pe)

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

virtual	~ParticleTrap ()=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)

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	postPatch (const parcelType &p, const polyPatch &pp, 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)

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 Member Functions inherited from subModelBase
bool	inLine () const

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::ParticleTrap< CloudType >

Traps particles within a given phase fraction for multi-phase cases.

Model is activated using:

particleTrap1
{
    type        particleTrap;
    alphaName   alpha;      // name volume fraction field
    threshold   0.95;       // alpha value below which model is active
}

Source files

Definition at line 63 of file ParticleTrap.H.

Constructor & Destructor Documentation

◆ ParticleTrap() [1/2]

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

Definition at line 29 of file ParticleTrap.C.

◆ ParticleTrap() [2/2]

ParticleTrap ( const ParticleTrap< CloudType > & pe )

Definition at line 48 of file ParticleTrap.C.

◆ ~ParticleTrap()

virtual ~ParticleTrap ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "particleTrap" )

◆ clone()

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

inlinevirtual

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 108 of file ParticleTrap.H.

◆ preEvolve()

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

virtual

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 64 of file ParticleTrap.C.

References Foam::constant::atomic::alpha, Foam::fac::grad(), mesh, and DSMCCloud< ParcelType >::mesh().

Here is the call graph for this function:

◆ postEvolve()

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

virtual

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 90 of file ParticleTrap.C.

◆ postMove()

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

virtual

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 100 of file ParticleTrap.C.

References Foam::mag(), 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/ParticleTrap/ParticleTrap.H
src/lagrangian/intermediate/submodels/CloudFunctionObjects/ParticleTrap/ParticleTrap.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class CloudType> class Foam::ParticleTrap< CloudType >

Constructor & Destructor Documentation

◆ ParticleTrap() [1/2]

◆ ParticleTrap() [2/2]

◆ ~ParticleTrap()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ preEvolve()

◆ postEvolve()

◆ postMove()

template<class CloudType>
class Foam::ParticleTrap< CloudType >