forcing Class Reference

Base fvModel for forcing functions. More...

Inheritance diagram for forcing:

Collaboration diagram for forcing:

Public Member Functions
	TypeName ("forcing")
	Runtime type information. More...
	forcing (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
	Construct from components. More...
virtual	~forcing ()
	Destructor. 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 fvMesh &mesh, const dictionary &dict),(name, modelType, mesh, dict))
	fvModel (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
	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 wordList	addSupFields () const
	Return the list of fields for which the fvModel adds source term. More...
virtual bool	addsSupToField (const word &fieldName) const
	Return true if the fvModel adds a source term to the given. More...
virtual scalar	maxDeltaT () const
	Return the maximum time-step for stable operation. 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 VolField< Type > &field) const
	Return source for an equation. More...
template<class Type >
tmp< fvMatrix< Type > >	source (const VolField< Type > &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 VolField< Type > &field) const
	Return source for a compressible equation. More...
template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &rho, const VolField< Type > &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 VolField< Type > &field) const
	Return source for a phase equation. More...
template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, const word &fieldName) const
	Return source for a phase equation with a specified name. More...
template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &alpha, const geometricOneField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...
template<class Type >
tmp< fvMatrix< Type > >	source (const geometricOneField &alpha, const volScalarField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...
template<class Type >
tmp< fvMatrix< Type > >	source (const geometricOneField &alpha, const geometricOneField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...
template<class Type >
tmp< fvMatrix< Type > >	d2dt2 (const VolField< Type > &field) const
	Return source for an equation with a second time derivative. More...
template<class Type >
tmp< fvMatrix< Type > >	d2dt2 (const VolField< Type > &field, const word &fieldName) const
	Return source for an equation with a second time derivative. More...
virtual void	preUpdateMesh ()
	Prepare for mesh update. More...
virtual bool	movePoints ()=0
	Update for mesh motion. More...
virtual void	topoChange (const polyTopoChangeMap &)=0
	Update topology using the given map. More...
virtual void	mapMesh (const polyMeshMap &)=0
	Update from another mesh using the given map. More...
virtual void	distribute (const polyDistributionMap &)=0
	Redistribute or update using the given distribution map. More...
virtual void	correct ()
	Correct the fvModel. More...
template<class Type , class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
Foam::dimensionSet	sourceDims (const VolField< Type > &field, const dimensionSet &ds, const AlphaRhoFieldType &alphaRho, const AlphaRhoFieldTypes &... alphaRhos)
template<class Type >
Foam::dimensionSet	sourceDims (const VolField< Type > &field, const dimensionSet &ds)
template<class Type , class ... AlphaRhoFieldTypes>
Foam::tmp< Foam::fvMatrix< Type > >	source (const VolField< Type > &field, const word &fieldName, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhos) const
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const VolField< Type > &field) const
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const VolField< Type > &field, const word &fieldName) const
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &rho, const VolField< Type > &field) const
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &rho, const VolField< Type > &field, const word &fieldName) const
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field) const
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, const word &fieldName) const
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const geometricOneField &alpha, const geometricOneField &rho, const VolField< Type > &field) const
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &alpha, const geometricOneField &rho, const VolField< Type > &field) const
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const geometricOneField &alpha, const volScalarField &rho, const VolField< Type > &field) const
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	d2dt2 (const VolField< Type > &field) const
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	d2dt2 (const VolField< Type > &field, const word &fieldName) const

Protected Member Functions
void	readCoeffs ()
	Non-virtual read. More...
tmp< volScalarField::Internal >	scale () const
	Return the scale distribution. More...
tmp< volScalarField::Internal >	forceCoeff (const volScalarField::Internal &scale) const
	Return the force coefficient given the scale distribution. 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 VolField< Type > &field, const word &fieldName, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhos) const
	Return source for equation with specified name and dimensions. More...

Protected Attributes
dimensionedScalar	lambda_
	Damping coefficient [1/s]. More...
dimensionedScalar	lambdaBoundary_
	Optional boundary 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 VolField< Type > &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 VolField< Type > &field, const dimensionSet &ds)
	Return the dimensions of the matrix of a source term (base. More...
static autoPtr< fvModel >	New (const word &name, const fvMesh &mesh, const dictionary &dict)
	Return a reference to the selected fvModel. More...

Detailed Description

Base fvModel for forcing functions.

See also

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

Source files

• forcing.H
• forcing.C

Definition at line 56 of file forcing.H.

Constructor & Destructor Documentation

forcing()

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

Construct from components.

Definition at line 202 of file forcing.C.

References forcing::readCoeffs().

Here is the call graph for this function:

~forcing()

virtual ~forcing ( )

inlinevirtual

Destructor.

Definition at line 117 of file forcing.H.

Member Function Documentation

readCoeffs()

void readCoeffs ( )

protected

Non-virtual read.

Definition at line 43 of file forcing.C.

References List< T >::clear(), fvModel::coeffs(), dimensioned< Type >::dimensions(), forcing::directions_, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, dictionary::found(), forcing::lambda_, forcing::lambdaBoundary_, UList< T >::last(), dictionary::lookup(), Foam::mag(), dimensioned< Type >::name(), Function1< Type >::New(), forcing::origins_, forcing::scale_, List< T >::setSize(), List< T >::size(), and WarningInFunction.

Referenced by forcing::forcing().

Here is the call graph for this function:

Here is the caller graph for this function:

scale()

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

protected

Return the scale distribution.

Definition at line 127 of file forcing.C.

References Foam::constant::universal::c, Foam::dimless, forAll, Foam::max(), DimensionedField< Type, GeoMesh >::New(), tmp< T >::ref(), Foam::typedName(), and x.

Here is the call graph for this function:

forceCoeff() [1/2]

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

protected

Return the force coefficient given the scale distribution.

Definition at line 158 of file forcing.C.

References forAll, DimensionedField< Type, GeoMesh >::New(), patchi, tmp< T >::ref(), and Foam::typedName().

Here is the call graph for this function:

forceCoeff() [2/2]

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

protected

Return the force coefficient.

Definition at line 194 of file forcing.C.

TypeName()

TypeName

(

"forcing"

)

Runtime type information.

read()

bool read ( const dictionary &  dict )

virtual

Read dictionary.

Reimplemented from fvModel.

Reimplemented in isotropicDamping.

Definition at line 223 of file forcing.C.

References dict, and fvModel::read().

Referenced by isotropicDamping::read().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

lambda_

dimensionedScalar lambda_

protected

Damping coefficient [1/s].

Definition at line 65 of file forcing.H.

Referenced by forcing::readCoeffs().

lambdaBoundary_

dimensionedScalar lambdaBoundary_

protected

Optional boundary damping coefficient [1/s].

Definition at line 68 of file forcing.H.

Referenced by forcing::readCoeffs().

scale_

autoPtr<Function1<scalar> > scale_

protected

The scaling function.

Definition at line 71 of file forcing.H.

Referenced by forcing::readCoeffs().

origins_

vectorField origins_

protected

Origins of the scaling coordinate.

Definition at line 74 of file forcing.H.

Referenced by forcing::readCoeffs().

directions_

vectorField directions_

protected

Directions of increasing scaling coordinate.

Definition at line 77 of file forcing.H.

Referenced by forcing::readCoeffs().

---

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

• src/waves/fvModels/forcing/forcing.H
• src/waves/fvModels/forcing/forcing.C