Base class for film turbulence models. More...

Inheritance diagram for filmTurbulenceModel:

Collaboration diagram for filmTurbulenceModel:

Public Types
enum	frictionMethodType { mquadraticProfile , mlinearProfile , mDarcyWeisbach , mManningStrickler }
	Options for the friction models. More...

enum	shearMethodType { msimple , mwallFunction }
	Options for the shear stress models. More...

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

	declareRunTimeSelectionTable (autoPtr, filmTurbulenceModel, dictionary,(liquidFilmBase &film, const dictionary &dict),(film, dict))

	filmTurbulenceModel (const word &modelType, liquidFilmBase &film, const dictionary &dict)
	Construct from type name, dictionary and surface film model. More...

virtual	~filmTurbulenceModel ()=default
	Destructor. More...

const liquidFilmBase &	film () const
	Return film. More...

tmp< volSymmTensorField >	devRhoReff () const
	Return the effective viscous stress (laminar + turbulent) More...

tmp< faVectorMatrix >	primaryRegionFriction (areaVectorField &U) const
	Return primary region friction. More...

tmp< volScalarField >	rho () const
	Return rho if specified otherwise rhoRef. More...

virtual tmp< areaScalarField >	Cw () const
	Return the wall film surface friction. More...

virtual tmp< areaScalarField >	mut () const =0
	Return the film turbulence viscosity. More...

virtual void	correct ()=0
	Correct/update the model. More...

virtual tmp< faVectorMatrix >	Su (areaVectorField &U) const =0
	Return the source for the film momentum equation. More...

Static Public Member Functions
static autoPtr< filmTurbulenceModel >	New (liquidFilmBase &film, const dictionary &dict)
	Return a reference to the selected injection model. More...

Protected Attributes
const liquidFilmBase &	film_
	Reference to liquidFilmBase. More...

const dictionary	dict_
	Model dictionary. More...

const frictionMethodType	method_
	Method used. More...

const shearMethodType	shearMethod_
	Shear method used. More...

word	rhoName_
	Name of density field (optional) More...

scalar	rhoRef_
	Reference density needed for incompressible calculations. More...

Static Protected Attributes
static const Enum< frictionMethodType >	frictionMethodTypeNames_
	Names for friction models. More...

static const Enum< shearMethodType >	shearMethodTypeNames_
	Names for shear stress models. More...

Detailed Description

Base class for film turbulence models.

Source files

Definition at line 60 of file filmTurbulenceModel.H.

Member Enumeration Documentation

◆ frictionMethodType

enum frictionMethodType

Options for the friction models.

Enumerator
mquadraticProfile
mlinearProfile
mDarcyWeisbach
mManningStrickler

Definition at line 76 of file filmTurbulenceModel.H.

◆ shearMethodType

enum shearMethodType

Options for the shear stress models.

Enumerator
msimple
mwallFunction

Definition at line 85 of file filmTurbulenceModel.H.

Constructor & Destructor Documentation

◆ filmTurbulenceModel()

filmTurbulenceModel	(	const word &	modelType,
		liquidFilmBase &	film,
		const dictionary &	dict
	)

Construct from type name, dictionary and surface film model.

Definition at line 73 of file filmTurbulenceModel.C.

References filmTurbulenceModel::dict_, dictionary::get(), filmTurbulenceModel::rhoName_, and filmTurbulenceModel::rhoRef_.

Here is the call graph for this function:

◆ ~filmTurbulenceModel()

virtual ~filmTurbulenceModel ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "filmTurbulenceModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		filmTurbulenceModel	,
		dictionary	,
		(liquidFilmBase &film, const dictionary &dict)	,
		(film, dict)
	)

◆ New()

autoPtr< filmTurbulenceModel > New	(	liquidFilmBase &	film,
		const dictionary &	dict
	)

static

Return a reference to the selected injection model.

Definition at line 41 of file filmTurbulenceModelNew.C.

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

Here is the call graph for this function:

◆ film()

const liquidFilmBase & film ( ) const

Return film.

Definition at line 96 of file filmTurbulenceModel.C.

References filmTurbulenceModel::film_.

Referenced by laminar::mut().

Here is the caller graph for this function:

◆ devRhoReff()

tmp< Foam::volSymmTensorField > devRhoReff ( ) const

Return the effective viscous stress (laminar + turbulent)

Definition at line 275 of file filmTurbulenceModel.C.

References Foam::dev(), basicThermo::dictName, Foam::dimViscosity, Foam::exit(), Foam::FatalError, FatalErrorInFunction, filmTurbulenceModel::film_, objectRegistry::foundObject(), Foam::fvc::grad(), objectRegistry::lookupObject(), nu, GeometricField< symmTensor, fvPatchField, volMesh >::null(), regionFaModel::primaryMesh(), filmTurbulenceModel::rho(), transportProperties(), turb, Foam::twoSymm(), U, and liquidFilmBase::UName().

Referenced by filmTurbulenceModel::primaryRegionFriction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ primaryRegionFriction()

tmp< faVectorMatrix > primaryRegionFriction ( areaVectorField & U ) const

Return primary region friction.

