Model for inter-region heat exchange. Requires specification of a model for the heat transfer coefficient (htc) and the area per unit volume (AoV). 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 dictionary &dict, const fvMesh &mesh)
	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 (fvMatrix< scalar > &eqn, const word &fieldName) const
	Source term to energy equation. More...

virtual void	addSup (const volScalarField &rho, fvMatrix< scalar > &eqn, const word &fieldName) 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 dictionary &dict, const fvMesh &mesh)
	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 meshToMesh &	meshInterp () const
	Return const access to the mapToMap pointer. More...

template<class Type >
tmp< Field< Type > >	interpolate (const interRegionModel &nbrModel, const Field< Type > &field) const
	Interpolate field with nbrModel specified. More...

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

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

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

template<class Type >
Foam::tmp< Foam::Field< Type > >	interpolate (const interRegionModel &nbrModel, const Field< Type > &field) const

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 dictionary &dict, const fvMesh &mesh),(name, modelType, dict, mesh))

	fvModel (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	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...

	FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_SUP)
	Add a source term to an equation. More...

	FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_RHO_SUP)
	Add a source term to a compressible equation. More...

	FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_ALPHA_RHO_SUP)
	Add a source term to a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const GeometricField< Type, fvPatchField, volMesh > &field) const
	Return source for an equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const
	Return source for an equation with a specified name. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field) const
	Return source for a compressible equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const
	Return source for a compressible equation with a specified name. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const
	Return source for a phase equation with a specified name. More...

virtual void	preUpdateMesh ()
	Prepare for mesh update. More...

template<class Type , class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
Foam::dimensionSet	sourceDims (const GeometricField< Type, fvPatchField, volMesh > &field, const dimensionSet &ds, const AlphaRhoFieldType &alphaRho, const AlphaRhoFieldTypes &... alphaRhos)

template<class Type >
Foam::dimensionSet	sourceDims (const GeometricField< Type, fvPatchField, volMesh > &field, const dimensionSet &ds)

template<class Type , class ... AlphaRhoFieldTypes>
Foam::tmp< Foam::fvMatrix< Type > >	source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhos) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const GeometricField< Type, fvPatchField, volMesh > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const

Protected Member Functions
const heatTransferModel &	nbrHeatTransferModel () const
	Get the neighbour heat transfer model. 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 (fvMatrix< Type > &eqn, const word &fieldName) const
	Add a source term to an equation. More...

template<class Type >
void	addSupType (const volScalarField &rho, fvMatrix< Type > &eqn, const word &fieldName) const
	Add a source term to a compressible equation. More...

template<class Type >
void	addSupType (const volScalarField &alpha, const volScalarField &rho, fvMatrix< Type > &eqn, const word &fieldName) const
	Add a source term to a phase equation. More...

template<class Type , class ... AlphaRhoFieldTypes>
tmp< fvMatrix< Type > >	source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhos) const
	Return source for equation with specified name and dimensions. More...

Additional Inherited Members
Static Public Member Functions inherited from fvModel
template<class Type , class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static dimensionSet	sourceDims (const GeometricField< Type, fvPatchField, volMesh > &field, const dimensionSet &ds, const AlphaRhoFieldType &alphaRho, const AlphaRhoFieldTypes &... alphaRhos)
	Return the dimensions of the matrix of a source term. More...

template<class Type >
static dimensionSet	sourceDims (const GeometricField< Type, fvPatchField, volMesh > &field, const dimensionSet &ds)
	Return the dimensions of the matrix of a source term (base. More...

static autoPtr< fvModel >	New (const word &name, const dictionary &dict, const fvMesh &mesh)
	Return a reference to the selected fvModel. 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 (AoV). These are then used to apply the following source to the energy equation:

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

If the semiImplicit option is set, then this becomes:

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

Usage

Example usage:

interRegionHeatTransfer
{
    type            interRegionHeatTransfer;

    interRegionHeatTransferCoeffs
    {
        nbrRegion       other;

        interpolationMethod cellVolumeWeight;
        master          true;

        semiImplicit    no;

        type            constant;

        AoV             200;
        htc             10;
    }
}

See also: fv::heatTransferModel

Source files

Definition at line 90 of file interRegionHeatTransfer.H.

Constructor & Destructor Documentation

◆ interRegionHeatTransfer()

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

Construct from dictionary.

Definition at line 78 of file interRegionHeatTransfer.C.

Referenced by interRegionHeatTransfer::nbrHeatTransferModel().

Here is the caller graph for this function:

◆ ~interRegionHeatTransfer()

~interRegionHeatTransfer ( )

virtual

Destructor.

Definition at line 97 of file interRegionHeatTransfer.C.

Member Function Documentation

◆ nbrHeatTransferModel()

const Foam::fv::heatTransferModel & nbrHeatTransferModel ( ) const

protected

Get the neighbour heat transfer model.

Definition at line 68 of file interRegionHeatTransfer.C.

References interRegionHeatTransfer::interRegionHeatTransfer().

Here is the call graph for this function:

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

References interRegionHeatTransfer::addSup(), basicThermo::he(), mesh, IOobject::name(), and thermo.

Here is the call graph for this function:

◆ addSup() [1/2]

void addSup	(	fvMatrix< scalar > &	eqn,
		const word &	fieldName
	)		const

virtual

Source term to energy equation.

Definition at line 113 of file interRegionHeatTransfer.C.

References basicThermo::Cpv(), Foam::dimEnergy, DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimless, Foam::dimMass, Foam::dimTemperature, he(), Foam::interpolate(), mesh, Foam::name(), GeometricField< scalar, fvPatchField, volMesh >::New(), fvMatrix< Type >::psi(), tmp< T >::ref(), GeometricField< Type, PatchField, GeoMesh >::ref(), Foam::fvm::Sp(), Foam::T(), and thermo.

Referenced by interRegionHeatTransfer::addSupFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addSup() [2/2]

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

virtual

Source term to compressible energy equation.

Definition at line 196 of file interRegionHeatTransfer.C.

◆ correct()

void correct ( )

virtual

Correct the model.

Reimplemented from fvModel.

Definition at line 206 of file interRegionHeatTransfer.C.

◆ movePoints()

bool movePoints ( )

virtual

Update for mesh motion.

Implements fvModel.

Definition at line 215 of file interRegionHeatTransfer.C.

◆ topoChange()

void topoChange ( const polyTopoChangeMap & )

virtual

Update topology using the given map.

Implements fvModel.

Definition at line 221 of file interRegionHeatTransfer.C.

◆ mapMesh()

void mapMesh ( const polyMeshMap & map )

virtual

Update from another mesh using the given map.

Implements fvModel.

Definition at line 225 of file interRegionHeatTransfer.C.

References interRegionHeatTransfer::distribute().

Here is the call graph for this function:

◆ distribute()

void distribute ( const polyDistributionMap & )

virtual

Redistribute or update using the given distribution map.

Implements fvModel.

Definition at line 230 of file interRegionHeatTransfer.C.

Referenced by interRegionHeatTransfer::mapMesh().

Here is the caller graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Read dictionary.

Reimplemented from interRegionModel.

Definition at line 236 of file interRegionHeatTransfer.C.

References 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

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ interRegionHeatTransfer()

◆ ~interRegionHeatTransfer()

Member Function Documentation

◆ nbrHeatTransferModel()

◆ TypeName()

◆ htc()

◆ addSupFields()

◆ addSup() [1/2]

◆ addSup() [2/2]

◆ correct()

◆ movePoints()

◆ topoChange()

◆ mapMesh()

◆ distribute()

◆ read()