This fvModel applies a volume source to the continuity equation and to all field equations. It can be applied to incompressible solvers, such as incompressibleFluid and incompressibleVoF. For compressible solvers, use the massSource model instead. More...
Public Member Functions | |
TypeName ("volumeSource") | |
Runtime type information. More... | |
volumeSource (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict) | |
Construct from explicit source name and mesh. 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 scalar | V () const |
Return the volume of cells that the source applies to. More... | |
virtual dimensionedScalar | S () const |
Return the source value. More... | |
virtual void | addSup (fvMatrix< scalar > &eqn) const |
Add a source term to a field-less proxy equation. More... | |
virtual bool | movePoints () |
Add a source term to an equation. 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... | |
virtual bool | read (const dictionary &dict) |
Read source dictionary. More... | |
![]() | |
TypeName ("fvTotalSource") | |
Runtime type information. More... | |
fvTotalSource (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict) | |
Construct from explicit source name and mesh. More... | |
virtual | ~fvTotalSource () |
Destructor. More... | |
virtual bool | addsSupToField (const word &fieldName) const |
Return true if the fvModel adds a source term to the given. More... | |
const word & | phaseName () const |
Return the phase name. More... | |
virtual tmp< scalarField > | source (const word &fieldName) const |
Return the source value. More... | |
![]() | |
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 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... | |
![]() | |
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... | |
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 | 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 |
Additional Inherited Members | |
![]() | |
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... | |
![]() | |
void | addSource (fvMatrix< scalar > &eqn) const |
Add a source term to a field-less proxy equation. More... | |
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 > | |
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... | |
This fvModel applies a volume source to the continuity equation and to all field equations. It can be applied to incompressible solvers, such as incompressibleFluid and incompressibleVoF. For compressible solvers, use the massSource model instead.
If the volumetric flow rate is positive then user-supplied fixed property values are introduced to the field equations. If the volumetric flow rate is negative then properties are removed at their current value.
volumeSource { type volumeSource; select cellSet; cellSet volumeSource; volumetricFlowRate 1e-4; fieldValues { U (10 0 0); k 0.375; epsilon 14.855; } }
If the volumetric flow rate is positive then values should be provided for all solved for fields. Warnings will be issued if values are not provided for fields for which transport equations are solved. Warnings will also be issued if values are provided for fields which are not solved for.
Definition at line 87 of file volumeSource.H.
volumeSource | ( | const word & | name, |
const word & | modelType, | ||
const fvMesh & | mesh, | ||
const dictionary & | dict | ||
) |
Construct from explicit source name and mesh.
Definition at line 214 of file volumeSource.C.
TypeName | ( | "volumeSource" | ) |
Runtime type information.
|
virtual |
Return the cells that the source applies to.
Implements fvSource.
Definition at line 233 of file volumeSource.C.
|
virtual |
Return the number of cells that the source applies to.
Reimplemented from fvSource.
Definition at line 239 of file volumeSource.C.
|
virtual |
Return the volume of cells that the source applies to.
Implements fvTotalSource.
Definition at line 245 of file volumeSource.C.
|
virtual |
Return the source value.
Implements fvTotalSource.
Definition at line 251 of file volumeSource.C.
References Foam::dimTime, and Foam::dimVolume.
|
virtual |
Add a source term to a field-less proxy equation.
Reimplemented from fvModel.
Definition at line 262 of file volumeSource.C.
References fvTotalSource::addSource(), DebugInFunction, Foam::endl(), and fvMatrix< Type >::psi().
|
virtual |
Add a source term to an equation.
Add a source term to a compressible equation Add a source term to a phase equation Update for mesh motion
Implements fvModel.
|
virtual |
Update topology using the given map.
Implements fvModel.
Definition at line 292 of file volumeSource.C.
|
virtual |
Update from another mesh using the given map.
Implements fvModel.
Definition at line 298 of file volumeSource.C.
|
virtual |
Redistribute or update using the given distribution map.
Implements fvModel.
Definition at line 304 of file volumeSource.C.
|
virtual |
Read source dictionary.
Reimplemented from fvTotalSource.
Definition at line 310 of file volumeSource.C.
References dict, and fvTotalSource::read().