coefficientMassTransfer Class Reference

This simple model generates a mass transfer between two phases calculated from the following expression: More...

Inheritance diagram for coefficientMassTransfer:
Collaboration diagram for coefficientMassTransfer:

Public Member Functions

 TypeName ("coefficientMassTransfer")
 Runtime type information. More...
 
 coefficientMassTransfer (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
 Construct from explicit source name and mesh. More...
 
virtual tmp< DimensionedField< scalar, volMesh > > mDot () const
 Return the mass transfer rate. More...
 
void addSup (const volScalarField &alpha, fvMatrix< scalar > &eqn) const
 Override the incompressible continuity equation to add. More...
 
void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< scalar > &eqn) const
 Override the compressible continuity equation to add. More...
 
virtual bool read (const dictionary &dict)
 Read source dictionary. More...
 
- Public Member Functions inherited from massTransfer
 TypeName ("massTransfer")
 Runtime type information. More...
 
 massTransfer (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
 Construct from explicit source name and mesh. More...
 
virtual bool addsSupToField (const word &fieldName) const
 Return true if the fvModel adds a source term to the given. More...
 
const Pair< word > & phaseNames () const
 Return the names of the phases. More...
 
const Pair< word > & alphaNames () const
 Return the names of the volume fraction fields. More...
 
const Pair< word > & rhoNames () const
 Return the names of the density fields. More...
 
virtual tmp< DimensionedField< scalar, volMesh > > S (const word &fieldName) const
 Return the source value. More...
 
virtual void addSup (fvMatrix< scalar > &eqn) const
 Add a source term to a field-less proxy equation. More...
 
 FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_FIELD_SUP)
 Add a source term to an equation. More...
 
 FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_RHO_FIELD_SUP)
 Add a source term to a compressible equation. More...
 
 FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_ALPHA_RHO_FIELD_SUP)
 Add a source term to a phase equation. More...
 
template<class Type >
const Foam::VolField< Type > & otherField (const VolField< Type > &field) const
 
- Public Member Functions inherited from fvSpecificSource
 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< scalarFieldsource (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 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< fvModelclone () const
 Return clone. More...
 
virtual ~fvModel ()
 Destructor. More...
 
const wordname () const
 Return const access to the source name. More...
 
const fvMeshmesh () const
 Return const access to the mesh database. More...
 
const dictionarycoeffs () 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::wordfieldName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
 
template<class AlphaRhoFieldType >
const Foam::wordfieldName (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 dimensionSetsourceDims (const dimensionSet &ds)
 Return the dimensions of the matrix of a source term (base. More...
 
template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static const wordfieldName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
 Return the name of the field associated with a source term. More...
 
template<class AlphaRhoFieldType >
static const wordfieldName (const AlphaRhoFieldType &alphaRhoField)
 Return the name of the field associated with a source term (base. More...
 
static const wordfieldName ()
 Return the name of the field associated with a source term. Special. More...
 
static autoPtr< fvModelNew (const word &name, const fvMesh &mesh, const dictionary &dict)
 Return a reference to the selected fvModel. More...
 
- Protected Member Functions inherited from massTransfer
const Pair< wordlookupPhaseNames () const
 Lookup the phase names. More...
 
const Pair< wordlookupPhaseFieldNames (const word &name) const
 Lookup the phase field names. More...
 
tmp< volScalarField::Internalrho (const label i) const
 Return the density. More...
 
template<class Type >
const VolField< Type > & otherField (const VolField< Type > &field) const
 Return the corresponding field in the other phase, or a null. More...
 
template<class Type >
void addSupType (const VolField< Type > &field, fvMatrix< Type > &eqn) const
 Add a source term to an equation. More...
 
void addSupType (const volScalarField &alphaOrField, fvMatrix< scalar > &eqn) const
 Add a source term to a scalar equation. More...
 
template<class Type >
void addSupType (const volScalarField &alphaOrRho, const VolField< Type > &field, fvMatrix< Type > &eqn) const
 Add a source term to a compressible equation. More...
 
void addSupType (const volScalarField &alphaOrRho, const volScalarField &rhoOrField, fvMatrix< scalar > &eqn) const
 Add a source term to a compressible scalar 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 fvSpecificSource
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...
 
- Static Protected Member Functions inherited from massTransfer
static label index (const Pair< word > &names, const word &name)
 Get the index of the name in the given pair, or -1. More...
 
static label sign (const Pair< word > &names, const word &name)
 Get the sign associated with the name in the given pair; i.e., -1. More...
 

Detailed Description

This simple model generates a mass transfer between two phases calculated from the following expression:

\[ \dot{m}/V = C \alpha \grad \alpha \]

$ \dot{m}/V $ = mass transfer rate per unit volume
$ C $ = coefficient
$ \alpha $ = volume fraction of the source phase
Usage
Example usage:
coefficientMassTransfer
{
    type            coefficientMassTransfer;

    phases          (liquid vapour);

    C               [kg/m^2/s] 0.1;
}
Source files

Definition at line 87 of file coefficientMassTransfer.H.

Constructor & Destructor Documentation

◆ coefficientMassTransfer()

coefficientMassTransfer ( const word name,
const word modelType,
const fvMesh mesh,
const dictionary dict 
)

Construct from explicit source name and mesh.

Definition at line 51 of file coefficientMassTransfer.C.

Member Function Documentation

◆ TypeName()

TypeName ( "coefficientMassTransfer"  )

Runtime type information.

◆ mDot()

Foam::tmp< Foam::volScalarField::Internal > mDot ( ) const
virtual

Return the mass transfer rate.

Implements massTransfer.

Definition at line 69 of file coefficientMassTransfer.C.

References Foam::fvc::grad(), and Foam::mag().

Here is the call graph for this function:

◆ addSup() [1/2]

void addSup ( const volScalarField alpha,
fvMatrix< scalar > &  eqn 
) const

Override the incompressible continuity equation to add.

linearisation w.r.t alpha

Definition at line 78 of file coefficientMassTransfer.C.

References massTransfer::addSup(), alpha(), Foam::correction(), Foam::fvc::grad(), Foam::mag(), fvMatrix< Type >::psi(), rho, and Foam::fvm::Sp().

Here is the call graph for this function:

◆ addSup() [2/2]

void addSup ( const volScalarField alpha,
const volScalarField rho,
fvMatrix< scalar > &  eqn 
) const

Override the compressible continuity equation to add.

linearisation w.r.t alpha

Definition at line 112 of file coefficientMassTransfer.C.

References massTransfer::addSup(), alpha(), Foam::correction(), Foam::fvc::grad(), Foam::mag(), fvMatrix< Type >::psi(), rho, and Foam::fvm::Sp().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary dict)
virtual

Read source dictionary.

Reimplemented from massTransfer.

Definition at line 144 of file coefficientMassTransfer.C.

References dict, and massTransfer::read().

Here is the call graph for this function:

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