Wall interaction model. More...

Inheritance diagram for StandardWallInteraction< CloudType >:

Collaboration diagram for StandardWallInteraction< CloudType >:

[legend]

Public Member Functions
	TypeName ("standardWallInteraction")

	StandardWallInteraction (const dictionary &dict, CloudType &cloud)

	StandardWallInteraction (const StandardWallInteraction< CloudType > &pim)

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

virtual	~StandardWallInteraction ()=default

virtual bool	correct (typename CloudType::parcelType &p, const polyPatch &pp, bool &keepParticle)

virtual void	info (Ostream &os)

Public Member Functions inherited from PatchInteractionModel< CloudType >
	TypeName ("patchInteractionModel")

	declareRunTimeSelectionTable (autoPtr, PatchInteractionModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))

	PatchInteractionModel (CloudType &owner)

	PatchInteractionModel (const dictionary &dict, CloudType &owner, const word &type)

	PatchInteractionModel (const PatchInteractionModel< CloudType > &pim)

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

virtual	~PatchInteractionModel ()=default

const word &	UName () const

const scalar &	Urmax () const

virtual void	addToEscapedParcels (const scalar mass)

virtual void	postEvolve ()

Protected Member Functions
virtual void	writeFileHeader (Ostream &os)

Protected Attributes
const fvMesh &	mesh_

PatchInteractionModel< CloudType >::interactionType	interactionType_

scalar	e_

scalar	mu_

List< List< label > >	nEscape_

List< List< scalar > >	massEscape_

List< List< label > >	nStick_

List< List< scalar > >	massStick_

bool	outputByInjectorId_

Map< label >	injIdToIndex_

Protected Attributes inherited from PatchInteractionModel< CloudType >
const word	UName_

label	escapedParcels_

scalar	escapedMass_

scalar	Urmax_

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)

static word	interactionTypeToWord (const interactionType &itEnum)

static interactionType	wordToInteractionType (const word &itWord)

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 restitution coefficients
stick - particles assigned 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 60 of file StandardWallInteraction.H.

Constructor & Destructor Documentation

◆ StandardWallInteraction() [1/2]

StandardWallInteraction	(	const dictionary &	dict,
		CloudType &	cloud
	)

Definition at line 51 of file StandardWallInteraction.C.

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

Here is the call graph for this function:

◆ StandardWallInteraction() [2/2]

StandardWallInteraction ( const StandardWallInteraction< CloudType > & pim )

Definition at line 125 of file StandardWallInteraction.C.

◆ ~StandardWallInteraction()

virtual ~StandardWallInteraction ( )

virtualdefault

Member Function Documentation

◆ writeFileHeader()

void writeFileHeader ( Ostream & os )

protectedvirtual

Reimplemented from PatchInteractionModel< CloudType >.

Definition at line 27 of file StandardWallInteraction.C.

References forAll, Foam::name(), and os().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "standardWallInteraction" )

◆ clone()

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

inlinevirtual

Definition at line 126 of file StandardWallInteraction.H.

◆ correct()

bool correct	(	typename CloudType::parcelType &	p,
		const polyPatch &	pp,
		bool &	keepParticle
	)

virtual

Implements PatchInteractionModel< CloudType >.

Definition at line 146 of file StandardWallInteraction.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, patchIdentifier::index(), Foam::mag(), Foam::nl, p, U, WarningInFunction, and Foam::Zero.

Here is the call graph for this function:

◆ info()

void info ( Ostream & os )

virtual

Reimplemented from PatchInteractionModel< CloudType >.

Definition at line 253 of file StandardWallInteraction.C.

References Foam::endl(), forAll, forAllConstIters(), Foam::nl, os(), List::setSize(), Foam::tab, and Foam::Zero.

Here is the call graph for this function:

Member Data Documentation

◆ mesh_

const fvMesh& mesh_

protected

Definition at line 69 of file StandardWallInteraction.H.

◆ interactionType_

PatchInteractionModel<CloudType>::interactionType interactionType_

protected

Definition at line 73 of file StandardWallInteraction.H.

◆ e_

scalar e_

protected

Definition at line 76 of file StandardWallInteraction.H.

◆ mu_

scalar mu_

protected

Definition at line 79 of file StandardWallInteraction.H.

◆ nEscape_

List<List<label> > nEscape_

protected

Definition at line 85 of file StandardWallInteraction.H.

◆ massEscape_

List<List<scalar> > massEscape_

protected

Definition at line 88 of file StandardWallInteraction.H.

◆ nStick_

List<List<label> > nStick_

protected

Definition at line 91 of file StandardWallInteraction.H.

◆ massStick_

List<List<scalar> > massStick_

protected

Definition at line 94 of file StandardWallInteraction.H.

◆ outputByInjectorId_

bool outputByInjectorId_

protected

Definition at line 98 of file StandardWallInteraction.H.

◆ injIdToIndex_

Map<label> injIdToIndex_

protected

Definition at line 102 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 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

◆ writeFileHeader()

◆ TypeName()

◆ clone()

◆ correct()

◆ info()

Member Data Documentation

◆ mesh_

◆ interactionType_

◆ e_

◆ mu_

◆ nEscape_

◆ massEscape_

◆ nStick_

◆ massStick_

◆ outputByInjectorId_

◆ injIdToIndex_

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