WallModel Class Reference

Templated wall interaction class. More...

Inheritance diagram for WallModel:

Collaboration diagram for WallModel:

Public Member Functions
	TypeName ("wallModel")
	Runtime type information. More...
	declareRunTimeSelectionTable (autoPtr, WallModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
	Declare runtime constructor selection table. More...
	WallModel (const dictionary &dict, CloudType &owner, const word &type)
	Construct from components. More...
virtual	~WallModel ()
	Destructor. More...
const CloudType &	owner () const
	Return the owner cloud object. More...
CloudType &	owner ()
	Return non-const access to the owner cloud object. More...
const dictionary &	dict () const
	Return the dictionary. More...
const dictionary &	coeffDict () const
	Return the coefficients dictionary. More...
virtual scalar	pREff (const typename CloudType::parcelType &p) const =0
	Return the effective radius for a particle for the model. More...
virtual bool	controlsTimestep () const =0
	Whether the WallModel has a timestep limit that will. More...
virtual label	nSubCycles () const =0
	For WallModels that control the timestep, calculate the. More...
virtual void	evaluateWall (typename CloudType::parcelType &p, const List< point > &flatSitePoints, const List< WallSiteData< vector > > &flatSiteData, const List< point > &sharpSitePoints, const List< WallSiteData< vector > > &sharpSiteData) const =0
	Calculate the wall interaction for a parcel. More...

Static Public Member Functions
static autoPtr< WallModel< CloudType > >	New (const dictionary &dict, CloudType &owner)
	Selector. More...

Private Attributes
const dictionary &	dict_
	The CollisionModel dictionary. More...
CloudType &	owner_
	Reference to the owner cloud class. More...
const dictionary	coeffDict_
	The coefficients dictionary. More...

Detailed Description

Templated wall interaction class.

Source files

• WallModel.H
• WallModel.C
• WallModelNew.C

Definition at line 51 of file PairCollision.H.

Constructor & Destructor Documentation

WallModel()

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

Construct from components.

Definition at line 32 of file WallModel.C.

~WallModel()

~WallModel ( )

virtual

Destructor.

Definition at line 47 of file WallModel.C.

Member Function Documentation

TypeName()

TypeName

(

"wallModel"

)

Runtime type information.

declareRunTimeSelectionTable()

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

Declare runtime constructor selection table.

New()

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

static

Selector.

Definition at line 33 of file WallModelNew.C.

owner() [1/2]

const CloudType & owner

(

)

const

Return the owner cloud object.

Definition at line 55 of file WallModel.C.

owner() [2/2]

CloudType & owner

(

)

Return non-const access to the owner cloud object.

Definition at line 63 of file WallModel.C.

dict()

const Foam::dictionary & dict

(

)

const

Return the dictionary.

Definition at line 70 of file WallModel.C.

coeffDict()

const Foam::dictionary & coeffDict

(

)

const

Return the coefficients dictionary.

Definition at line 78 of file WallModel.C.

pREff()

virtual scalar pREff ( const typename CloudType::parcelType &  p ) const

pure virtual

Return the effective radius for a particle for the model.

Implemented in WallLocalSpringSliderDashpot< CloudType >, and WallSpringSliderDashpot< CloudType >.

controlsTimestep()

virtual bool controlsTimestep ( ) const

pure virtual

Whether the WallModel has a timestep limit that will.

require subCycling

nSubCycles()

virtual label nSubCycles ( ) const

pure virtual

For WallModels that control the timestep, calculate the.

number of subCycles needed to satisfy the minimum allowable timestep

evaluateWall()

virtual void evaluateWall ( typename CloudType::parcelType &  p, const List< point > &  flatSitePoints, const List< WallSiteData< vector > > &  flatSiteData, const List< point > &  sharpSitePoints, const List< WallSiteData< vector > > &  sharpSiteData  ) const

pure virtual

Calculate the wall interaction for a parcel.

Implemented in WallLocalSpringSliderDashpot< CloudType >, and WallSpringSliderDashpot< CloudType >.

Field Documentation

dict_

const dictionary& dict_

private

The CollisionModel dictionary.

Definition at line 58 of file WallModel.H.

owner_

CloudType& owner_

private

Reference to the owner cloud class.

Definition at line 61 of file WallModel.H.

coeffDict_

const dictionary coeffDict_

private

The coefficients dictionary.

Definition at line 64 of file WallModel.H.

---

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

• src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/PairCollision.H
• src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/WallModel/WallModel/WallModel.H
• src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/WallModel/WallModel/WallModel.C
• src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/WallModel/WallModel/WallModelNew.C