Patch interaction specified on a patch-by-patch basis. More...

Inheritance diagram for LocalInteraction< CloudType >:

Collaboration diagram for LocalInteraction< CloudType >:

[legend]

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

	LocalInteraction (const dictionary &dict, CloudType &owner)
	Construct from dictionary. More...

	LocalInteraction (const LocalInteraction< 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	~LocalInteraction ()
	Destructor. More...

volScalarField &	massEscape ()
	Return access to the massEscape field. More...

volScalarField &	massStick ()
	Return access to the massStick field. 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...

Private Attributes
const patchInteractionDataList	patchData_
	List of participating patches. More...

List< label >	nEscape_
	Number of parcels escaped. More...

List< scalar >	massEscape_
	Mass of parcels escaped. More...

List< label >	nStick_
	Number of parcels stuck to patches. More...

List< scalar >	massStick_
	Mass of parcels stuck to patches. More...

Switch	writeFields_
	Flag to output data as fields. More...

autoPtr< volScalarField >	massEscapePtr_
	Mass escape field. More...

autoPtr< volScalarField >	massStickPtr_
	Mass stick field. 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_

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

Detailed Description

template<class CloudType>
class Foam::LocalInteraction< CloudType >

Patch interaction specified on a patch-by-patch basis.

Definition at line 47 of file LocalInteraction.H.

Constructor & Destructor Documentation

◆ LocalInteraction() [1/2]

LocalInteraction	(	const dictionary &	dict,
		CloudType &	owner
	)

Construct from dictionary.

Definition at line 32 of file LocalInteraction.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::Info, Foam::name(), and Foam::nl.

Here is the call graph for this function:

◆ LocalInteraction() [2/2]

LocalInteraction ( const LocalInteraction< CloudType > & pim )

Construct copy from owner cloud and patch interaction model.

Definition at line 86 of file LocalInteraction.C.

◆ ~LocalInteraction()

~LocalInteraction

virtual

Destructor.

Definition at line 105 of file LocalInteraction.C.

Member Function Documentation

◆ TypeName()

TypeName ( "localInteraction" )

Runtime type information.

◆ clone()

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

inlinevirtual

Construct and return a clone using supplied owner cloud.

Definition at line 97 of file LocalInteraction.H.

◆ massEscape()

Foam::volScalarField & massEscape

Return access to the massEscape field.

Definition at line 112 of file LocalInteraction.C.

References Foam::dimMass, mesh, and Foam::name().

Here is the call graph for this function:

◆ massStick()

Foam::volScalarField & massStick

Return access to the massStick field.

Definition at line 141 of file LocalInteraction.C.

References Foam::dimMass, mesh, and Foam::name().

Here is the call graph for this function:

◆ 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 171 of file LocalInteraction.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, patchIdentifier::index(), nw, p, U, and polyPatch::whichFace().

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 276 of file LocalInteraction.C.

References forAll, and Foam::nl.

Field Documentation

◆ patchData_

const patchInteractionDataList patchData_

private

List of participating patches.

Definition at line 54 of file LocalInteraction.H.

◆ nEscape_

List<label> nEscape_

private

Number of parcels escaped.

Definition at line 60 of file LocalInteraction.H.

◆ massEscape_

List<scalar> massEscape_

private

Mass of parcels escaped.

Definition at line 63 of file LocalInteraction.H.

◆ nStick_

List<label> nStick_

private

Number of parcels stuck to patches.

Definition at line 66 of file LocalInteraction.H.

◆ massStick_

List<scalar> massStick_

private

Mass of parcels stuck to patches.

Definition at line 69 of file LocalInteraction.H.

◆ writeFields_

Switch writeFields_

private

Flag to output data as fields.

Definition at line 73 of file LocalInteraction.H.

◆ massEscapePtr_

autoPtr<volScalarField> massEscapePtr_

private

Mass escape field.

Definition at line 76 of file LocalInteraction.H.

◆ massStickPtr_

autoPtr<volScalarField> massStickPtr_

private

Mass stick field.

Definition at line 79 of file LocalInteraction.H.

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

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<class CloudType> class Foam::LocalInteraction< CloudType >

Constructor & Destructor Documentation

◆ LocalInteraction() [1/2]

◆ LocalInteraction() [2/2]

◆ ~LocalInteraction()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ massEscape()

◆ massStick()

◆ correct()

◆ info()

Field Documentation

◆ patchData_

◆ nEscape_

◆ massEscape_

◆ nStick_

◆ massStick_

◆ writeFields_

◆ massEscapePtr_

◆ massStickPtr_

template<class CloudType>
class Foam::LocalInteraction< CloudType >