Film<->VoF transfer model. More...

Inheritance diagram for VoFFilmTransfer:

Collaboration diagram for VoFFilmTransfer:

Public Member Functions
	TypeName ("VoFFilmTransfer")
	Runtime type information. More...

	VoFFilmTransfer (const word &sourceName, const word &modelType, const fvMesh &mesh, const dictionary &dict)
	Construct from explicit source name and mesh. More...

	VoFFilmTransfer (const VoFFilmTransfer &)=delete
	Disallow default bitwise copy construction. More...

label	filmPatchIndex () const

const volScalarField &	alpha () const

virtual wordList	addSupFields () const
	Return the list of fields for which the option adds source term. More...

virtual void	correct ()
	Solve the film and update the sources. More...

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< scalar > &eqn) const
	Add implicit contribution to phase continuity equation. More...

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, const volScalarField &he, fvMatrix< scalar > &eqn) const
	Add implicit contribution to phase energy equation. More...

virtual void	addSup (const volScalarField &rho, const volVectorField &U, fvMatrix< vector > &eqn) const
	Add implicit contribution to mixture momentum equation. More...

tmp< scalarField >	rhoTransferRate () const
	Return the mass transfer rate. More...

tmp< scalarField >	heTransferRate () const
	Return the energy transfer rate. More...

tmp< vectorField >	UTransferRate () const
	Return the momentum transfer rate. 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	movePoints ()
	Update for mesh motion. More...

void	operator= (const VoFFilmTransfer &)=delete
	Disallow default bitwise assignment. More...

template<class Type , class TransferRateFunc >
Foam::tmp< Foam::VolInternalField< Type > >	filmVoFTransferRate (TransferRateFunc transferRateFunc, const dimensionSet &dimProp) const

template<class Type , class FieldType >
Foam::tmp< Foam::Field< Type > >	TransferRate (const FieldType &f) const

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 bool	addsSupToField (const word &fieldName) const
	Return true if the fvModel adds a source term to the given. 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	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...

Detailed Description

Film<->VoF transfer model.

Usage

Example usage:

VoFFilmTransfer
{
    type        VoFFilmTransfer;

    libs        ("libfilmVoFTransfer.so");

    filmPatch   film;
    phase       liquid;

    deltaFactorToFilm 0.9;
    alphaToFilm       0.86;

    transferRateCoeff 0.1;
}

Source files

Definition at line 70 of file VoFFilmTransfer.H.

Constructor & Destructor Documentation

◆ VoFFilmTransfer() [1/2]

VoFFilmTransfer	(	const word &	sourceName,
		const word &	modelType,
		const fvMesh &	mesh,
		const dictionary &	dict
	)

Construct from explicit source name and mesh.

Definition at line 52 of file VoFFilmTransfer.C.

◆ VoFFilmTransfer() [2/2]

VoFFilmTransfer ( const VoFFilmTransfer & )

delete

Disallow default bitwise copy construction.

Member Function Documentation

◆ TypeName()

TypeName ( "VoFFilmTransfer" )

Runtime type information.

◆ filmPatchIndex()

label filmPatchIndex ( ) const

inline

Definition at line 150 of file VoFFilmTransfer.H.

◆ alpha()

const volScalarField& alpha ( ) const

inline

Definition at line 155 of file VoFFilmTransfer.H.

Referenced by filmVoFTransfer::correct().

Here is the caller graph for this function:

◆ addSupFields()

Foam::wordList addSupFields ( ) const

virtual

Return the list of fields for which the option adds source term.

to the transport equation

Reimplemented from fvModel.

Definition at line 104 of file VoFFilmTransfer.C.

References Foam::name().

Here is the call graph for this function:

◆ correct()

void correct ( )

virtual

Solve the film and update the sources.

Reimplemented from fvModel.

Definition at line 115 of file VoFFilmTransfer.C.

References alpha(), GeometricField< Type, PatchField, GeoMesh >::boundaryField(), isothermalFilm::delta, delta, fvPatch::deltaCoeffs(), fvPatch::faceCells(), forAll, fvPatch::index(), objectRegistry::lookupObject(), mappedFvPatchBaseBase::nbrFvPatch(), mappedFvPatchBaseBase::nbrMesh(), timeIndex, and Foam::Zero.

Here is the call graph for this function:

◆ addSup() [1/3]

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

virtual

Add implicit contribution to phase continuity equation.

Definition at line 238 of file VoFFilmTransfer.C.

