Loading...
Searching...
No Matches
WallModel< CloudType > Class Template Referenceabstract

Templated wall interaction class. More...

#include <WallModel.H>

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

Public Member Functions

 TypeName ("wallModel")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, WallModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
 Declare runtime constructor selection table.
 WallModel (const dictionary &dict, CloudType &owner, const word &type)
 Construct from components.
virtual ~WallModel ()
 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 scalar pREff (const typename CloudType::parcelType &p) const =0
 Return the effective radius for a particle for the model.
virtual bool controlsTimestep () const =0
 Whether the WallModel has a timestep limit that will.
virtual label nSubCycles () const =0
 For WallModels that control the timestep, calculate the.
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.

Static Public Member Functions

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

Detailed Description

template<class CloudType>
class Foam::WallModel< CloudType >

Templated wall interaction class.

Source files

Definition at line 51 of file WallModel.H.

Constructor & Destructor Documentation

◆ WallModel()

template<class CloudType>
WallModel ( const dictionary & dict,
CloudType & owner,
const word & type )

Construct from components.

Definition at line 26 of file WallModel.C.

References dict(), and owner().

Referenced by declareRunTimeSelectionTable(), WallLocalSpringSliderDashpot< CloudType >::WallLocalSpringSliderDashpot(), and WallSpringSliderDashpot< CloudType >::WallSpringSliderDashpot().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ~WallModel()

template<class CloudType>
~WallModel ( )
virtual

Destructor.

Definition at line 42 of file WallModel.C.

Member Function Documentation

◆ TypeName()

template<class CloudType>
TypeName ( "wallModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

template<class CloudType>
declareRunTimeSelectionTable ( autoPtr ,
WallModel< CloudType > ,
dictionary ,
(const dictionary &dict, CloudType &owner) ,
(dict, owner)  )

Declare runtime constructor selection table.

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

Here is the call graph for this function:

◆ New()

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

Selector.

Definition at line 28 of file WallModelNew.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 50 of file WallModel.C.

Referenced by declareRunTimeSelectionTable(), New(), WallLocalSpringSliderDashpot< CloudType >::nSubCycles(), WallSpringSliderDashpot< CloudType >::nSubCycles(), WallLocalSpringSliderDashpot< CloudType >::WallLocalSpringSliderDashpot(), WallModel(), and WallSpringSliderDashpot< CloudType >::WallSpringSliderDashpot().

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 58 of file WallModel.C.

◆ dict()

template<class CloudType>
const Foam::dictionary & dict ( ) const

Return the dictionary.

Definition at line 65 of file WallModel.C.

Referenced by declareRunTimeSelectionTable(), New(), WallLocalSpringSliderDashpot< CloudType >::TypeName(), WallSpringSliderDashpot< CloudType >::TypeName(), WallLocalSpringSliderDashpot< CloudType >::WallLocalSpringSliderDashpot(), WallModel(), and WallSpringSliderDashpot< CloudType >::WallSpringSliderDashpot().

Here is the caller graph for this function:

◆ coeffDict()

template<class CloudType>
const Foam::dictionary & coeffDict ( ) const

Return the coefficients dictionary.

Definition at line 73 of file WallModel.C.

Referenced by WallLocalSpringSliderDashpot< CloudType >::WallLocalSpringSliderDashpot(), and WallSpringSliderDashpot< CloudType >::WallSpringSliderDashpot().

Here is the caller graph for this function:

◆ pREff()

template<class CloudType>
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 >.

References p.

◆ controlsTimestep()

template<class CloudType>
virtual bool controlsTimestep ( ) const
pure virtual

Whether the WallModel has a timestep limit that will.

require subCycling

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

◆ nSubCycles()

template<class CloudType>
virtual label nSubCycles ( ) const
pure virtual

For WallModels that control the timestep, calculate the.

number of subCycles needed to satisfy the minimum allowable timestep

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

◆ evaluateWall()

template<class CloudType>
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 >.

References p.

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