Model for inter-region heat exchange. Requires specification of a model for the heat transfer coefficient (htc) and the area per unit volume (Av). These are then used to apply the following source to the energy equation: More...

Inheritance diagram for interRegionHeatTransfer:

[legend]

Collaboration diagram for interRegionHeatTransfer:

[legend]

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

	interRegionHeatTransfer (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
	Construct from dictionary. More...

virtual	~interRegionHeatTransfer ()
	Destructor. More...

const volScalarField &	htc () const
	Return the heat transfer coefficient. More...

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

virtual void	addSup (const volScalarField &he, fvMatrix< scalar > &eqn) const
	Source term to energy equation. More...

virtual void	addSup (const volScalarField &rho, const volScalarField &he, fvMatrix< scalar > &eqn) const
	Source term to compressible energy equation. More...

virtual void	correct ()
	Correct the model. 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...

virtual bool	read (const dictionary &dict)
	Read dictionary. More...

Public Member Functions inherited from interRegionModel
	TypeName ("interRegionModel")
	Runtime type information. More...

	interRegionModel (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
	Construct from dictionary. More...

virtual	~interRegionModel ()
	Destructor. More...

bool	master () const
	Return whether the master region. More...

const word &	nbrRegionName () const
	Return const access to the neighbour region name. More...

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

const cellsToCells &	interpolation () const
	Return const access to the interpolation engine. More...

template<class Type >
tmp< Field< Type > >	interpolate (const Field< Type > &field) const
	Interpolate field. More...

template<class Type >
void	interpolate (const Field< Type > &field, Field< Type > &result) const
	Interpolate field. More...

template<class Type >
Foam::tmp< Foam::Field< Type > >	interpolate (const Field< Type > &field) 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	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 interRegionModel
const interRegionModel &	nbrModel () const
	Get the neighbour interRegionModel. 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

Model for inter-region heat exchange. Requires specification of a model for the heat transfer coefficient (htc) and the area per unit volume (Av). These are then used to apply the following source to the energy equation:

$-htc*Av*(T_{nbr,mapped} - T)$

If the semiImplicit option is set, then this becomes:

$-htc*Av*(T_{nbr,mapped} - T) + htc*Av/Cp*h - Sp(htc*Av/Cp, h);$

Usage

Example usage:

interRegionHeatTransfer
{
    type            interRegionHeatTransfer;

    libs            ("libinterRegionFvModels.so");

    nbrRegion       other;

    interpolationMethod intersection;
    master          true;

    semiImplicit    no;

    Av              200;

    heatTransferCoefficientModel constant;

    htc             10;
}

See also: Foam::fv::heatTransferCoefficientModel

Source files

Definition at line 91 of file interRegionHeatTransfer.H.

Constructor & Destructor Documentation

◆ interRegionHeatTransfer()

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

Construct from dictionary.

Definition at line 79 of file interRegionHeatTransfer.C.

References fvModel::coeffs(), and dict.

Here is the call graph for this function:

◆ ~interRegionHeatTransfer()

~interRegionHeatTransfer ( )

virtual

Destructor.

Definition at line 100 of file interRegionHeatTransfer.C.

Member Function Documentation

◆ TypeName()

TypeName ( "interRegionHeatTransfer" )

Runtime type information.

◆ htc()

const volScalarField& htc ( ) const

inline

Return the heat transfer coefficient.

◆ 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 106 of file interRegionHeatTransfer.C.

References objectRegistry::lookupObject(), mesh, and thermo.

Here is the call graph for this function:

◆ addSup() [1/2]

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

virtual

Source term to energy equation.

Definition at line 115 of file interRegionHeatTransfer.C.

References Foam::dimEnergy, Foam::dimensions(), Foam::dimless, Foam::dimMass, Foam::dimTemperature, he(), Foam::fvc::interpolate(), objectRegistry::lookupObject(), mesh, Foam::name(), GeometricField< Type, GeoMesh, PrimitiveField >::New(), tmp< T >::ref(), Foam::fvm::Sp(), Foam::T(), and thermo.

Here is the call graph for this function:

◆ addSup() [2/2]

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

virtual

Source term to compressible energy equation.

Definition at line 197 of file interRegionHeatTransfer.C.

References he().

Here is the call graph for this function:

bool read ( const dictionary & dict )

virtual

Read dictionary.

Reimplemented from interRegionModel.

Definition at line 245 of file interRegionHeatTransfer.C.

References dict, and interRegionModel::read().

Here is the call graph for this function:

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

src/fvModels/interRegion/interRegionHeatTransfer/interRegionHeatTransfer.H
src/fvModels/interRegion/interRegionHeatTransfer/interRegionHeatTransfer.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ interRegionHeatTransfer()

◆ ~interRegionHeatTransfer()

Member Function Documentation

◆ TypeName()

◆ htc()

◆ addSupFields()

◆ addSup() [1/2]

◆ addSup() [2/2]

◆ correct()

◆ movePoints()

◆ topoChange()

◆ mapMesh()

◆ distribute()

◆ read()