accelerationSource Class Reference

This fvModel applies an explicit acceleration force to components of the velocity field. More...

Inheritance diagram for accelerationSource:

Collaboration diagram for accelerationSource:

Public Member Functions
	TypeName ("accelerationSource")
	Runtime type information. More...
	accelerationSource (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components. More...
virtual	~accelerationSource ()
	Destructor. More...
virtual wordList	addSupFields () const
	Return the list of fields for which the fvModel adds source term. More...
virtual void	addSup (fvMatrix< vector > &eqn, const word &fieldName) const
	Source term to momentum equation. More...
virtual void	addSup (const volScalarField &rho, fvMatrix< vector > &eqn, const word &fieldName) const
	Source term to compressible momentum equation. More...
virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< vector > &eqn, const word &fieldName) const
	Source term to phase momentum equation. More...
virtual void	updateMesh (const mapPolyMesh &)
	Update for mesh changes. 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 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

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...
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...

Detailed Description

This fvModel applies an explicit acceleration force to components of the velocity field.

Usage

Example usage:

accelerationSource1
{
    type            accelerationSource;

    selectionMode   all;

    U               U;

    velocity        scale;
    value           (-2.572 0 0);
    scale
    {
        type            halfCosineRamp;
        start           0;
        duration        10;
    }
}

Source files

• accelerationSource.H
• accelerationSource.C

Definition at line 75 of file accelerationSource.H.

Constructor & Destructor Documentation

accelerationSource()

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

Construct from components.

Definition at line 57 of file accelerationSource.C.

~accelerationSource()

virtual ~accelerationSource ( )

inlinevirtual

Destructor.

Definition at line 125 of file accelerationSource.H.

References accelerationSource::addSup(), accelerationSource::addSupFields(), alpha(), accelerationSource::read(), and accelerationSource::updateMesh().

Here is the call graph for this function:

Member Function Documentation

TypeName()

TypeName

(

"accelerationSource"

)

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 75 of file accelerationSource.C.

References accelerationSource::addSup().

Referenced by accelerationSource::~accelerationSource().

Here is the call graph for this function:

Here is the caller graph for this function:

addSup() [1/3]

void addSup ( fvMatrix< vector > &  eqn, const word &  fieldName  ) const

virtual

Source term to momentum equation.

Definition at line 82 of file accelerationSource.C.

References Foam::add().

Referenced by accelerationSource::addSup(), accelerationSource::addSupFields(), and accelerationSource::~accelerationSource().

Here is the call graph for this function:

Here is the caller graph for this function:

addSup() [2/3]

void addSup ( const volScalarField &  rho, fvMatrix< vector > &  eqn, const word &  fieldName  ) const

virtual

Source term to compressible momentum equation.

Definition at line 92 of file accelerationSource.C.

References Foam::add(), and accelerationSource::addSup().

Here is the call graph for this function:

addSup() [3/3]

void addSup ( const volScalarField &  alpha, const volScalarField &  rho, fvMatrix< vector > &  eqn, const word &  fieldName  ) const

virtual

Source term to phase momentum equation.

Definition at line 103 of file accelerationSource.C.

References Foam::add().

Here is the call graph for this function:

updateMesh()

void updateMesh ( const mapPolyMesh &  mpm )

virtual

Update for mesh changes.

Reimplemented from fvModel.

Definition at line 114 of file accelerationSource.C.

Referenced by accelerationSource::~accelerationSource().

Here is the caller graph for this function:

read()

bool read ( const dictionary &  dict )

virtual

Read dictionary.

Reimplemented from fvModel.

Definition at line 120 of file accelerationSource.C.

References fvModel::read().

Referenced by accelerationSource::~accelerationSource().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• src/fvModels/derived/accelerationSource/accelerationSource.H
• src/fvModels/derived/accelerationSource/accelerationSource.C
• src/fvModels/derived/accelerationSource/accelerationSourceTemplates.C