Base class for finite volume sources. More...
Public Member Functions | |
| 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... | |
| virtual labelUList | cells () const =0 |
| 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< scalarField > | source (const word &fieldName) const =0 |
| Return the source value. 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 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... | |
| 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 |
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... | |
| 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... | |
| fvSource | ( | 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 fvSource.C.
|
virtual |
Destructor.
Definition at line 54 of file fvSource.C.
| TypeName | ( | "fvSource" | ) |
Runtime type information.
|
pure virtual |
Return true if the fvModel adds a source term to the given.
field's transport equation. Must be provided by sources. Sources potentially apply to every field (or every field of a phase) and it is not known in advance what all the fields are. So, this function returns a logical test (e.g., is this the phase of which there is a source?) rather than testing whether the name is in a pre-determined set of names.
Reimplemented from fvModel.
Implemented in massTransfer, and fvTotalSource.
|
virtual |
Return the list of fields for which the fvModel adds source term.
to the transport equation. Sources return null, as all this logic is handled in addsSupToField.
Reimplemented from fvModel.
Definition at line 60 of file fvSource.C.
References List< word >::null().
|
pure virtual |
Return the cells that the source applies to.
Implemented in zeroDimensionalMassSourceBase, volumeSource, massSource, and fvSpecificSource.
Referenced by fvTotalSource::addSupType(), BasicThermo< MixtureType, BasicThermoType >::fieldSourceProperty(), BasicThermo< MixtureType, BasicThermoType >::he(), nucleationSizeGroupFvScalarFieldSource::sourceValue(), internalFvFieldSource< Type >::sourceValue(), and fvFieldSource< Type >::value().
|
virtual |
Return the number of cells that the source applies to.
Reimplemented in zeroDimensionalMassSourceBase, volumeSource, massSource, and fvSpecificSource.
Definition at line 66 of file fvSource.C.
References cells, and List< T >::size().
Referenced by nucleationSizeGroupFvScalarFieldSource::internalCoeff(), internalFvFieldSource< Type >::internalCoeff(), turbulentIntensityKineticEnergyFvScalarFieldSource::internalCoeff(), uniformFixedValueFvFieldSource< Type >::internalCoeff(), uniformInletOutletFvFieldSource< Type >::internalCoeff(), turbulentMixingLengthDissipationRateFvScalarFieldSource::internalCoeff(), turbulentMixingLengthFrequencyFvScalarFieldSource::internalCoeff(), uniformFixedEnergyTemperatureFvScalarFieldSource::internalCoeff(), uniformInletOutletEnergyTemperatureFvScalarFieldSource::internalCoeff(), uniformFixedEnergyTemperatureFvScalarFieldSource::sourceHeValue(), uniformInletOutletEnergyTemperatureFvScalarFieldSource::sourceHeValue(), uniformFixedValueFvFieldSource< Type >::sourceValue(), and uniformInletOutletFvFieldSource< Type >::sourceValue().
|
pure virtual |
Return the source value.
Implemented in fvTotalSource, and fvSpecificSource.
Referenced by turbulentIntensityKineticEnergyFvScalarFieldSource::internalCoeff(), uniformInletOutletFvFieldSource< Type >::internalCoeff(), turbulentMixingLengthDissipationRateFvScalarFieldSource::internalCoeff(), turbulentMixingLengthFrequencyFvScalarFieldSource::internalCoeff(), and uniformInletOutletEnergyTemperatureFvScalarFieldSource::internalCoeff().
|
delete |
Disallow default bitwise assignment.
1.9.1 
