Base class for sources which are specified as a specific value (e.g., mass flow rate per unit volume), and which apply over the entire mesh. More...

Inheritance diagram for fvSpecificSource:

[legend]

Collaboration diagram for fvSpecificSource:

[legend]

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

	fvSpecificSource (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
	Construct from explicit source name and mesh. More...

virtual	~fvSpecificSource ()
	Destructor. More...

virtual labelUList	cells () const
	Return the cells that the source applies to. More...

virtual label	nCells () const
	Return the number of cells that the source applies to. More...

virtual tmp< DimensionedField< scalar, volMesh > >	S (const word &fieldName) const =0
	Return the source value. More...

virtual tmp< scalarField >	source (const word &fieldName) const
	Return the source value. More...

virtual bool	movePoints ()
	Update for mesh motion. More...

virtual void	topoChange (const polyTopoChangeMap &)
	Update topology using the given map. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

virtual void	distribute (const polyDistributionMap &)
	Redistribute or update using the given distribution map. More...

Public Member Functions inherited from fvSource
	TypeName ("fvSource")
	Runtime type information. More...

	fvSource (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
	Construct from explicit source name and mesh. More...

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

virtual	~fvSource ()
	Destructor. More...

virtual bool	addsSupToField (const word &fieldName) const =0
	Return true if the fvModel adds a source term to the given. More...

virtual wordList	addSupFields () const
	Return the list of fields for which the fvModel adds source term. More...

void	operator= (const fvSource &)=delete
	Disallow default bitwise assignment. 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 scalar	maxDeltaT () const
	Return the maximum time-step for stable operation. More...

virtual void	addSup (fvMatrix< scalar > &eqn) const
	Add a source term to a field-less proxy equation. More...

template<class Type >
tmp< fvMatrix< Type > >	sourceProxy (const VolField< Type > &eqnField) const
	Add a source term to an 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 > >	sourceProxy (const VolField< Type > &field, const VolField< Type > &eqnField) const
	Return source for an equation. 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 > >	sourceProxy (const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const
	Return source for a compressible equation. 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 > >	sourceProxy (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const
	Return source for a phase equation. 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...

virtual void	preUpdateMesh ()
	Prepare for mesh update. More...

virtual void	correct ()
	Correct the fvModel. More...

virtual bool	read (const dictionary &dict)
	Read source dictionary. More...

virtual bool	write (const bool write=true) const
	Write fvModel data. More...

template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
Foam::dimensionSet	sourceDims (const dimensionSet &ds, const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)

template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
const Foam::word &	fieldName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)

template<class AlphaRhoFieldType >
const Foam::word &	fieldName (const AlphaRhoFieldType &alphaRhoField)

template<class Type , class ... AlphaRhoFieldTypes>
Foam::tmp< Foam::fvMatrix< Type > >	sourceTerm (const VolField< Type > &eqnField, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhoFields) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const VolField< Type > &eqnField) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const VolField< Type > &field, const VolField< Type > &eqnField) 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 > >	sourceProxy (const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) 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 > >	sourceProxy (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) 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

Protected Member Functions
template<class Type >
void	addSupType (const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to an equation. More...

template<class Type >
void	addSupType (const volScalarField &rho, const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to a compressible equation. More...

template<class Type >
void	addSupType (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to a phase equation. More...

Protected Member Functions inherited from fvModel
template<class Type >
void	addSupType (const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to an equation. More...

template<class Type >
void	addSupType (const volScalarField &rho, const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to a compressible equation. More...

template<class Type >
void	addSupType (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to a phase equation. More...

template<class Type , class ... AlphaRhoFieldTypes>
tmp< fvMatrix< Type > >	sourceTerm (const VolField< Type > &eqnField, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhoFields) const
	Return a source for an equation. More...

Additional Inherited Members
Static Public Member Functions inherited from fvModel
template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static dimensionSet	sourceDims (const dimensionSet &ds, const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
	Return the dimensions of the matrix of a source term. More...

static const dimensionSet &	sourceDims (const dimensionSet &ds)
	Return the dimensions of the matrix of a source term (base. More...

template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static const word &	fieldName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
	Return the name of the field associated with a source term. More...

template<class AlphaRhoFieldType >
static const word &	fieldName (const AlphaRhoFieldType &alphaRhoField)
	Return the name of the field associated with a source term (base. More...

static const word &	fieldName ()
	Return the name of the field associated with a source term. Special. 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 class for sources which are specified as a specific value (e.g., mass flow rate per unit volume), and which apply over the entire mesh.

Source files

Definition at line 50 of file fvSpecificSource.H.

Constructor & Destructor Documentation

◆ fvSpecificSource()

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

Construct from explicit source name and mesh.

Definition at line 40 of file fvSpecificSource.C.

◆ ~fvSpecificSource()

~fvSpecificSource ( )

virtual

Destructor.

Definition at line 54 of file fvSpecificSource.C.

Member Function Documentation

◆ addSupType() [1/3]

void addSupType	(	const VolField< Type > &	field,
		fvMatrix< Type > &	eqn
	)		const

protected

Add a source term to an equation.

Definition at line 33 of file fvSpecificSourceTemplates.C.

References DebugInFunction, DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimless, Foam::endl(), fvModel::mesh(), fvModel::name(), IOobject::name(), DimensionedField< Type, GeoMesh >::New(), fvMatrix< Type >::psi(), fvSpecificSource::S(), GeometricField< Type, PatchField, GeoMesh >::sources(), and Foam::fvm::Sp().

Referenced by massTransfer::addSupType().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addSupType() [2/3]

void addSupType	(	const volScalarField &	rho,
		const VolField< Type > &	field,
		fvMatrix< Type > &	eqn
	)		const

protected

Add a source term to a compressible equation.

Definition at line 87 of file fvSpecificSourceTemplates.C.

References DebugInFunction, Foam::endl(), IOobject::name(), fvMatrix< Type >::psi(), and rho.

Here is the call graph for this function:

◆ addSupType() [3/3]

void addSupType	(	const volScalarField &	alpha,
		const volScalarField &	rho,
		const VolField< Type > &	field,
		fvMatrix< Type > &	eqn
	)		const

protected

Add a source term to a phase equation.

Definition at line 104 of file fvSpecificSourceTemplates.C.

References alpha(), DebugInFunction, Foam::endl(), IOobject::name(), fvMatrix< Type >::psi(), and rho.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "fvSpecificSource" )

Runtime type information.

◆ cells()

Foam::labelUList cells ( ) const

virtual

Return the cells that the source applies to.

Implements fvSource.

Definition at line 60 of file fvSpecificSource.C.

References polyCellSet::cells().

Here is the call graph for this function:

◆ nCells()

Foam::label nCells ( ) const

virtual

Return the number of cells that the source applies to.

Reimplemented from fvSource.

Definition at line 66 of file fvSpecificSource.C.

◆ S()

virtual tmp<DimensionedField<scalar, volMesh> > S ( const word & fieldName ) const

pure virtual

Return the source value.

Implemented in massTransfer.

Referenced by fvSpecificSource::addSupType().

Here is the caller graph for this function:

◆ source()

Foam::tmp< Foam::scalarField > source ( const word & fieldName ) const

virtual

Return the source value.

Implements fvSource.

Definition at line 72 of file fvSpecificSource.C.

References tmp< T >::isTmp(), tmp< T >::ref(), and Foam::fvm::S().

Here is the call graph for this function:

◆ movePoints()

bool movePoints ( )

virtual

Update for mesh motion.

Implements fvModel.

Definition at line 86 of file fvSpecificSource.C.

◆ topoChange()

void topoChange ( const polyTopoChangeMap & map )

virtual

Update topology using the given map.

Implements fvModel.

Definition at line 92 of file fvSpecificSource.C.

◆ mapMesh()

void mapMesh ( const polyMeshMap & map )

virtual

Update from another mesh using the given map.

Implements fvModel.

Definition at line 96 of file fvSpecificSource.C.

◆ distribute()

void distribute ( const polyDistributionMap & map )

virtual

Redistribute or update using the given distribution map.

Implements fvModel.

Definition at line 100 of file fvSpecificSource.C.

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

src/finiteVolume/cfdTools/general/fvSource/fvSpecificSource.H
src/finiteVolume/cfdTools/general/fvSource/fvSpecificSource.C
src/finiteVolume/cfdTools/general/fvSource/fvSpecificSourceTemplates.C

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ fvSpecificSource()

◆ ~fvSpecificSource()

Member Function Documentation

◆ addSupType() [1/3]

◆ addSupType() [2/3]

◆ addSupType() [3/3]

◆ TypeName()

◆ cells()

◆ nCells()

◆ S()

◆ source()

◆ movePoints()

◆ topoChange()

◆ mapMesh()

◆ distribute()