LocalInteraction< CloudType > Class Template Reference

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

Inheritance diagram for LocalInteraction< CloudType >:

Collaboration diagram for LocalInteraction< CloudType >:

Public Member Functions
	TypeName ("localInteraction")
	LocalInteraction (const dictionary &dict, CloudType &owner)
	LocalInteraction (const LocalInteraction< CloudType > &pim)
virtual autoPtr< PatchInteractionModel< CloudType > >	clone () const
virtual	~LocalInteraction ()=default
volScalarField &	massEscape ()
volScalarField &	massStick ()
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)

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_
Protected Attributes inherited from PatchInteractionModel< CloudType >
const word	UName_
label	escapedParcels_
scalar	escapedMass_
scalar	Urmax_

Detailed Description

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

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

Definition at line 48 of file LocalInteraction.H.

Constructor & Destructor Documentation

LocalInteraction() [1/2]

LocalInteraction	(	const dictionary &	dict,
		CloudType &	owner
	)

Definition at line 49 of file LocalInteraction.C.

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

Here is the call graph for this function:

LocalInteraction() [2/2]

LocalInteraction

(

const LocalInteraction< CloudType > &

pim

)

Definition at line 128 of file LocalInteraction.C.

~LocalInteraction()

virtual ~LocalInteraction ( )

virtualdefault

Member Function Documentation

writeFileHeader()

void writeFileHeader ( Ostream &  os )

protectedvirtual

Reimplemented from PatchInteractionModel< CloudType >.

Definition at line 27 of file LocalInteraction.C.

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

Here is the call graph for this function:

TypeName()

TypeName

(

"localInteraction"

)

clone()

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

inlinevirtual

Definition at line 110 of file LocalInteraction.H.

massEscape()

Foam::volScalarField & massEscape

Definition at line 148 of file LocalInteraction.C.

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

Here is the call graph for this function:

massStick()

Foam::volScalarField & massStick

Definition at line 177 of file LocalInteraction.C.

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

Here is the call graph for this function:

correct()

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

virtual

Implements PatchInteractionModel< CloudType >.

Definition at line 207 of file LocalInteraction.C.

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

Here is the call graph for this function:

info()

void info ( Ostream &  os )

virtual

Reimplemented from PatchInteractionModel< CloudType >.

Definition at line 337 of file LocalInteraction.C.

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

Here is the call graph for this function:

---

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