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

Inheritance diagram for filmCloudTransfer:

Collaboration diagram for filmCloudTransfer:

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

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

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

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 &rho, const volScalarField &alpha, fvMatrix< scalar > &eqn) const
	Add source to phase continuity equation. More...

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

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

void	resetFromCloudFields ()
	Reset the fields accumulated cloud transfer fields. More...

void	parcelFromCloud (const label facei, const scalar mass, const vector &momentum, const scalar energy)
	Transfer parcel properties from cloud to the film. More...

bool	ejecting () const
	Return true if the film is ejecting to the cloud. More...

tmp< Field< scalar > >	ejectedMassToCloud () const
	Transfer the ejected mass to the cloud. More...

tmp< Field< scalar > >	ejectedDiameterToCloud () const
	Transfer the ejected droplet diameter to the cloud. More...

tmp< Field< scalar > >	deltaToCloud () const
	Transfer the film delta field to the cloud. More...

tmp< Field< vector > >	UToCloud () const
	Transfer the film velocity field to the cloud. More...

tmp< Field< scalar > >	rhoToCloud () const
	Transfer the film density field to the cloud. More...

tmp< Field< scalar > >	TToCloud () const
	Transfer the film temperature field to the cloud. More...

tmp< Field< scalar > >	CpToCloud () const
	Transfer the film heat capacity field to the cloud. 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 filmCloudTransfer &)=delete
	Disallow default bitwise assignment. More...

template<class Type >
Foam::tmp< Foam::VolInternalField< Type > >	CloudToFilmTransferRate (const Field< Type > &prop, const dimensionSet &dimProp) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	filmToCloudTransfer (const VolInternalField< Type > &prop) 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 word &	keyword () const
	Return name as the keyword. More...

const fvMesh &	mesh () const
	Return const access to the mesh database. More...

const dictionary &	coeffs (const dictionary &) const
	Return the coefficients sub-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
static const dictionary &	coeffs (const word &modelType, const dictionary &)
	Return the coefficients sub-dictionary for a given model type. More...

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...

Static Public Attributes inherited from fvModel
static const wordHashSet	keywords
	The keywords read by this class. 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<->cloud transfer model.

Usage

Example usage:

filmCloudTransfer
{
    type    filmCloudTransfer;
}

Source files

Definition at line 61 of file filmCloudTransfer.H.

Constructor & Destructor Documentation

◆ filmCloudTransfer() [1/2]

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

Construct from explicit source name and mesh.

Definition at line 51 of file filmCloudTransfer.C.

◆ filmCloudTransfer() [2/2]

filmCloudTransfer ( const filmCloudTransfer & )

delete

Disallow default bitwise copy construction.

Member Function Documentation

◆ TypeName()

TypeName ( "filmCloudTransfer" )

Runtime type information.

◆ 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 74 of file filmCloudTransfer.C.

◆ correct()

void correct ( )

virtual

Solve the film and update the sources.

Reimplemented from fvModel.

Definition at line 85 of file filmCloudTransfer.C.

◆ addSup() [1/3]

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

virtual

Add source to phase continuity equation.

Definition at line 135 of file filmCloudTransfer.C.

References alpha(), Foam::dimMass, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, fvMatrix< Type >::psi(), rho, 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 source to phase energy equation.

Definition at line 165 of file filmCloudTransfer.C.

References alpha(), Foam::dimEnergy, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, he(), 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 &	alpha,
		const volScalarField &	rho,
		const volVectorField &	U,
		fvMatrix< vector > &	eqn
	)		const

virtual

Add source to mixture momentum equation.

Definition at line 196 of file filmCloudTransfer.C.

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

Here is the call graph for this function:

◆ resetFromCloudFields()

void resetFromCloudFields ( )

Reset the fields accumulated cloud transfer fields.

Definition at line 227 of file filmCloudTransfer.C.

References fvMesh::boundary(), UPtrList< T >::size(), and Foam::Zero.

Referenced by CloudFilmTransfer< CloudType >::cacheFilmFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parcelFromCloud()

void parcelFromCloud	(	const label	facei,
		const scalar	mass,
		const vector &	momentum,
		const scalar	energy
	)

Transfer parcel properties from cloud to the film.

accumulated fields

Definition at line 251 of file filmCloudTransfer.C.

Referenced by CloudFilmTransfer< CloudType >::absorbInteraction().

Here is the caller graph for this function:

◆ ejecting()

bool ejecting ( ) const

Return true if the film is ejecting to the cloud.

Definition at line 279 of file filmCloudTransfer.C.

Referenced by CloudFilmTransfer< CloudType >::cacheFilmFields().

Here is the caller graph for this function:

◆ ejectedMassToCloud()

Foam::tmp< Foam::Field< Foam::scalar > > ejectedMassToCloud ( ) const

Transfer the ejected mass to the cloud.

