Base class for mass transfers between phases. More...

Inheritance diagram for massTransfer:

[legend]

Collaboration diagram for massTransfer:

Public Member Functions
	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 > >	mDot () const =0
	Return the mass transfer rate. 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...

virtual bool	read (const dictionary &dict)
	Read source dictionary. 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< 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 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...

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

Protected Member Functions
const Pair< word >	lookupPhaseNames () const
	Lookup the phase names. More...

const Pair< word >	lookupPhaseFieldNames (const word &name) const
	Lookup the phase field names. More...

tmp< volScalarField::Internal >	rho (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
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...

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 mass transfers between phases.

Source files

Definition at line 52 of file massTransfer.H.

Constructor & Destructor Documentation

◆ massTransfer()

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

Construct from explicit source name and mesh.

Definition at line 181 of file massTransfer.C.

Member Function Documentation

◆ lookupPhaseNames()

const Foam::Pair< Foam::word > lookupPhaseNames ( ) const

protected

Lookup the phase names.

Definition at line 62 of file massTransfer.C.

◆ lookupPhaseFieldNames()

const Foam::Pair< Foam::word > lookupPhaseFieldNames ( const word & name ) const

protected

Lookup the phase field names.

Definition at line 69 of file massTransfer.C.

References IOobject::groupName(), and Foam::name().

Here is the call graph for this function:

◆ index()

Foam::label index	(	const Pair< word > &	names,
		const word &	name
	)

inlinestaticprotected

Get the index of the name in the given pair, or -1.

Definition at line 30 of file massTransferI.H.

References Pair< Type >::first(), fvModel::name(), and Pair< Type >::second().

Referenced by massTransfer::otherField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sign()

Foam::label sign	(	const Pair< word > &	names,
		const word &	name
	)

inlinestaticprotected

Get the sign associated with the name in the given pair; i.e., -1.

if it is the first name, +1 if the second, and zero if neither

Definition at line 40 of file massTransferI.H.

References Pair< Type >::first(), Foam::name(), and Pair< Type >::second().

Here is the call graph for this function:

◆ rho()

Foam::tmp< Foam::volScalarField::Internal > rho ( const label i ) const

protected

Return the density.

Definition at line 84 of file massTransfer.C.

References Foam::dimDensity, Foam::exit(), Foam::FatalError, FatalErrorInFunction, dictionary::found(), IOobject::groupName(), and DimensionedField< Type, GeoMesh >::New().

Here is the call graph for this function:

◆ otherField() [1/2]

const VolField<Type>& otherField ( const VolField< Type > & field ) const

protected

Return the corresponding field in the other phase, or a null.

reference if no such field exists

◆ addSupType() [1/5]

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

protected

Add a source term to an equation.

Definition at line 54 of file massTransferTemplates.C.

References DebugInFunction, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, IOobject::group(), IOobject::name(), word::null, fvMatrix< Type >::psi(), rho, and Foam::fvm::SuSp().

Here is the call graph for this function:

◆ addSupType() [2/5]

void addSupType	(	const volScalarField &	alphaOrField,
		fvMatrix< scalar > &	eqn
	)		const

protected

Add a source term to a scalar equation.

Definition at line 125 of file massTransfer.C.

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

Here is the call graph for this function:

◆ addSupType() [3/5]

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

protected

Add a source term to a compressible equation.

Definition at line 80 of file massTransferTemplates.C.

References fvSpecificSource::addSupType(), DebugInFunction, Foam::dimDensity, fvMatrix< Type >::dimensions(), DimensionedField< Type, GeoMesh >::dimensions(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, IOobject::group(), Foam::isNull(), IOobject::name(), Foam::negPart(), word::null, Foam::posPart(), fvMatrix< Type >::psi(), rho, Foam::fvm::S(), and Foam::fvm::Sp().

Here is the call graph for this function:

◆ addSupType() [4/5]

void addSupType	(	const volScalarField &	alphaOrRho,
		const volScalarField &	rhoOrField,
		fvMatrix< scalar > &	eqn
	)		const

protected

Add a source term to a compressible scalar equation.

Definition at line 150 of file massTransfer.C.

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

Here is the call graph for this function:

◆ addSupType() [5/5]

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 153 of file massTransferTemplates.C.

References fvSpecificSource::addSupType(), alpha(), DebugInFunction, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, IOobject::group(), Foam::isNull(), IOobject::name(), Foam::negPart(), Foam::posPart(), fvMatrix< Type >::psi(), rho, Foam::fvm::S(), and Foam::fvm::Sp().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "massTransfer" )

Runtime type information.

◆ addsSupToField()

bool addsSupToField ( const word & fieldName ) const

virtual

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

field's transport equation

Implements fvSource.

Definition at line 200 of file massTransfer.C.

References IOobject::group(), Foam::constant::atomic::group, and word::null.

Here is the call graph for this function:

◆ phaseNames()

const Foam::Pair< Foam::word > & phaseNames ( ) const

inline

Return the names of the phases.

Definition at line 52 of file massTransferI.H.

Referenced by massTransfer::otherField(), and phaseChange::phaseChange().

Here is the caller graph for this function:

◆ alphaNames()

const Foam::Pair< Foam::word > & alphaNames ( ) const

inline

Return the names of the volume fraction fields.

Definition at line 58 of file massTransferI.H.

◆ rhoNames()

const Foam::Pair< Foam::word > & rhoNames ( ) const

inline

Return the names of the density fields.

Definition at line 64 of file massTransferI.H.

◆ mDot()

virtual tmp<DimensionedField<scalar, volMesh> > mDot ( ) const

pure virtual

Return the mass transfer rate.

Implemented in multicomponentPhaseChange, coefficientPhaseChange, coefficientMassTransfer, homogeneousLiquidPhaseSeparation, and homogeneousCondensation.

◆ S()

Foam::tmp< Foam::volScalarField::Internal > S ( const word & fieldName ) const

virtual

Return the source value.

Implements fvSpecificSource.

Definition at line 212 of file massTransfer.C.

References IOobject::group(), and Foam::sign().

Here is the call graph for this function:

◆ addSup()

void addSup ( fvMatrix< scalar > & eqn ) const

virtual

Add a source term to a field-less proxy equation.

Reimplemented from fvModel.

Definition at line 218 of file massTransfer.C.

References DebugInFunction, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, and fvMatrix< Type >::psi().

Referenced by multicomponentPhaseChange::addSup(), singleComponentPhaseChange::addSup(), homogeneousCondensation::addSup(), homogeneousLiquidPhaseSeparation::addSup(), coefficientPhaseChange::addSup(), and coefficientMassTransfer::addSup().

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_FIELD_SUP )

