Templated abstract base class for laminar transport models. More...

Inheritance diagram for laminarModel< BasicMomentumTransportModel >:

[legend]

Collaboration diagram for laminarModel< BasicMomentumTransportModel >:

[legend]

Public Types
typedef BasicMomentumTransportModel::alphaField	alphaField

typedef BasicMomentumTransportModel::rhoField	rhoField

Public Member Functions
	TypeName ("laminar")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, laminarModel, dictionary,(const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const viscosity &viscosity),(alpha, rho, U, alphaRhoPhi, phi, viscosity))

	laminarModel (const word &type, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const viscosity &viscosity)
	Construct from components. More...

	laminarModel (const laminarModel &)=delete
	Disallow default bitwise copy construction. More...

virtual	~laminarModel ()
	Destructor. More...

virtual bool	read ()
	Read model coefficients if they have changed. More...

virtual const dictionary &	coeffDict () const
	Const access to the coefficients dictionary. More...

virtual tmp< volScalarField >	nut () const
	Return the turbulence viscosity, i.e. 0 for laminar flow. More...

virtual tmp< scalarField >	nut (const label patchi) const
	Return the turbulence viscosity on patch. More...

virtual tmp< volScalarField >	nuEff () const =0
	Return the effective viscosity, i.e. the laminar viscosity. More...

virtual tmp< scalarField >	nuEff (const label patchi) const =0
	Return the effective viscosity on patch. More...

virtual tmp< volScalarField >	k () const
	Return the turbulence kinetic energy, i.e. 0 for laminar flow. More...

virtual tmp< volScalarField >	epsilon () const
	Return the turbulence kinetic energy dissipation rate,. More...

virtual tmp< volScalarField >	omega () const
	Return the turbulence specific dissipation rate,. More...

virtual tmp< volSymmTensorField >	sigma () const
	Return the stress tensor [m^2/s^2], i.e. 0 for laminar flow. More...

virtual void	predict ()
	Predict the laminar viscosity. More...

virtual void	correct ()
	Predict the laminar viscosity. More...

void	operator= (const laminarModel &)=delete
	Disallow default bitwise assignment. More...

Static Public Member Functions
static autoPtr< laminarModel >	New (const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const viscosity &viscosity)
	Return a reference to the selected laminar model. More...

Protected Member Functions
virtual void	printCoeffs (const word &type)
	Print model coefficients. More...

Protected Attributes
dictionary	laminarDict_
	laminar coefficients dictionary More...

Switch	printCoeffs_
	Flag to print the model coeffs at run-time. More...

dictionary	coeffDict_
	Model coefficients dictionary. More...

Detailed Description

template<class BasicMomentumTransportModel>
class Foam::laminarModel< BasicMomentumTransportModel >

Templated abstract base class for laminar transport models.

Source files

Definition at line 49 of file laminarModel.H.

Member Typedef Documentation

◆ alphaField

typedef BasicMomentumTransportModel::alphaField alphaField

Definition at line 76 of file laminarModel.H.

◆ rhoField

typedef BasicMomentumTransportModel::rhoField rhoField

Definition at line 77 of file laminarModel.H.

Constructor & Destructor Documentation

◆ laminarModel() [1/2]

laminarModel	(	const word &	type,
		const alphaField &	alpha,
		const rhoField &	rho,
		const volVectorField &	U,
		const surfaceScalarField &	alphaRhoPhi,
		const surfaceScalarField &	phi,
		const viscosity &	viscosity
	)

Construct from components.

Definition at line 47 of file laminarModel.C.

◆ laminarModel() [2/2]

laminarModel ( const laminarModel< BasicMomentumTransportModel > & )

delete

Disallow default bitwise copy construction.

◆ ~laminarModel()

virtual ~laminarModel ( )

inlinevirtual

Destructor.

Definition at line 136 of file laminarModel.H.

Member Function Documentation

◆ printCoeffs()

void printCoeffs ( const word & type )

protectedvirtual

