damping Class Reference

Base fvModel for damping functions. More...

Inheritance diagram for damping:

Collaboration diagram for damping:

Public Member Functions
	TypeName ("damping")
	Runtime type information. More...
	damping (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components. More...
virtual	~damping ()
	Destructor. More...
virtual wordList	addSupFields () const
	Return the list of fields for which the fvModel adds source term. More...
virtual bool	read (const dictionary &dict)
	Read dictionary. More...
Public Member Functions inherited from fvModel
	TypeName ("fvModel")
	Runtime type information. More...
	declareRunTimeSelectionTable (autoPtr, fvModel, dictionary,(const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh),(name, modelType, dict, mesh))
	fvModel (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components. More...
autoPtr< fvModel >	clone () const
	Return clone. More...
virtual	~fvModel ()
	Destructor. More...
const word &	name () const
	Return const access to the source name. More...
const fvMesh &	mesh () const
	Return const access to the mesh database. More...
const dictionary &	coeffs () const
	Return dictionary. More...
virtual bool	addsSupToField (const word &fieldName) const
	Return true if the fvModel adds a source term to the given. More...
	FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_SUP)
	Add a source term to an equation. More...
	FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_RHO_SUP)
	Add a source term to a compressible equation. More...
	FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_ALPHA_RHO_SUP)
	Add a source term to a phase equation. More...
template<class Type >
tmp< fvMatrix< Type > >	source (const GeometricField< Type, fvPatchField, volMesh > &field) const
	Return source for an equation. More...
template<class Type >
tmp< fvMatrix< Type > >	source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const
	Return source for an equation with a specified name. More...
template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field) const
	Return source for a compressible equation. More...
template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const
	Return source for a compressible equation with a specified name. More...
template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field) const
	Return source for a phase equation. More...
template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const
	Return source for a phase equation with a specified name. More...
virtual void	preUpdateMesh ()
	Prepare for mesh update. More...
virtual void	updateMesh (const mapPolyMesh &)
	Update for mesh changes. More...
virtual bool	movePoints ()
	Update for mesh motion. More...
virtual void	correct ()
	Correct the fvModel. More...
template<class Type , class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
Foam::dimensionSet	sourceDims (const GeometricField< Type, fvPatchField, volMesh > &field, const dimensionSet &ds, const AlphaRhoFieldType &alphaRho, const AlphaRhoFieldTypes &... alphaRhos)
template<class Type >
Foam::dimensionSet	sourceDims (const GeometricField< Type, fvPatchField, volMesh > &field, const dimensionSet &ds)
template<class Type , class ... AlphaRhoFieldTypes>
Foam::tmp< Foam::fvMatrix< Type > >	source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhos) const
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const GeometricField< Type, fvPatchField, volMesh > &field) const
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field) const
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field) const
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const

Protected Member Functions
void	readCoeffs ()
	Non-virtual read. More...
tmp< volScalarField::Internal >	forceCoeff () const
	Return the force coefficient. More...
Protected Member Functions inherited from fvModel
template<class Type >
void	addSupType (fvMatrix< Type > &eqn, const word &fieldName) const
	Add a source term to an equation. More...
template<class Type >
void	addSupType (const volScalarField &rho, fvMatrix< Type > &eqn, const word &fieldName) const
	Add a source term to a compressible equation. More...
template<class Type >
void	addSupType (const volScalarField &alpha, const volScalarField &rho, fvMatrix< Type > &eqn, const word &fieldName) const
	Add a source term to a phase equation. More...
template<class Type , class ... AlphaRhoFieldTypes>
tmp< fvMatrix< Type > >	source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhos) const
	Return source for equation with specified name and dimensions. More...

Protected Attributes
word	UName_
	Name of the velocity field. More...
dimensionedScalar	lambda_
	Damping coefficient [1/s]. More...
autoPtr< Function1< scalar > >	scale_
	The scaling function. More...
vectorField	origins_
	Origins of the scaling coordinate. More...
vectorField	directions_
	Directions of increasing scaling coordinate. More...

Additional Inherited Members
Static Public Member Functions inherited from fvModel
template<class Type , class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static dimensionSet	sourceDims (const GeometricField< Type, fvPatchField, volMesh > &field, const dimensionSet &ds, const AlphaRhoFieldType &alphaRho, const AlphaRhoFieldTypes &... alphaRhos)
	Return the dimensions of the matrix of a source term. More...
template<class Type >
static dimensionSet	sourceDims (const GeometricField< Type, fvPatchField, volMesh > &field, const dimensionSet &ds)
	Return the dimensions of the matrix of a source term (base. More...
static autoPtr< fvModel >	New (const word &name, const dictionary &dict, const fvMesh &mesh)
	Return a reference to the selected fvModel. More...

Detailed Description

Base fvModel for damping functions.

See also

Foam::fv::isotropicDamping Foam::fv::verticalDamping

Source files

• damping.H
• damping.C

Definition at line 56 of file damping.H.

Constructor & Destructor Documentation

damping()

damping	(	const word &	name,
		const word &	modelType,
		const dictionary &	dict,
		const fvMesh &	mesh
	)

Construct from components.

Definition at line 175 of file damping.C.

Referenced by damping::forceCoeff().

Here is the caller graph for this function:

~damping()

virtual ~damping ( )

inlinevirtual

Destructor.

Definition at line 108 of file damping.H.

References damping::addSupFields(), dict, and damping::read().

Here is the call graph for this function:

Member Function Documentation

readCoeffs()

void readCoeffs ( )

protected

Non-virtual read.

Definition at line 43 of file damping.C.

References autoPtr< T >::clear(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::mag(), Function1< Type >::New(), and WarningInFunction.

Here is the call graph for this function:

forceCoeff()

Foam::tmp< Foam::volScalarField::Internal > forceCoeff ( ) const

protected

Return the force coefficient.

Definition at line 121 of file damping.C.

References Foam::constant::universal::c, damping::damping(), forAll, Foam::max(), mesh, GeometricField< Type, PatchField, GeoMesh >::primitiveFieldRef(), timeName, Foam::type(), and x.

Here is the call graph for this function:

TypeName()

TypeName

(

"damping"

)

Runtime type information.

addSupFields()

Foam::wordList addSupFields ( ) const

virtual

Return the list of fields for which the fvModel adds source term.

to the transport equation

Reimplemented from fvModel.

Definition at line 195 of file damping.C.

Referenced by damping::~damping().

Here is the caller graph for this function:

read()

bool read ( const dictionary &  dict )

virtual

Read dictionary.

Reimplemented from fvModel.

Reimplemented in isotropicDamping.

Definition at line 201 of file damping.C.

References fvModel::read().

Referenced by isotropicDamping::read(), and damping::~damping().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

UName_

word UName_

protected

Name of the velocity field.

Definition at line 65 of file damping.H.

lambda_

dimensionedScalar lambda_

protected

Damping coefficient [1/s].

Definition at line 68 of file damping.H.

scale_

autoPtr<Function1<scalar> > scale_

protected

The scaling function.

Definition at line 71 of file damping.H.

origins_

vectorField origins_

protected

Origins of the scaling coordinate.

Definition at line 74 of file damping.H.

directions_

vectorField directions_

protected

Directions of increasing scaling coordinate.

Definition at line 77 of file damping.H.

---

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

• src/fvModels/derived/damping/damping/damping.H
• src/fvModels/derived/damping/damping/damping.C