References alpha(), Foam::dimMass, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, fvMatrix< Type >::psi(), rho, filmVoFTransfer::rhoTransferRate(), Foam::fvm::Sp(), and Foam::type().

Here is the call graph for this function:

◆ addSup() [2/3]

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

virtual

Add implicit contribution to phase energy equation.

Definition at line 283 of file VoFFilmTransfer.C.

References alpha(), Foam::dimEnergy, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, he(), filmVoFTransfer::heTransferRate(), Foam::Info, fvMatrix< Type >::psi(), rho, Foam::fvm::Sp(), and Foam::type().

Here is the call graph for this function:

◆ addSup() [3/3]

void addSup	(	const volScalarField &	rho,
		const volVectorField &	U,
		fvMatrix< vector > &	eqn
	)		const

virtual

Add implicit contribution to mixture momentum equation.

Definition at line 325 of file VoFFilmTransfer.C.

References Foam::dimMass, Foam::dimVelocity, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, fvMatrix< Type >::psi(), rho, Foam::fvm::Sp(), Foam::type(), U, and filmVoFTransfer::UTransferRate().

Here is the call graph for this function:

◆ rhoTransferRate()

Foam::tmp< Foam::scalarField > rhoTransferRate ( ) const

Return the mass transfer rate.

Definition at line 392 of file VoFFilmTransfer.C.

Referenced by filmVoFTransfer::addSup().

Here is the caller graph for this function:

◆ heTransferRate()

Foam::tmp< Foam::scalarField > heTransferRate ( ) const

Return the energy transfer rate.

Definition at line 399 of file VoFFilmTransfer.C.

Referenced by filmVoFTransfer::addSup().

Here is the caller graph for this function:

◆ UTransferRate()

Foam::tmp< Foam::vectorField > UTransferRate ( ) const

Return the momentum transfer rate.

Definition at line 406 of file VoFFilmTransfer.C.

Referenced by filmVoFTransfer::addSup().

Here is the caller graph for this function:

◆ topoChange()

void topoChange ( const polyTopoChangeMap & )

virtual

Update topology using the given map.

Implements fvModel.

Definition at line 412 of file VoFFilmTransfer.C.

◆ mapMesh()

void mapMesh ( const polyMeshMap & map )

virtual

Update from another mesh using the given map.

Implements fvModel.

Definition at line 418 of file VoFFilmTransfer.C.

◆ distribute()

void distribute ( const polyDistributionMap & )

virtual

Redistribute or update using the given distribution map.

Implements fvModel.

Definition at line 424 of file VoFFilmTransfer.C.

◆ movePoints()

bool movePoints ( )

virtual

Update for mesh motion.

Implements fvModel.

Definition at line 430 of file VoFFilmTransfer.C.

◆ operator=()

void operator= ( const VoFFilmTransfer & )

delete

Disallow default bitwise assignment.

◆ filmVoFTransferRate()

Foam::tmp<Foam::VolInternalField<Type> > filmVoFTransferRate	(	TransferRateFunc	transferRateFunc,
		const dimensionSet &	dimProp
	)		const

inline

Definition at line 183 of file VoFFilmTransfer.C.

References Foam::dimTime, Foam::exit(), fvPatch::faceCells(), Foam::FatalError, FatalErrorInFunction, forAll, fvMesh::name(), mappedFvPatchBaseBase::nbrMesh(), dictionary::New(), tmp< T >::ref(), and Foam::Zero.

Here is the call graph for this function:

◆ TransferRate()

Foam::tmp<Foam::Field<Type> > TransferRate ( const FieldType & f ) const

inline

Definition at line 367 of file VoFFilmTransfer.C.

References f(), and fvPatch::faceCells().

Here is the call graph for this function:

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

applications/modules/isothermalFilm/fvModels/filmVoFTransfer/VoFFilmTransfer.H
applications/modules/isothermalFilm/fvModels/filmVoFTransfer/VoFFilmTransfer.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VoFFilmTransfer() [1/2]

◆ VoFFilmTransfer() [2/2]

Member Function Documentation

◆ TypeName()

◆ filmPatchIndex()

◆ alpha()

◆ addSupFields()

◆ correct()

◆ addSup() [1/3]

◆ addSup() [2/3]

◆ addSup() [3/3]

◆ rhoTransferRate()

◆ heTransferRate()

◆ UTransferRate()

◆ topoChange()

◆ mapMesh()

◆ distribute()

◆ movePoints()

◆ operator=()

◆ filmVoFTransferRate()

◆ TransferRate()