Wall interaction model. Three choices: More...

Inheritance diagram for StandardWallInteraction< CloudType >:

Collaboration diagram for StandardWallInteraction< CloudType >:

Public Member Functions
	TypeName ("standardWallInteraction")
	Runtime type information. More...

	StandardWallInteraction (const dictionary &dict, CloudType &cloud)
	Construct from dictionary. More...

	StandardWallInteraction (const StandardWallInteraction< CloudType > &pim)
	Construct copy from owner cloud and patch interaction model. More...

virtual autoPtr< PatchInteractionModel< CloudType > >	clone () const
	Construct and return a clone using supplied owner cloud. More...

virtual	~StandardWallInteraction ()
	Destructor. More...

virtual bool	correct (typename CloudType::parcelType &p, const polyPatch &pp, bool &keepParticle, const scalar trackFraction, const tetIndices &tetIs)
	Apply velocity correction. More...

virtual void	info (Ostream &os)
	Write patch interaction info to stream. More...

Public Member Functions inherited from PatchInteractionModel< CloudType >
	TypeName ("patchInteractionModel")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, PatchInteractionModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
	Declare runtime constructor selection table. More...

	PatchInteractionModel (CloudType &owner)
	Construct null from owner. More...

	PatchInteractionModel (const dictionary &dict, CloudType &owner, const word &type)
	Construct from components. More...

	PatchInteractionModel (const PatchInteractionModel< CloudType > &pim)
	Construct copy. More...

virtual autoPtr< PatchInteractionModel< CloudType > >	clone () const=0
	Construct and return a clone. More...

virtual	~PatchInteractionModel ()
	Destructor. More...

const word &	UName () const
	Return name of velocity field. More...

void	addToEscapedParcels (const scalar mass)
	Add to escaped parcels. More...

Protected Attributes
PatchInteractionModel< CloudType >::interactionType	interactionType_
	Interaction type. More...

scalar	e_
	Elasticity coefficient. More...

scalar	mu_
	Restitution coefficient. More...

label	nEscape_
	Number of parcels escaped. More...

scalar	massEscape_
	Mass of parcels escaped. More...

label	nStick_
	Number of parcels stuck to patches. More...

scalar	massStick_
	Mass of parcels stuck to patches. More...

Protected Attributes inherited from PatchInteractionModel< CloudType >
const word	UName_
	Name of velocity field - default = "U". More...

label	escapedParcels_
	Number of parcels escaped. More...

scalar	escapedMass_
	Mass of parcels escaped. More...

Additional Inherited Members
Public Types inherited from PatchInteractionModel< CloudType >
enum	interactionType

Static Public Member Functions inherited from PatchInteractionModel< CloudType >
static autoPtr< PatchInteractionModel< CloudType > >	New (const dictionary &dict, CloudType &owner)
	Selector. More...

static word	interactionTypeToWord (const interactionType &itEnum)
	Convert interaction result to word. More...

static interactionType	wordToInteractionType (const word &itWord)
	Convert word to interaction result. More...

Static Public Attributes inherited from PatchInteractionModel< CloudType >
static wordList	interactionTypeNames_

Detailed Description

template<class CloudType>
class Foam::StandardWallInteraction< CloudType >

Wall interaction model. Three choices:

- rebound - optionally specify elasticity and resitution coefficients

stick - particles assigined zero velocity
escape - remove particle from the domain

Example usage:

StandardWallInteractionCoeffs { type rebound; // stick, escape e 1; // optional - elasticity coeff mu 0; // optional - restitution coeff }

Definition at line 57 of file StandardWallInteraction.H.

Constructor & Destructor Documentation

◆ StandardWallInteraction() [1/2]

StandardWallInteraction	(	const dictionary &	dict,
		CloudType &	cloud
	)

Construct from dictionary.

Definition at line 32 of file StandardWallInteraction.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, and lookup().

Here is the call graph for this function:

◆ StandardWallInteraction() [2/2]

StandardWallInteraction ( const StandardWallInteraction< CloudType > & pim )

Construct copy from owner cloud and patch interaction model.

Definition at line 79 of file StandardWallInteraction.C.

◆ ~StandardWallInteraction()

~StandardWallInteraction

virtual

Destructor.

Definition at line 97 of file StandardWallInteraction.C.

Member Function Documentation

◆ TypeName()

TypeName ( "standardWallInteraction" )

Runtime type information.

◆ clone()

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

inlinevirtual

Construct and return a clone using supplied owner cloud.

Definition at line 106 of file StandardWallInteraction.H.

◆ correct()

bool correct	(	typename CloudType::parcelType &	p,
		const polyPatch &	pp,
		bool &	keepParticle,
		const scalar	trackFraction,
		const tetIndices &	tetIs
	)

virtual

Apply velocity correction.

Returns true if particle remains in same cell

Implements PatchInteractionModel< CloudType >.

Definition at line 105 of file StandardWallInteraction.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, nw, p, and U.

Here is the call graph for this function:

◆ info()

void info ( Ostream & os )

virtual

Write patch interaction info to stream.

Reimplemented from PatchInteractionModel< CloudType >.

Definition at line 185 of file StandardWallInteraction.C.

References Foam::nl, and Foam::returnReduce().

Here is the call graph for this function:

Field Documentation

◆ interactionType_

PatchInteractionModel<CloudType>::interactionType interactionType_

protected

Interaction type.

Definition at line 67 of file StandardWallInteraction.H.

◆ e_

scalar e_

protected

Elasticity coefficient.

Definition at line 70 of file StandardWallInteraction.H.

◆ mu_

scalar mu_

protected

Restitution coefficient.

Definition at line 73 of file StandardWallInteraction.H.

◆ nEscape_

label nEscape_

protected

Number of parcels escaped.

Definition at line 79 of file StandardWallInteraction.H.

◆ massEscape_

scalar massEscape_

protected

Mass of parcels escaped.

Definition at line 82 of file StandardWallInteraction.H.

◆ nStick_

label nStick_

protected

Number of parcels stuck to patches.

Definition at line 85 of file StandardWallInteraction.H.

◆ massStick_

scalar massStick_

protected

Mass of parcels stuck to patches.

Definition at line 88 of file StandardWallInteraction.H.

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

src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/StandardWallInteraction/StandardWallInteraction.H
src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/StandardWallInteraction/StandardWallInteraction.C

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class CloudType> class Foam::StandardWallInteraction< CloudType >

Constructor & Destructor Documentation

◆ StandardWallInteraction() [1/2]

◆ StandardWallInteraction() [2/2]

◆ ~StandardWallInteraction()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ correct()

◆ info()

Field Documentation

◆ interactionType_

◆ e_

◆ mu_

◆ nEscape_

◆ massEscape_

◆ nStick_

◆ massStick_

template<class CloudType>
class Foam::StandardWallInteraction< CloudType >