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")
	Runtime type information. More...

	ParticleTrap (const dictionary &dict, CloudType &owner, const word &modelName)
	Construct from dictionary. More...

	ParticleTrap (const ParticleTrap< CloudType > &pe)
	Construct copy. More...

virtual autoPtr< CloudFunctionObject< CloudType > >	clone () const
	Construct and return a clone. More...

virtual	~ParticleTrap ()
	Destructor. More...

virtual void	preEvolve ()
	Pre-evolve hook. More...

virtual void	postEvolve ()
	Post-evolve hook. More...

virtual void	postMove (typename CloudType::parcelType &p, const scalar dt, const point &position0, bool &keepParticle)
	Post-move 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 ()
	Destructor. More...

virtual void	postPatch (const typename CloudType::parcelType &p, const polyPatch &pp, bool &keepParticle)
	Post-patch hook. More...

virtual void	postFace (const typename CloudType::parcelType &p, bool &keepParticle)
	Post-face hook. More...

const fileName &	outputDir () 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)
	Copy constructor. More...

virtual	~CloudSubModelBase ()
	Destructor. More...

const CloudType &	owner () const
	Return const access to the owner cloud. More...

virtual bool	writeTime () const
	Flag to indicate when to write a property. More...

CloudType &	owner ()
	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)
	Copy constructor. More...

virtual	~subModelBase ()
	Destructor. More...

const word &	modelName () const
	Return const access to the name of the sub-model. More...

const dictionary &	dict () const
	Return const access to the cloud dictionary. More...

const word &	baseName () const
	Return const access to the base name of the sub-model. More...

const word &	modelType () const
	Return const access to the sub-model type. More...

const dictionary &	coeffDict () const
	Return const access to the coefficients dictionary. More...

const dictionary &	properties () 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 void	cacheFields (const bool store)
	Cache dependent sub-model fields. More...

template<class Type >
Type	getBaseProperty (const word &entryName, const Type &defaultValue=pTraits< 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...

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=pTraits< 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...

void	operator= (const subModelBase &)=delete
	Disallow default bitwise assignment. 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 Member Functions inherited from subModelBase
bool	inLine () const
	Flag to indicate whether data is/was read in-line. More...

Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudType &	owner_
	Reference to the cloud. More...

Protected Attributes inherited from subModelBase
const word	modelName_
	Name of the sub-model. More...

dictionary &	properties_
	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::ParticleTrap< CloudType >

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

Model is activated using:

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

Source files

Definition at line 61 of file ParticleTrap.H.

Constructor & Destructor Documentation

◆ ParticleTrap() [1/2]

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

Construct from dictionary.

Definition at line 33 of file ParticleTrap.C.

◆ ParticleTrap() [2/2]

ParticleTrap ( const ParticleTrap< CloudType > & pe )

Construct copy.

Definition at line 52 of file ParticleTrap.C.

◆ ~ParticleTrap()

~ParticleTrap ( )

virtual

Destructor.

Definition at line 67 of file ParticleTrap.C.

Referenced by ParticleTrap< CloudType >::clone().

Here is the caller graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "particleTrap" )

Runtime type information.

◆ clone()

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

inlinevirtual

Construct and return a clone.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 106 of file ParticleTrap.H.

References p, ParticleTrap< CloudType >::postEvolve(), ParticleTrap< CloudType >::postMove(), ParticleTrap< CloudType >::preEvolve(), and ParticleTrap< CloudType >::~ParticleTrap().

Here is the call graph for this function:

◆ preEvolve()

void preEvolve ( )

virtual

Pre-evolve hook.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 74 of file ParticleTrap.C.

References alpha(), Foam::fvc::grad(), objectRegistry::lookupObject(), and mesh.

Referenced by ParticleTrap< CloudType >::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ postEvolve()

void postEvolve ( )

virtual

Post-evolve hook.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 97 of file ParticleTrap.C.

References ParticleTrap< CloudType >::postMove().

Referenced by ParticleTrap< CloudType >::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ postMove()

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

virtual

Post-move hook.

Reimplemented from CloudFunctionObject< CloudType >.

Definition at line 105 of file ParticleTrap.C.

References Foam::mag().

Referenced by ParticleTrap< CloudType >::clone(), and ParticleTrap< CloudType >::postEvolve().

Here is the call graph for this function:

Here is the caller graph for this function:

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

src/lagrangian/parcel/submodels/CloudFunctionObjects/ParticleTrap/ParticleTrap.H
src/lagrangian/parcel/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 >