Public Member Functions | List of all members
massSource Class Reference

This fvModel applies a mass source to the continuity equation and to all field equations. More...

Inheritance diagram for massSource:
Inheritance graph
[legend]
Collaboration diagram for massSource:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("massSource")
 Runtime type information. More...
 
 massSource (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 Construct from explicit source name and mesh. More...
 
 massSource (const massSource &)=delete
 Disallow default bitwise copy construction. More...
 
const word & rhoName () const
 Return the name of the density field. More...
 
virtual bool addsSupToField (const word &fieldName) const
 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...
 
 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...
 
virtual void updateMesh (const mapPolyMesh &)
 Update for mesh changes. More...
 
virtual bool read (const dictionary &dict)
 Read source dictionary. More...
 
void operator= (const massSource &)=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 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...
 
 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 a mass source to the continuity equation and to all field equations.

Usage
Example usage: 
massSource
{
    type            massSource;

    selectionMode   cellSet;
    cellSet         massSource;

    massFlowRate    1e-4;

    fieldValues
    {
        U               (10 0 0);
        T               300;
        k               0.375;
        epsilon         14.855;
    }
}

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.

Source files

Definition at line 81 of file massSource.H.

Constructor & Destructor Documentation

◆ massSource() [1/2]

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

Construct from explicit source name and mesh.

Definition at line 230 of file massSource.C.

◆ massSource() [2/2]

massSource ( const massSource &  )
delete

Disallow default bitwise copy construction.

Member Function Documentation

◆ TypeName()

TypeName ( "massSource"  )

Runtime type information.

◆ rhoName()

const word& rhoName ( ) const
inline

Return the name of the density field.

Definition at line 182 of file massSource.H.

References massSource::addsSupToField(), massSource::addSupFields(), DEFINE_FV_MODEL_ADD_ALPHA_RHO_SUP, DEFINE_FV_MODEL_ADD_RHO_SUP, DEFINE_FV_MODEL_ADD_SUP, massSource::FOR_ALL_FIELD_TYPES(), massSource::operator=(), massSource::read(), and massSource::updateMesh().

Here is the call graph for this function:

◆ addsSupToField()

bool addsSupToField ( const word &  fieldName) const
virtual

Return true if the fvModel adds a source term to the given.

field's transport equation

Reimplemented from fvModel.

Definition at line 252 of file massSource.C.

References Foam::endl(), IOobject::group(), Foam::name(), Foam::type(), and WarningInFunction.

Referenced by massSource::rhoName().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ 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 275 of file massSource.C.

References fieldNames, Foam::findIndex(), FOR_ALL_FIELD_TYPES(), IMPLEMENT_FV_MODEL_ADD_ALPHA_RHO_SUP, IMPLEMENT_FV_MODEL_ADD_RHO_SUP, and IMPLEMENT_FV_MODEL_ADD_SUP.

Referenced by massSource::rhoName().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ FOR_ALL_FIELD_TYPES() [1/3]

FOR_ALL_FIELD_TYPES ( DEFINE_FV_MODEL_ADD_SUP  )

Add a source term to an equation.

Referenced by massSource::rhoName().

Here is the caller graph for this function:

◆ FOR_ALL_FIELD_TYPES() [2/3]

FOR_ALL_FIELD_TYPES ( DEFINE_FV_MODEL_ADD_RHO_SUP  )

Add a source term to a compressible equation.

◆ FOR_ALL_FIELD_TYPES() [3/3]

FOR_ALL_FIELD_TYPES ( DEFINE_FV_MODEL_ADD_ALPHA_RHO_SUP  )

Add a source term to a phase equation.

◆ updateMesh()

void updateMesh ( const mapPolyMesh &  mpm)
virtual

Update for mesh changes.

Reimplemented from fvModel.

Definition at line 297 of file massSource.C.

Referenced by massSource::rhoName().

Here is the caller graph for this function:

◆ read()

bool read ( const dictionary &  dict)
virtual

Read source dictionary.

Reimplemented from fvModel.

Definition at line 303 of file massSource.C.

References fvModel::read().

Referenced by massSource::rhoName().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator=()

void operator= ( const massSource &  )
delete

Disallow default bitwise assignment.

Referenced by massSource::rhoName().

Here is the caller graph for this function:
The documentation for this class was generated from the following files: