Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
wallDampingModel Class Referenceabstract
Inheritance diagram for wallDampingModel:
[legend]
Collaboration diagram for wallDampingModel:
[legend]

Public Member Functions

 TypeName ("wallDampingModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, wallDampingModel, dictionary,(const dictionary &dict, const phasePair &pair),(dict, pair))
 
 wallDampingModel (const dictionary &dict, const phasePair &pair)
 Construct from components. More...
 
virtual ~wallDampingModel ()=default
 Destructor. More...
 
virtual tmp< volScalarField > damp (const tmp< volScalarField > &) const =0
 Return damped coefficient. More...
 
virtual tmp< volVectorField > damp (const tmp< volVectorField > &) const =0
 Return damped force. More...
 
virtual tmp< surfaceScalarField > damp (const tmp< surfaceScalarField > &) const =0
 Return damped face force. More...
 
- Public Member Functions inherited from wallDependentModel
 wallDependentModel (const fvMesh &mesh)
 Construct from a mesh. More...
 
virtual ~wallDependentModel ()
 Destructor. More...
 
const volScalarField & yWall () const
 
const volVectorField & nWall () const
 
 wallDependentModel (const fvMesh &mesh)
 Construct from a mesh. More...
 
virtual ~wallDependentModel ()
 Destructor. More...
 
const volScalarField & yWall () const
 
const volVectorField & nWall () const
 

Static Public Member Functions

static autoPtr< wallDampingModel > New (const dictionary &dict, const phasePair &pair)
 

Static Public Attributes

static const dimensionSet dimF
 Coefficient dimensions. More...
 

Protected Attributes

const phasePair & pair_
 Phase pair. More...
 

Detailed Description

Source files

Definition at line 56 of file wallDampingModel.H.

Constructor & Destructor Documentation

◆ wallDampingModel()

wallDampingModel ( const dictionary &  dict,
const phasePair &  pair 
)

Construct from components.

Definition at line 46 of file wallDampingModel.C.

◆ ~wallDampingModel()

virtual ~wallDampingModel ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "wallDampingModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
wallDampingModel  ,
dictionary  ,
(const dictionary &dict, const phasePair &pair)  ,
(dict, pair)   
)

◆ New()

Foam::autoPtr< Foam::wallDampingModel > New ( const dictionary &  dict,
const phasePair &  pair 
)
static

Definition at line 60 of file wallDampingModel.C.

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

Here is the call graph for this function:

◆ damp() [1/3]

virtual tmp<volScalarField> damp ( const tmp< volScalarField > &  ) const
pure virtual

Return damped coefficient.

Implemented in interpolated, and noWallDamping.

◆ damp() [2/3]

virtual tmp<volVectorField> damp ( const tmp< volVectorField > &  ) const
pure virtual

Return damped force.

Implemented in interpolated, and noWallDamping.

◆ damp() [3/3]

virtual tmp<surfaceScalarField> damp ( const tmp< surfaceScalarField > &  ) const
pure virtual

Return damped face force.

Implemented in interpolated, and noWallDamping.

Member Data Documentation

◆ pair_

const phasePair& pair_
protected

Phase pair.

Definition at line 65 of file wallDampingModel.H.

Referenced by cosine::limiter(), sine::limiter(), and linear::limiter().

◆ dimF

const Foam::dimensionSet dimF
static

Coefficient dimensions.

Definition at line 92 of file wallDampingModel.H.

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