Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
wallDampingModel Class Referenceabstract

Wall damping models can be used to filter interfacial models near the walls. This is particularly useful for the lift force because of its dependence on the velocity gradient. More...

Inheritance diagram for wallDampingModel:
Inheritance graph
[legend]
Collaboration diagram for wallDampingModel:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("wallDampingModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, wallDampingModel, dictionary,(const dictionary &dict, const phaseInterface &interface),(dict, interface))
 
 wallDampingModel (const dictionary &dict, const phaseInterface &interface)
 Construct from a dictionary and an interface. More...
 
virtual ~wallDampingModel ()
 Destructor. More...
 
virtual tmp< volScalarField > damping () const
 Return damped coefficient. More...
 
virtual tmp< surfaceScalarField > dampingf () const
 Return damped face coefficient. More...
 
- Public Member Functions inherited from wallDependentModel
 wallDependentModel (const fvMesh &mesh)
 Construct from a mesh. More...
 
 wallDependentModel (const wallDependentModel &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~wallDependentModel ()
 Destructor. More...
 
const volScalarField & yWall () const
 Return the wall distance, creating and storing it if necessary. More...
 
const volVectorField & nWall () const
 Return the wall normal, creating and storing it if necessary. More...
 
void operator= (const wallDependentModel &)=delete
 Disallow default bitwise assignment. More...
 

Static Public Member Functions

static autoPtr< wallDampingModel > New (const dictionary &dict, const phaseInterface &interface)
 

Protected Member Functions

virtual tmp< volScalarField > limiter () const =0
 Return the force limiter field. More...
 

Protected Attributes

const dispersedPhaseInterface interface_
 Interface. More...
 
const dimensionedScalar Cd_
 Diameter coefficient. More...
 
const dimensionedScalar zeroWallDist_
 Distance from wall below which the field is damped to zero. More...
 
const Switch zeroInNearWallCells_
 Set the value to zero in wall-adjacent cells. More...
 

Detailed Description

Wall damping models can be used to filter interfacial models near the walls. This is particularly useful for the lift force because of its dependence on the velocity gradient.

All damping functions accept the following parameters:

  • Cd: A coefficient for filtering the distance from the wall based on the dispersed phase diameter. This can be useful to correct gradient sampling error when the dispersed phase diameter is significantly larger than near wall mesh resolution.
  • zeroWallDist: A constant offset from the wall for the zero point of the damping function. Below this distance, the damping will reduce the value to zero.
  • zeroInNearWallCells: A switch which sets the value to zero in near wall cells regardless of the other parameters. This is recommended to be set if a lift force is applied together with turbulent wall functions.
Usage
Property Description Required Default value
Cd Diameter coefficient yes none
zeroWallDist Offset from wall no 0
zeroInNearWallCells Zero near wall cells no no
Source files

Definition at line 96 of file wallDampingModel.H.

Constructor & Destructor Documentation

◆ wallDampingModel()

wallDampingModel ( const dictionary &  dict,
const phaseInterface &  interface 
)

Construct from a dictionary and an interface.

Definition at line 41 of file wallDampingModel.C.

◆ ~wallDampingModel()

~wallDampingModel ( )
virtual

Destructor.

Definition at line 72 of file wallDampingModel.C.

Member Function Documentation

◆ limiter()

virtual tmp<volScalarField> limiter ( ) const
protectedpure virtual

Return the force limiter field.

Implemented in sine, linear, and cosine.

◆ TypeName()

TypeName ( "wallDampingModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
wallDampingModel  ,
dictionary  ,
(const dictionary &dict, const phaseInterface &interface)  ,
(dict, interface)   
)

◆ New()

Foam::autoPtr< Foam::wallDampingModel > New ( const dictionary &  dict,
const phaseInterface &  interface 
)
static

Definition at line 30 of file wallDampingModelNew.C.

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

Here is the call graph for this function:

◆ damping()

Foam::tmp< Foam::volScalarField > damping ( ) const
virtual

Return damped coefficient.

Definition at line 79 of file wallDampingModel.C.

References bMesh, forAll, Foam::MULES::limiter(), patchi, and tmp< T >::ref().

Here is the call graph for this function:

◆ dampingf()

Foam::tmp< Foam::surfaceScalarField > dampingf ( ) const
virtual

Return damped face coefficient.

Definition at line 112 of file wallDampingModel.C.

References Foam::fvc::interpolate().

Here is the call graph for this function:

Member Data Documentation

◆ interface_

const dispersedPhaseInterface interface_
protected

Interface.

Definition at line 105 of file wallDampingModel.H.

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

◆ Cd_

const dimensionedScalar Cd_
protected

Diameter coefficient.

Definition at line 108 of file wallDampingModel.H.

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

◆ zeroWallDist_

const dimensionedScalar zeroWallDist_
protected

Distance from wall below which the field is damped to zero.

Definition at line 111 of file wallDampingModel.H.

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

◆ zeroInNearWallCells_

const Switch zeroInNearWallCells_
protected

Set the value to zero in wall-adjacent cells.

Definition at line 114 of file wallDampingModel.H.

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