Print model coefficients.

Definition at line 32 of file laminarModel.C.

References Foam::endl(), and Foam::Info.

Referenced by Giesekus< BasicMomentumTransportModel >::Giesekus(), Maxwell< BasicMomentumTransportModel >::Maxwell(), and PTT< BasicMomentumTransportModel >::PTT().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "laminar" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		laminarModel< BasicMomentumTransportModel >	,
		dictionary	,
		(const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const viscosity &viscosity)	,
		(alpha, rho, U, alphaRhoPhi, phi, viscosity)
	)

◆ New()

Foam::autoPtr< Foam::laminarModel< BasicMomentumTransportModel > > New	(	const alphaField &	alpha,
		const rhoField &	rho,
		const volVectorField &	U,
		const surfaceScalarField &	alphaRhoPhi,
		const surfaceScalarField &	phi,
		const viscosity &	viscosity
	)

static

Return a reference to the selected laminar model.

Definition at line 83 of file laminarModel.C.

References alpha(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, dictionary::found(), IOobject::group(), Foam::Info, dictionary::lookupBackwardsCompatible(), Foam::nl, momentumTransportModel::readModelDict(), rho, dictionary::subDict(), and U.

Here is the call graph for this function:

◆ read()

bool read

virtual

Read model coefficients if they have changed.

Reimplemented in linearViscousStress< laminarModel< BasicMomentumTransportModel > >, Stokes< BasicMomentumTransportModel >, PTT< BasicMomentumTransportModel >, Maxwell< BasicMomentumTransportModel >, lambdaThixotropic< BasicMomentumTransportModel >, Giesekus< BasicMomentumTransportModel >, and generalisedNewtonian< BasicMomentumTransportModel >.

Definition at line 163 of file laminarModel.C.

References Foam::blockMeshTools::read(), and Foam::type().

Here is the call graph for this function:

◆ coeffDict()

virtual const dictionary& coeffDict ( ) const

inlinevirtual

Const access to the coefficients dictionary.

Reimplemented in Stokes< BasicMomentumTransportModel >.

Definition at line 146 of file laminarModel.H.

References laminarModel< BasicMomentumTransportModel >::coeffDict_.

◆ nut() [1/2]

Foam::tmp< Foam::volScalarField > nut

virtual

Return the turbulence viscosity, i.e. 0 for laminar flow.

Definition at line 182 of file laminarModel.C.

References Foam::dimKinematicViscosity, and GeometricField< Type, PatchField, GeoMesh >::New().

Here is the call graph for this function:

◆ nut() [2/2]

Foam::tmp< Foam::scalarField > nut ( const label patchi ) const

virtual

Return the turbulence viscosity on patch.

Definition at line 195 of file laminarModel.C.

References patchi.

◆ nuEff() [1/2]

virtual tmp<volScalarField> nuEff ( ) const

pure virtual

Return the effective viscosity, i.e. the laminar viscosity.

Implemented in Stokes< BasicMomentumTransportModel >, Maxwell< BasicMomentumTransportModel >, lambdaThixotropic< BasicMomentumTransportModel >, and generalisedNewtonian< BasicMomentumTransportModel >.

◆ nuEff() [2/2]

virtual tmp<scalarField> nuEff ( const label patchi ) const

pure virtual

Return the effective viscosity on patch.

Implemented in Stokes< BasicMomentumTransportModel >, Maxwell< BasicMomentumTransportModel >, lambdaThixotropic< BasicMomentumTransportModel >, and generalisedNewtonian< BasicMomentumTransportModel >.

◆ k()

Foam::tmp< Foam::volScalarField > k

virtual

Return the turbulence kinetic energy, i.e. 0 for laminar flow.

Definition at line 209 of file laminarModel.C.

References Foam::dimVelocity, GeometricField< Type, PatchField, GeoMesh >::New(), and Foam::sqr().

Here is the call graph for this function:

◆ epsilon()

Foam::tmp< Foam::volScalarField > epsilon

virtual

Return the turbulence kinetic energy dissipation rate,.

i.e. 0 for laminar flow

Definition at line 222 of file laminarModel.C.

References Foam::dimTime, Foam::dimVelocity, GeometricField< Type, PatchField, GeoMesh >::New(), and Foam::sqr().

Here is the call graph for this function:

◆ omega()

Foam::tmp< Foam::volScalarField > omega

virtual

Return the turbulence specific dissipation rate,.

i.e. 0 for laminar flow

Definition at line 235 of file laminarModel.C.

References Foam::dimless, Foam::dimTime, and GeometricField< Type, PatchField, GeoMesh >::New().

Here is the call graph for this function:

◆ sigma()

Foam::tmp< Foam::volSymmTensorField > sigma

virtual

Return the stress tensor [m^2/s^2], i.e. 0 for laminar flow.

Reimplemented in Maxwell< BasicMomentumTransportModel >.

Definition at line 248 of file laminarModel.C.

References GeometricField< Type, PatchField, GeoMesh >::New(), Foam::sqr(), and Foam::Zero.

Here is the call graph for this function:

◆ predict()

void predict

virtual

Predict the laminar viscosity.

Reimplemented in Stokes< BasicMomentumTransportModel >, Maxwell< BasicMomentumTransportModel >, lambdaThixotropic< BasicMomentumTransportModel >, and generalisedNewtonian< BasicMomentumTransportModel >.

Definition at line 260 of file laminarModel.C.

Referenced by generalisedNewtonian< BasicMomentumTransportModel >::predict(), and Stokes< BasicMomentumTransportModel >::predict().

Here is the caller graph for this function:

◆ correct()

void correct

virtual

Predict the laminar viscosity.

Reimplemented in linearViscousStress< laminarModel< BasicMomentumTransportModel > >, Stokes< BasicMomentumTransportModel >, Maxwell< BasicMomentumTransportModel >, lambdaThixotropic< BasicMomentumTransportModel >, and generalisedNewtonian< BasicMomentumTransportModel >.

Definition at line 267 of file laminarModel.C.

References Foam::MULES::correct().

Referenced by lambdaThixotropic< BasicMomentumTransportModel >::correct(), and Maxwell< BasicMomentumTransportModel >::correct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

void operator= ( const laminarModel< BasicMomentumTransportModel > & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ laminarDict_

dictionary laminarDict_

protected

laminar coefficients dictionary

Definition at line 59 of file laminarModel.H.

◆ printCoeffs_

Switch printCoeffs_

protected

Flag to print the model coeffs at run-time.

Definition at line 62 of file laminarModel.H.

◆ coeffDict_

dictionary coeffDict_

protected

Model coefficients dictionary.

Definition at line 65 of file laminarModel.H.

Referenced by laminarModel< BasicMomentumTransportModel >::coeffDict().

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

src/MomentumTransportModels/momentumTransportModels/laminar/laminarModel/laminarModel.H
src/MomentumTransportModels/momentumTransportModels/laminar/laminarModel/laminarModel.C

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<class BasicMomentumTransportModel> class Foam::laminarModel< BasicMomentumTransportModel >

Member Typedef Documentation

◆ alphaField

◆ rhoField

Constructor & Destructor Documentation

◆ laminarModel() [1/2]

◆ laminarModel() [2/2]

◆ ~laminarModel()

Member Function Documentation

◆ printCoeffs()

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New()

◆ read()

◆ coeffDict()

◆ nut() [1/2]

◆ nut() [2/2]

◆ nuEff() [1/2]

◆ nuEff() [2/2]

◆ k()

◆ epsilon()

◆ omega()

◆ sigma()

◆ predict()

◆ correct()

◆ operator=()

Member Data Documentation

◆ laminarDict_

◆ printCoeffs_

◆ coeffDict_

template<class BasicMomentumTransportModel>
class Foam::laminarModel< BasicMomentumTransportModel >