Templated patch interaction model class. More...

Inheritance diagram for PatchInteractionModel< CloudType >:

[legend]

Collaboration diagram for PatchInteractionModel< CloudType >:

Public Types
enum	interactionType { itNone, itRebound, itStick, itEscape, itOther }

Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType	cloudType
	Type of cloud this model was instantiated for. More...

Public Member Functions
	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...

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

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

Public Member Functions inherited from CloudSubModelBase< CloudType >
	CloudSubModelBase (CloudType &owner)
	Construct null from owner cloud. More...

	CloudSubModelBase (CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from owner cloud without name. More...

	CloudSubModelBase (const word &modelName, CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from owner cloud with name. More...

	CloudSubModelBase (const CloudSubModelBase< CloudType > &smb)
	Construct as copy. More...

virtual	~CloudSubModelBase ()
	Destructor. More...

const CloudType &	owner () const
	Return const access to the owner cloud. More...

virtual bool	writeTime () const
	Flag to indicate when to write a property. More...

CloudType &	owner ()
	Return non-const access to the owner cloud for manipulation. More...

virtual void	write (Ostream &os) const
	Write. More...

Public Member Functions inherited from subModelBase
	subModelBase (dictionary &properties)
	Construct null. More...

	subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from components without name. More...

	subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from components with name. More...

	subModelBase (const subModelBase &smb)
	Construct as copy. More...

virtual	~subModelBase ()
	Destructor. More...

const word &	modelName () const
	Return const access to the name of the sub-model. More...

const dictionary &	dict () const
	Return const access to the cloud dictionary. More...

const word &	baseName () const
	Return const access to the base name of the sub-model. More...

const word &	modelType () const
	Return const access to the sub-model type. More...

const dictionary &	coeffDict () const
	Return const access to the coefficients dictionary. More...

const dictionary &	properties () const
	Return const access to the properties dictionary. More...

virtual bool	defaultCoeffs (const bool printMsg) const
	Returns true if defaultCoeffs is true and outputs on printMsg. More...

virtual bool	active () const
	Return the model 'active' status - default active = true. More...

virtual void	cacheFields (const bool store)
	Cache dependant sub-model fields. More...

template<class Type >
Type	getBaseProperty (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
	Retrieve generic property from the base model. More...

template<class Type >
void	getBaseProperty (const word &entryName, Type &value) const
	Retrieve generic property from the base model. More...

template<class Type >
void	setBaseProperty (const word &entryName, const Type &value)
	Add generic property to the base model. More...

template<class Type >
void	getModelProperty (const word &entryName, Type &value) const
	Retrieve generic property from the sub-model. More...

template<class Type >
Type	getModelProperty (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
	Retrieve generic property from the sub-model. More...

template<class Type >
void	setModelProperty (const word &entryName, const Type &value)
	Add generic property to the sub-model. More...

Static Public Member Functions
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
static wordList	interactionTypeNames_

Additional Inherited Members
Protected Member Functions inherited from subModelBase
bool	inLine () const
	Flag to indicate whether data is/was read in-line. More...

Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudType &	owner_
	Reference to the cloud. More...

Protected Attributes inherited from subModelBase
const word	modelName_
	Name of the sub-model. More...

dictionary &	properties_
	Reference to properties dictionary e.g. for restart. More...

const dictionary	dict_
	Copy of dictionary used during construction. More...

const word	baseName_
	Name of the sub-model base class. More...

const word	modelType_
	Type of the sub-model. More...

const dictionary	coeffDict_
	Coefficients dictionary. More...

Detailed Description

template<class CloudType>
class Foam::PatchInteractionModel< CloudType >

Templated patch interaction model class.

Source files

Definition at line 82 of file KinematicCloud.H.

Member Enumeration Documentation

◆ interactionType

enum interactionType

Enumerator
itNone
itRebound
itStick
itEscape
itOther

Definition at line 65 of file PatchInteractionModel.H.

Constructor & Destructor Documentation

◆ PatchInteractionModel() [1/3]

PatchInteractionModel ( CloudType & owner )

Construct null from owner.

Definition at line 117 of file PatchInteractionModel.C.

Referenced by PatchInteractionModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::PatchInteractionModel(), and PatchInteractionModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::wordToInteractionType().

Here is the caller graph for this function:

◆ PatchInteractionModel() [2/3]

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

Construct from components.

Definition at line 128 of file PatchInteractionModel.C.

◆ PatchInteractionModel() [3/3]

PatchInteractionModel ( const PatchInteractionModel< CloudType > & pim )

Construct copy.

Definition at line 141 of file PatchInteractionModel.C.

◆ ~PatchInteractionModel()

~PatchInteractionModel ( )

virtual

Destructor.

Definition at line 153 of file PatchInteractionModel.C.

Member Function Documentation

◆ TypeName()

TypeName ( "patchInteractionModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

Declare runtime constructor selection table.

◆ clone()

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

pure virtual

Construct and return a clone.

Implemented in MultiInteraction< CloudType >, StandardWallInteraction< CloudType >, LocalInteraction< CloudType >, Rebound< CloudType >, and NoInteraction< CloudType >.

◆ New()

Foam::autoPtr< Foam::PatchInteractionModel< CloudType > > New	(	const dictionary &	dict,
		CloudType &	owner
	)

static

Selector.

Definition at line 33 of file PatchInteractionModelNew.C.

◆ UName()

const Foam::word & UName ( ) const

Return name of velocity field.

Definition at line 160 of file PatchInteractionModel.C.

◆ interactionTypeToWord()

Foam::word interactionTypeToWord ( const interactionType & itEnum )

static

Convert interaction result to word.

Definition at line 46 of file PatchInteractionModel.C.

◆ wordToInteractionType()

Foam::PatchInteractionModel< CloudType >::interactionType wordToInteractionType ( const word & itWord )

static

Convert word to interaction result.

Definition at line 86 of file PatchInteractionModel.C.

Referenced by PatchInteractionModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::interactionTypeToWord().

Here is the caller graph for this function:

◆ correct()

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

pure virtual

Apply velocity correction.

Returns true if particle remains in same cell

Implemented in MultiInteraction< CloudType >, StandardWallInteraction< CloudType >, LocalInteraction< CloudType >, Rebound< CloudType >, and NoInteraction< CloudType >.

◆ info()

void info ( Ostream & os )

virtual

Write patch interaction info to stream.

Reimplemented in StandardWallInteraction< CloudType >, and LocalInteraction< CloudType >.

Definition at line 167 of file PatchInteractionModel.C.

Member Data Documentation

◆ interactionTypeNames_

Foam::wordList interactionTypeNames_

static

Definition at line 74 of file PatchInteractionModel.H.

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

src/lagrangian/intermediate/clouds/Templates/KinematicCloud/KinematicCloud.H
src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/PatchInteractionModel/PatchInteractionModel.H
src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/PatchInteractionModel/PatchInteractionModel.C
src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/PatchInteractionModel/PatchInteractionModelNew.C

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

template<class CloudType> class Foam::PatchInteractionModel< CloudType >

Member Enumeration Documentation

◆ interactionType

Constructor & Destructor Documentation

◆ PatchInteractionModel() [1/3]

◆ PatchInteractionModel() [2/3]

◆ PatchInteractionModel() [3/3]

◆ ~PatchInteractionModel()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ clone()

◆ New()

◆ UName()

◆ interactionTypeToWord()

◆ wordToInteractionType()

◆ correct()

◆ info()

Member Data Documentation

◆ interactionTypeNames_

template<class CloudType>
class Foam::PatchInteractionModel< CloudType >