WallInteractionModel< CloudType > Class Template Reference

Templated wall interaction model class. More...

#include <WallInteractionModel.H>

Inheritance diagram for WallInteractionModel< CloudType >:

Public Member Functions
	TypeName ("WallInteractionModel")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, WallInteractionModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
	Declare runtime constructor selection table.
	WallInteractionModel (CloudType &owner)
	Construct null from owner.
	WallInteractionModel (const dictionary &dict, CloudType &owner, const word &type)
	Construct from components.
virtual	~WallInteractionModel ()
	Destructor.
const CloudType &	owner () const
	Return the owner cloud object.
CloudType &	owner ()
	Return non-const access to the owner cloud object.
const dictionary &	dict () const
	Return the dictionary.
const dictionary &	coeffDict () const
	Return the coefficients dictionary.
virtual void	correct (typename CloudType::parcelType &p)=0
	Apply wall correction.

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

Detailed Description

template<class CloudType>
class Foam::WallInteractionModel< CloudType >

Templated wall interaction model class.

Source files

• WallInteractionModel.H
• WallInteractionModel.C
• WallInteractionModelNew.C

Definition at line 50 of file WallInteractionModel.H.

Constructor & Destructor Documentation

WallInteractionModel() [1/2]

template<class CloudType>

WallInteractionModel

(

CloudType &

owner

)

Construct null from owner.

Definition at line 27 of file WallInteractionModel.C.

References owner().

Referenced by declareRunTimeSelectionTable(), MaxwellianThermal< CloudType >::MaxwellianThermal(), MixedDiffuseSpecular< CloudType >::MixedDiffuseSpecular(), and SpecularReflection< CloudType >::SpecularReflection().

Here is the call graph for this function:

Here is the caller graph for this function:

WallInteractionModel() [2/2]

template<class CloudType>

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

Construct from components.

Definition at line 36 of file WallInteractionModel.C.

References dict(), and owner().

Here is the call graph for this function:

~WallInteractionModel()

template<class CloudType>

~WallInteractionModel ( )

virtual

Destructor.

Definition at line 52 of file WallInteractionModel.C.

Member Function Documentation

TypeName()

template<class CloudType>

TypeName

(

"WallInteractionModel< CloudType >"

)

Runtime type information.

declareRunTimeSelectionTable()

template<class CloudType>

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

Declare runtime constructor selection table.

References dict(), owner(), and WallInteractionModel().

Here is the call graph for this function:

New()

template<class CloudType>

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

static

Selector.

Definition at line 28 of file WallInteractionModelNew.C.

References dict(), Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, and owner().

Here is the call graph for this function:

owner() [1/2]

template<class CloudType>

const CloudType & owner

(

)

const

Return the owner cloud object.

Definition at line 59 of file WallInteractionModel.C.

Referenced by MaxwellianThermal< CloudType >::correct(), MixedDiffuseSpecular< CloudType >::correct(), declareRunTimeSelectionTable(), New(), WallInteractionModel(), and WallInteractionModel().

Here is the caller graph for this function:

owner() [2/2]

template<class CloudType>

CloudType & owner

(

)

Return non-const access to the owner cloud object.

Definition at line 66 of file WallInteractionModel.C.

dict()

template<class CloudType>

const Foam::dictionary & dict

(

)

const

Return the dictionary.

Definition at line 73 of file WallInteractionModel.C.

Referenced by declareRunTimeSelectionTable(), MaxwellianThermal< CloudType >::MaxwellianThermal(), MixedDiffuseSpecular< CloudType >::MixedDiffuseSpecular(), New(), SpecularReflection< CloudType >::SpecularReflection(), MaxwellianThermal< CloudType >::TypeName(), MixedDiffuseSpecular< CloudType >::TypeName(), SpecularReflection< CloudType >::TypeName(), and WallInteractionModel().

Here is the caller graph for this function:

coeffDict()

template<class CloudType>

const Foam::dictionary & coeffDict

(

)

const

Return the coefficients dictionary.

Definition at line 81 of file WallInteractionModel.C.

Referenced by MixedDiffuseSpecular< CloudType >::MixedDiffuseSpecular().

Here is the caller graph for this function:

correct()

template<class CloudType>

virtual void correct ( typename CloudType::parcelType & p )

pure virtual

Apply wall correction.

Implemented in MaxwellianThermal< CloudType >, MixedDiffuseSpecular< CloudType >, and SpecularReflection< CloudType >.

References p.

---

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

• src/lagrangian/DSMC/clouds/Templates/DSMCCloud/DSMCCloud.H
• src/lagrangian/DSMC/submodels/WallInteractionModel/WallInteractionModel/WallInteractionModel.H
• src/lagrangian/DSMC/submodels/WallInteractionModel/WallInteractionModel/WallInteractionModel.C
• src/lagrangian/DSMC/submodels/WallInteractionModel/WallInteractionModel/WallInteractionModelNew.C