Definition at line 286 of file filmCloudTransfer.C.

References mesh.

Referenced by CloudFilmTransfer< CloudType >::cacheFilmFields().

Here is the caller graph for this function:

◆ ejectedDiameterToCloud()

Foam::tmp< Foam::Field< Foam::scalar > > ejectedDiameterToCloud ( ) const

Transfer the ejected droplet diameter to the cloud.

Definition at line 300 of file filmCloudTransfer.C.

Referenced by CloudFilmTransfer< CloudType >::cacheFilmFields().

Here is the caller graph for this function:

◆ deltaToCloud()

Foam::tmp< Foam::Field< Foam::scalar > > deltaToCloud ( ) const

Transfer the film delta field to the cloud.

Definition at line 307 of file filmCloudTransfer.C.

Referenced by CloudFilmTransfer< CloudType >::cacheFilmFields().

Here is the caller graph for this function:

◆ UToCloud()

Foam::tmp< Foam::Field< Foam::vector > > UToCloud ( ) const

Transfer the film velocity field to the cloud.

Definition at line 314 of file filmCloudTransfer.C.

Referenced by CloudFilmTransfer< CloudType >::cacheFilmFields().

Here is the caller graph for this function:

◆ rhoToCloud()

Foam::tmp< Foam::Field< Foam::scalar > > rhoToCloud ( ) const

Transfer the film density field to the cloud.

Definition at line 321 of file filmCloudTransfer.C.

Referenced by CloudFilmTransfer< CloudType >::cacheFilmFields().

Here is the caller graph for this function:

◆ TToCloud()

Foam::tmp< Foam::Field< Foam::scalar > > TToCloud ( ) const

Transfer the film temperature field to the cloud.

Definition at line 328 of file filmCloudTransfer.C.

Referenced by CloudFilmTransfer< CloudType >::cacheFilmFields().

Here is the caller graph for this function:

◆ CpToCloud()

Foam::tmp< Foam::Field< Foam::scalar > > CpToCloud ( ) const

Transfer the film heat capacity field to the cloud.

Definition at line 335 of file filmCloudTransfer.C.

Referenced by CloudFilmTransfer< CloudType >::cacheFilmFields().

Here is the caller graph for this function:

◆ topoChange()

void topoChange ( const polyTopoChangeMap & map )

virtual

Update topology using the given map.

Implements fvModel.

Definition at line 341 of file filmCloudTransfer.C.

◆ mapMesh()

void mapMesh ( const polyMeshMap & map )

virtual

Update from another mesh using the given map.

Implements fvModel.

Definition at line 355 of file filmCloudTransfer.C.

◆ distribute()

void distribute ( const polyDistributionMap & map )

virtual

Redistribute or update using the given distribution map.

Implements fvModel.

Definition at line 369 of file filmCloudTransfer.C.

◆ movePoints()

bool movePoints ( )

virtual

Update for mesh motion.

Implements fvModel.

Definition at line 383 of file filmCloudTransfer.C.

◆ operator=()

void operator= ( const filmCloudTransfer & )

delete

Disallow default bitwise assignment.

◆ CloudToFilmTransferRate()

Foam::tmp<Foam::VolInternalField<Type> > CloudToFilmTransferRate	(	const Field< Type > &	prop,
		const dimensionSet &	dimProp
	)		const

inline

Definition at line 100 of file filmCloudTransfer.C.

References fvMesh::boundary(), TimeState::deltaTValue(), Foam::dimTime, Foam::dimVolume, mesh, tmp< T >::ref(), fvMesh::time(), and Foam::Zero.

Here is the call graph for this function:

◆ filmToCloudTransfer()

Foam::tmp<Foam::Field<Type> > filmToCloudTransfer ( const VolInternalField< Type > & prop ) const

inline

Definition at line 267 of file filmCloudTransfer.C.

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

applications/modules/isothermalFilm/fvModels/filmCloudTransfer/filmCloudTransfer.H
applications/modules/isothermalFilm/fvModels/filmCloudTransfer/filmCloudTransfer.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ filmCloudTransfer() [1/2]

◆ filmCloudTransfer() [2/2]

Member Function Documentation

◆ TypeName()

◆ addSupFields()

◆ correct()

◆ addSup() [1/3]

◆ addSup() [2/3]

◆ addSup() [3/3]

◆ resetFromCloudFields()

◆ parcelFromCloud()

◆ ejecting()

◆ ejectedMassToCloud()

◆ ejectedDiameterToCloud()

◆ deltaToCloud()

◆ UToCloud()

◆ rhoToCloud()

◆ TToCloud()

◆ CpToCloud()

◆ topoChange()

◆ mapMesh()

◆ distribute()

◆ movePoints()

◆ operator=()

◆ CloudToFilmTransferRate()

◆ filmToCloudTransfer()