wallLubricationModel Class Referenceabstract
Inheritance diagram for wallLubricationModel:
[legend]
Collaboration diagram for wallLubricationModel:
[legend]

Public Member Functions

 TypeName ("wallLubricationModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, wallLubricationModel, dictionary,(const dictionary &dict, const phasePair &pair),(dict, pair))
 
 wallLubricationModel (const dictionary &dict, const phasePair &pair)
 Construct from components. More...
 
virtual ~wallLubricationModel ()=default
 Destructor. More...
 
virtual tmp< volVectorFieldFi () const =0
 Return phase-intensive wall lubrication force. More...
 
virtual tmp< volVectorFieldF () const
 Return wall lubrication force. More...
 
virtual tmp< surfaceScalarFieldFf () const
 Return face wall lubrication force. More...
 
 TypeName ("wallLubricationModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, wallLubricationModel, dictionary,(const dictionary &dict, const phasePair &pair),(dict, pair))
 
 wallLubricationModel (const dictionary &dict, const phasePair &pair)
 Construct from components. More...
 
virtual ~wallLubricationModel ()=default
 Destructor. More...
 
virtual tmp< volVectorFieldFi () const =0
 Return phase-intensive wall lubrication force. More...
 
virtual tmp< volVectorFieldF () const
 Return wall lubrication force. More...
 
virtual tmp< surfaceScalarFieldFf () const
 Return face wall lubrication force. More...
 
- Public Member Functions inherited from wallDependentModel
 wallDependentModel (const fvMesh &mesh)
 Construct from a mesh. More...
 
virtual ~wallDependentModel ()
 Destructor. More...
 
const volScalarFieldyWall () const
 
const volVectorFieldnWall () const
 
 wallDependentModel (const fvMesh &mesh)
 Construct from a mesh. More...
 
virtual ~wallDependentModel ()
 Destructor. More...
 
const volScalarFieldyWall () const
 
const volVectorFieldnWall () const
 

Static Public Member Functions

static autoPtr< wallLubricationModelNew (const dictionary &dict, const phasePair &pair)
 
static autoPtr< wallLubricationModelNew (const dictionary &dict, const phasePair &pair)
 

Static Public Attributes

static const dimensionSet dimF
 Coefficient dimensions. More...
 

Protected Member Functions

tmp< volVectorFieldzeroGradWalls (tmp< volVectorField >) const
 Zero-gradient wall-lubrication force at walls. More...
 

Protected Attributes

const phasePairpair_
 Phase pair. More...
 

Detailed Description

Constructor & Destructor Documentation

◆ wallLubricationModel() [1/2]

wallLubricationModel ( const dictionary dict,
const phasePair pair 
)

Construct from components.

Definition at line 75 of file wallLubricationModel.C.

◆ ~wallLubricationModel() [1/2]

virtual ~wallLubricationModel ( )
virtualdefault

Destructor.

◆ wallLubricationModel() [2/2]

wallLubricationModel ( const dictionary dict,
const phasePair pair 
)

Construct from components.

◆ ~wallLubricationModel() [2/2]

virtual ~wallLubricationModel ( )
virtualdefault

Destructor.

Member Function Documentation

◆ zeroGradWalls()

Foam::tmp< Foam::volVectorField > zeroGradWalls ( tmp< volVectorField tFi) const
protected

Zero-gradient wall-lubrication force at walls.

Definition at line 50 of file wallLubricationModel.C.

References wallLubricationModel::Fi(), forAll, patches, fvPatchField< Type >::patchInternalField(), and tmp< T >::ref().

Here is the call graph for this function:

◆ TypeName() [1/2]

TypeName ( "wallLubricationModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/2]

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

◆ New() [1/2]

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

Definition at line 89 of file wallLubricationModel.C.

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

Here is the call graph for this function:

◆ Fi() [1/2]

virtual tmp< volVectorField > Fi ( ) const
pure virtual

Return phase-intensive wall lubrication force.

Implemented in Antal, Frank, noWallLubrication, TomiyamaWallLubrication, Antal, Frank, noWallLubrication, and TomiyamaWallLubrication.

Referenced by wallLubricationModel::zeroGradWalls().

Here is the caller graph for this function:

◆ F() [1/2]

Foam::tmp< Foam::volVectorField > F ( ) const
virtual

Return wall lubrication force.

Reimplemented in noWallLubrication, and noWallLubrication.

Definition at line 119 of file wallLubricationModel.C.

◆ Ff() [1/2]

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

Return face wall lubrication force.

Definition at line 125 of file wallLubricationModel.C.

References Foam::fvc::flux(), and Foam::fvc::interpolate().

Here is the call graph for this function:

◆ TypeName() [2/2]

TypeName ( "wallLubricationModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable() [2/2]

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

◆ New() [2/2]

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

◆ Fi() [2/2]

virtual tmp< volVectorField > Fi ( ) const
pure virtual

Return phase-intensive wall lubrication force.

Implemented in Antal, Frank, noWallLubrication, TomiyamaWallLubrication, Antal, Frank, noWallLubrication, and TomiyamaWallLubrication.

◆ F() [2/2]

virtual tmp< volVectorField > F ( ) const
virtual

Return wall lubrication force.

Reimplemented in noWallLubrication, and noWallLubrication.

◆ Ff() [2/2]

virtual tmp< surfaceScalarField > Ff ( ) const
virtual

Return face wall lubrication force.

Member Data Documentation

◆ pair_

const phasePair & pair_
protected

Phase pair.

Definition at line 65 of file wallLubricationModel.H.

◆ dimF

static const dimensionSet dimF
static

Coefficient dimensions.

Definition at line 98 of file wallLubricationModel.H.


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