Public Member Functions | Static Public Member Functions | List of all members
WallInteractionModel< CloudType > Class Template Referenceabstract

Templated wall interaction model class. More...

Inheritance diagram for WallInteractionModel< CloudType >:
Inheritance graph
[legend]

Public Member Functions

 TypeName ("WallInteractionModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, WallInteractionModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
 Declare runtime constructor selection table. More...
 
 WallInteractionModel (CloudType &owner)
 Construct null from owner. More...
 
 WallInteractionModel (const dictionary &dict, CloudType &owner, const word &type)
 Construct from components. More...
 
virtual ~WallInteractionModel ()
 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 void correct (typename CloudType::parcelType &p)=0
 Apply wall correction. More...
 

Static Public Member Functions

static autoPtr< WallInteractionModel< CloudType > > New (const dictionary &dict, CloudType &owner)
 Selector. More...
 

Detailed Description

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

Templated wall interaction model class.

Source files

Definition at line 52 of file WallInteractionModel.H.

Constructor & Destructor Documentation

◆ WallInteractionModel() [1/2]

WallInteractionModel ( CloudType &  owner)

Construct null from owner.

Definition at line 31 of file WallInteractionModel.C.

◆ WallInteractionModel() [2/2]

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

Construct from components.

Definition at line 40 of file WallInteractionModel.C.

◆ ~WallInteractionModel()

~WallInteractionModel
virtual

Destructor.

Definition at line 56 of file WallInteractionModel.C.

Member Function Documentation

◆ TypeName()

TypeName ( "WallInteractionModel< CloudType >"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

Declare runtime constructor selection table.

◆ New()

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

Selector.

Definition at line 32 of file WallInteractionModelNew.C.

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

Here is the call graph for this function:

◆ owner() [1/2]

const CloudType & owner

Return the owner cloud object.

Definition at line 63 of file WallInteractionModel.C.

◆ owner() [2/2]

CloudType & owner

Return non-const access to the owner cloud object.

Definition at line 70 of file WallInteractionModel.C.

◆ dict()

const Foam::dictionary & dict

Return the dictionary.

Definition at line 77 of file WallInteractionModel.C.

◆ coeffDict()

const Foam::dictionary & coeffDict

Return the coefficients dictionary.

Definition at line 85 of file WallInteractionModel.C.

◆ correct()

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

Apply wall correction.

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

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