Definition at line 192 of file filmTurbulenceModel.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), filmTurbulenceModel::devRhoReff(), filmTurbulenceModel::dict_, Foam::dimLength, Foam::dimVelocity, faMesh::faceAreaNormals(), filmTurbulenceModel::film_, dictionary::get(), GeometricField< Type, PatchField, GeoMesh >::internalField(), volSurfaceMapping::mapToSurface(), filmTurbulenceModel::msimple, filmTurbulenceModel::mwallFunction, Time::New(), regionFaModel::patchID(), regionFaModel::primaryMesh(), GeometricField< Type, PatchField, GeoMesh >::primitiveField(), tmp< T >::ref(), regionFaModel::regionMesh(), liquidFilmBase::rho(), faMesh::S(), fvMesh::Sf(), filmTurbulenceModel::shearMethod_, Foam::fam::Sp(), Foam::sqr(), faMesh::time(), fvMesh::time(), Time::timeName(), U, liquidFilmBase::Up(), regionFaModel::vsm(), TimeState::writeTime(), and Foam::Zero.

Referenced by laminar::Su().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rho()

tmp< Foam::volScalarField > rho ( ) const

Return rho if specified otherwise rhoRef.

Definition at line 332 of file filmTurbulenceModel.C.

References Foam::dimDensity, filmTurbulenceModel::film_, objectRegistry::lookupObject(), Time::New(), regionFaModel::primaryMesh(), filmTurbulenceModel::rhoName_, filmTurbulenceModel::rhoRef_, fvMesh::time(), and Time::timeName().

Referenced by filmTurbulenceModel::Cw(), and filmTurbulenceModel::devRhoReff().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Cw()

tmp< areaScalarField > Cw ( ) const

virtual

Return the wall film surface friction.

Definition at line 102 of file filmTurbulenceModel.C.

Referenced by filmTurbulenceModel::Cw(), and laminar::wallFriction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mut()

virtual tmp< areaScalarField > mut ( ) const

pure virtual

Return the film turbulence viscosity.

Implemented in laminar.

◆ correct()

virtual void correct ( )

pure virtual

Correct/update the model.

Implemented in laminar.

◆ Su()

virtual tmp< faVectorMatrix > Su ( areaVectorField & U ) const

pure virtual

Return the source for the film momentum equation.

Implemented in laminar.

Member Data Documentation

◆ film_

const liquidFilmBase& film_

protected

Reference to liquidFilmBase.

Definition at line 97 of file filmTurbulenceModel.H.

Referenced by filmTurbulenceModel::Cw(), filmTurbulenceModel::devRhoReff(), filmTurbulenceModel::film(), filmTurbulenceModel::primaryRegionFriction(), filmTurbulenceModel::rho(), and laminar::wallFriction().

◆ frictionMethodTypeNames_

const Enum< filmTurbulenceModel::frictionMethodType > frictionMethodTypeNames_

staticprotected

Initial value:

{
    { frictionMethodType::mquadraticProfile, "quadraticProfile" },
    { frictionMethodType::mlinearProfile, "linearProfile" },
    { frictionMethodType::mDarcyWeisbach, "DarcyWeisbach" },
    { frictionMethodType::mManningStrickler, "ManningStrickler" }
}

Names for friction models.

Definition at line 100 of file filmTurbulenceModel.H.

Referenced by filmTurbulenceModel::Cw().

◆ shearMethodTypeNames_

const Enum< filmTurbulenceModel::shearMethodType > shearMethodTypeNames_

staticprotected

Initial value:

{
    { shearMethodType::msimple, "simple" },
    { shearMethodType::mwallFunction, "wallFunction" }
}

Names for shear stress models.

Definition at line 103 of file filmTurbulenceModel.H.

◆ dict_

const dictionary dict_

protected

Model dictionary.

Definition at line 106 of file filmTurbulenceModel.H.

Referenced by filmTurbulenceModel::Cw(), filmTurbulenceModel::filmTurbulenceModel(), and filmTurbulenceModel::primaryRegionFriction().

◆ method_

const frictionMethodType method_

protected

Method used.

Definition at line 109 of file filmTurbulenceModel.H.

Referenced by filmTurbulenceModel::Cw().

◆ shearMethod_

const shearMethodType shearMethod_

protected

Shear method used.

Definition at line 112 of file filmTurbulenceModel.H.

Referenced by filmTurbulenceModel::primaryRegionFriction().

◆ rhoName_

word rhoName_

protected

Name of density field (optional)

Definition at line 115 of file filmTurbulenceModel.H.

Referenced by filmTurbulenceModel::filmTurbulenceModel(), and filmTurbulenceModel::rho().

◆ rhoRef_

scalar rhoRef_

protected

Reference density needed for incompressible calculations.

Definition at line 118 of file filmTurbulenceModel.H.

Referenced by filmTurbulenceModel::filmTurbulenceModel(), and filmTurbulenceModel::rho().

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

src/regionFaModels/liquidFilm/subModels/kinematic/filmTurbulenceModel/filmTurbulenceModel/filmTurbulenceModel.H
src/regionFaModels/liquidFilm/subModels/kinematic/filmTurbulenceModel/filmTurbulenceModel/filmTurbulenceModel.C
src/regionFaModels/liquidFilm/subModels/kinematic/filmTurbulenceModel/filmTurbulenceModel/filmTurbulenceModelNew.C

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ frictionMethodType

◆ shearMethodType

Constructor & Destructor Documentation

◆ filmTurbulenceModel()

◆ ~filmTurbulenceModel()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New()

◆ film()

◆ devRhoReff()

◆ primaryRegionFriction()

◆ rho()

◆ Cw()

◆ mut()

◆ correct()

◆ Su()

Member Data Documentation

◆ film_

◆ frictionMethodTypeNames_

◆ shearMethodTypeNames_

◆ dict_

◆ method_

◆ shearMethod_

◆ rhoName_

◆ rhoRef_