Add a source term to an equation.

◆ FOR_ALL_FIELD_TYPES() [2/3]

FOR_ALL_FIELD_TYPES ( DEFINE_FV_MODEL_ADD_RHO_FIELD_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_FIELD_SUP )

Add a source term to a phase equation.

◆ read()

bool read ( const dictionary & dict )

virtual

Read source dictionary.

Reimplemented from fvModel.

Reimplemented in singleComponentPhaseChange, multicomponentPhaseChange, coefficientPhaseChange, coefficientMassTransfer, homogeneousLiquidPhaseSeparation, and homogeneousCondensation.

Definition at line 242 of file massTransfer.C.

References dict, and fvModel::read().

Referenced by coefficientMassTransfer::read(), multicomponentPhaseChange::read(), and singleComponentPhaseChange::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ otherField() [2/2]

const Foam::VolField<Type>& otherField ( const VolField< Type > & field ) const

Definition at line 32 of file massTransferTemplates.C.

References IOobject::group(), IOobject::groupName(), massTransfer::index(), objectRegistry::lookupObject(), IOobject::member(), fvModel::mesh(), and massTransfer::phaseNames().

Here is the call graph for this function:

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

src/fvModels/general/massTransfer/massTransfer.H
src/fvModels/general/massTransfer/massTransfer.C
src/fvModels/general/massTransfer/massTransferI.H
src/fvModels/general/massTransfer/massTransferTemplates.C

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ massTransfer()

Member Function Documentation

◆ lookupPhaseNames()

◆ lookupPhaseFieldNames()

◆ index()

◆ sign()

◆ rho()

◆ otherField() [1/2]

◆ addSupType() [1/5]

◆ addSupType() [2/5]

◆ addSupType() [3/5]

◆ addSupType() [4/5]

◆ addSupType() [5/5]

◆ TypeName()

◆ addsSupToField()

◆ phaseNames()

◆ alphaNames()

◆ rhoNames()

◆ mDot()

◆ S()

◆ addSup()

◆ FOR_ALL_FIELD_TYPES() [1/3]

◆ FOR_ALL_FIELD_TYPES() [2/3]

◆ FOR_ALL_FIELD_TYPES() [3/3]

◆ read()

◆ otherField() [2/2]