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")
	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 ()=default
	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)
	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	~PatchInteractionModel ()=default
	Destructor. More...
const word &	UName () const
	Return name of velocity field. More...
void	addToEscapedParcels (const scalar mass)
	Add to escaped parcels. More...

Protected Member Functions
virtual void	writeFileHeader (Ostream &os)
	Output file header information. More...

Additional Inherited Members
Public Types inherited from PatchInteractionModel< CloudType >
enum	interactionType {   itNone, itRebound, itStick, itEscape,   itOther }
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 54 of file LocalInteraction.H.

Constructor & Destructor Documentation

LocalInteraction() [1/2]

LocalInteraction	(	const dictionary &	dict,
		CloudType &	owner
	)

Construct from dictionary.

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

)

Construct copy from owner cloud and patch interaction model.

Definition at line 135 of file LocalInteraction.C.

~LocalInteraction()

virtual ~LocalInteraction ( )

virtualdefault

Destructor.

Member Function Documentation

writeFileHeader()

void writeFileHeader ( Ostream &  os )

protectedvirtual

Output file header information.

Reimplemented from PatchInteractionModel< CloudType >.

Definition at line 34 of file LocalInteraction.C.

References forAll, and Foam::name().

Here is the call graph for this function:

TypeName()

TypeName

(

"localInteraction"

)

Runtime type information.

clone()

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

inlinevirtual

Construct and return a clone using supplied owner cloud.

Implements PatchInteractionModel< CloudType >.

Definition at line 116 of file LocalInteraction.H.

massEscape()

Foam::volScalarField & massEscape

(

)

Return access to the massEscape field.

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

(

)

Return access to the massStick field.

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

Apply velocity correction.

Returns true if particle remains in same cell

Implements PatchInteractionModel< CloudType >.

Definition at line 214 of file LocalInteraction.C.

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

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

References Foam::endl(), forAll, forAllConstIters(), Foam::nl, 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