FreeFOAM The Cross-Platform CFD Toolkit
viscosityModel Class Reference

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


Detailed Description

+ Inheritance diagram for viscosityModel:
+ Collaboration diagram for viscosityModel:

List of all members.

Public Member Functions

 TypeName ("viscosityModel")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, viscosityModel, dictionary,(const word &name, const dictionary &viscosityProperties, const volVectorField &U, const surfaceScalarField &phi),(name, viscosityProperties, U, phi))
 viscosityModel (const word &name, const dictionary &viscosityProperties, const volVectorField &U, const surfaceScalarField &phi)
 Construct from components.
virtual ~viscosityModel ()
const dictionaryviscosityProperties () const
 Return the phase transport properties dictionary.
tmp< volScalarFieldstrainRate () const
 Return the strain rate mag(grad(U))
virtual tmp< volScalarFieldnu () const =0
 Return the laminar viscosity.
virtual void correct ()=0
 Correct the laminar viscosity.
virtual bool read (const dictionary &viscosityProperties)=0
 Read transportProperties dictionary.

Static Public Member Functions

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

Protected Member Functions

 viscosityModel (const viscosityModel &)
 Disallow copy construct.
void operator= (const viscosityModel &)
 Disallow default bitwise assignment.

Protected Attributes

word name_
dictionary viscosityProperties_
const volVectorFieldU_
const surfaceScalarFieldphi_

Constructor & Destructor Documentation

viscosityModel ( const viscosityModel )
protected

Disallow copy construct.

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

Construct from components.

virtual ~viscosityModel ( )
inlinevirtual

Definition at line 134 of file viscosityModel.H.


Member Function Documentation

void operator= ( const viscosityModel )
protected

Disallow default bitwise assignment.

TypeName ( "viscosityModel"  )

Runtime type information.

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

Return a reference to the selected viscosity model.

const dictionary& viscosityProperties ( ) const
inline

Return the phase transport properties dictionary.

Definition at line 141 of file viscosityModel.H.

References viscosityModel::viscosityProperties_.

Referenced by twoPhaseMixture::read().

Foam::tmp< Foam::volScalarField > strainRate ( ) const

Return the strain rate mag(grad(U))

Definition at line 58 of file viscosityModel.C.

References Foam::fvc::grad(), Foam::mag(), Foam::sqrt(), and Foam::symm().

virtual tmp<volScalarField> nu ( ) const
pure virtual
virtual void correct ( )
pure virtual

Correct the laminar viscosity.

Implemented in BirdCarreau, HerschelBulkley, powerLaw, CrossPowerLaw, and Newtonian.

Referenced by twoPhaseMixture::calcNu(), and singlePhaseTransportModel::correct().

bool read ( const dictionary viscosityProperties)
pure virtual

Read transportProperties dictionary.

Implemented in BirdCarreau, HerschelBulkley, powerLaw, CrossPowerLaw, and Newtonian.

Definition at line 64 of file viscosityModel.C.

Referenced by singlePhaseTransportModel::read(), CrossPowerLaw::read(), HerschelBulkley::read(), powerLaw::read(), and BirdCarreau::read().


Member Data Documentation

word name_
protected

Definition at line 69 of file viscosityModel.H.

dictionary viscosityProperties_
protected

Definition at line 70 of file viscosityModel.H.

Referenced by viscosityModel::viscosityProperties().

const volVectorField& U_
protected

Definition at line 72 of file viscosityModel.H.

const surfaceScalarField& phi_
protected

Definition at line 73 of file viscosityModel.H.


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