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

An abstract base class for incompressible mixtureViscosityModels. More...

Inheritance diagram for mixtureViscosityModel:
[legend]
Collaboration diagram for mixtureViscosityModel:
[legend]

Public Member Functions

 TypeName ("mixtureViscosityModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, mixtureViscosityModel, dictionary,(const word &name, const dictionary &viscosityProperties, const volVectorField &U, const surfaceScalarField &phi),(name, viscosityProperties, U, phi))
 
 mixtureViscosityModel (const word &name, const dictionary &viscosityProperties, const volVectorField &U, const surfaceScalarField &phi)
 Construct from components. More...
 
virtual ~mixtureViscosityModel ()=default
 Destructor. More...
 
const dictionary & viscosityProperties () const
 Return the phase transport properties dictionary. More...
 
virtual tmp< volScalarField > mu (const volScalarField &muc) const =0
 Return the mixture viscosity. More...
 
virtual bool read (const dictionary &viscosityProperties)=0
 Read transportProperties dictionary. More...
 

Static Public Member Functions

static autoPtr< mixtureViscosityModel > New (const word &name, const dictionary &viscosityProperties, const volVectorField &U, const surfaceScalarField &phi)
 Return a reference to the selected viscosity model. More...
 

Protected Member Functions

 mixtureViscosityModel (const mixtureViscosityModel &)=delete
 No copy construct. More...
 
void operator= (const mixtureViscosityModel &)=delete
 No copy assignment. More...
 

Protected Attributes

word name_
 
dictionary viscosityProperties_
 
const volVectorField & U_
 
const surfaceScalarField & phi_
 

Detailed Description

An abstract base class for incompressible mixtureViscosityModels.

Source files

Definition at line 62 of file mixtureViscosityModel.H.

Constructor & Destructor Documentation

◆ mixtureViscosityModel() [1/2]

mixtureViscosityModel ( const mixtureViscosityModel &  )
protecteddelete

No copy construct.

◆ mixtureViscosityModel() [2/2]

mixtureViscosityModel ( const word &  name,
const dictionary &  viscosityProperties,
const volVectorField &  U,
const surfaceScalarField &  phi 
)

Construct from components.

◆ ~mixtureViscosityModel()

virtual ~mixtureViscosityModel ( )
virtualdefault

Destructor.

Member Function Documentation

◆ operator=()

void operator= ( const mixtureViscosityModel &  )
protecteddelete

No copy assignment.

◆ TypeName()

TypeName ( "mixtureViscosityModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
mixtureViscosityModel  ,
dictionary  ,
(const word &name, const dictionary &viscosityProperties, const volVectorField &U, const surfaceScalarField &phi)  ,
(name, viscosityProperties, U, phi)   
)

◆ New()

static autoPtr<mixtureViscosityModel> New ( const word &  name,
const dictionary &  viscosityProperties,
const volVectorField &  U,
const surfaceScalarField &  phi 
)
static

Return a reference to the selected viscosity model.

◆ viscosityProperties()

const dictionary& viscosityProperties ( ) const
inline

Return the phase transport properties dictionary.

Definition at line 139 of file mixtureViscosityModel.H.

References mixtureViscosityModel::viscosityProperties_.

◆ mu()

virtual tmp<volScalarField> mu ( const volScalarField &  muc) const
pure virtual

Return the mixture viscosity.

given the viscosity of the continuous phase

Implemented in plastic, slurry, and BinghamPlastic.

◆ read()

virtual bool read ( const dictionary &  viscosityProperties)
pure virtual

Read transportProperties dictionary.

Implemented in plastic, slurry, and BinghamPlastic.

Member Data Documentation

◆ name_

word name_
protected

Definition at line 69 of file mixtureViscosityModel.H.

◆ viscosityProperties_

dictionary viscosityProperties_
protected

Definition at line 70 of file mixtureViscosityModel.H.

Referenced by mixtureViscosityModel::viscosityProperties().

◆ U_

const volVectorField& U_
protected

Definition at line 72 of file mixtureViscosityModel.H.

◆ phi_

const surfaceScalarField& phi_
protected

Definition at line 73 of file mixtureViscosityModel.H.

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