Applies a constant heat transfer model for inter-region heat exchanges. More...

Inheritance diagram for constantHeatTransfer:

Collaboration diagram for constantHeatTransfer:

Public Member Functions
	TypeName ("constantHeatTransfer")

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

	constantHeatTransfer (const constantHeatTransfer &)=delete

void	operator= (const constantHeatTransfer &)=delete

virtual	~constantHeatTransfer ()=default

virtual void	calculateHtc ()

virtual bool	read (const dictionary &dict)

Public Member Functions inherited from interRegionHeatTransferModel
	TypeName ("interRegionHeatTransferModel")

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

virtual	~interRegionHeatTransferModel ()=default

const word &	nbrRegionName () const

const meshToMesh &	meshInterp () const

const volScalarField &	htc () const

const interRegionHeatTransferModel &	nbrModel () const

interRegionHeatTransferModel &	nbrModel ()

virtual void	addSup (fvMatrix< scalar > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)

template<class Type >
Foam::tmp< Foam::Field< Type > >	interpolate (const interRegionHeatTransferModel &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 interRegionOption
	TypeName ("interRegionOption")

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

	interRegionOption (const interRegionOption &)=delete

void	operator= (const interRegionOption &)=delete

virtual	~interRegionOption ()=default

const word &	nbrRegionName () const

const meshToMesh &	meshInterp () const

Public Member Functions inherited from option
	TypeName ("option")

	declareRunTimeSelectionTable (autoPtr, option, dictionary,(const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh),(name, modelType, dict, mesh))

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

autoPtr< option >	clone () const

virtual	~option ()=default

const word &	name () const noexcept

const fvMesh &	mesh () const noexcept

const dictionary &	coeffs () const noexcept

bool	active () const noexcept

void	setApplied (const label fieldi)

bool	active (const bool on) noexcept

virtual bool	isActive ()

virtual label	applyToField (const word &fieldName) const

virtual void	checkApplied () const

virtual void	addSup (fvMatrix< vector > &eqn, const label fieldi)

virtual void	addSup (fvMatrix< symmTensor > &eqn, const label fieldi)

virtual void	addSup (fvMatrix< sphericalTensor > &eqn, const label fieldi)

virtual void	addSup (fvMatrix< tensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldi)

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

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldi)

virtual void	constrain (fvMatrix< scalar > &eqn, const label fieldi)

virtual void	constrain (fvMatrix< vector > &eqn, const label fieldi)

virtual void	constrain (fvMatrix< sphericalTensor > &eqn, const label fieldi)

virtual void	constrain (fvMatrix< symmTensor > &eqn, const label fieldi)

virtual void	constrain (fvMatrix< tensor > &eqn, const label fieldi)

virtual void	correct (volScalarField &field)

virtual void	correct (volVectorField &field)

virtual void	correct (volSphericalTensorField &field)

virtual void	correct (volSymmTensorField &field)

virtual void	correct (volTensorField &field)

virtual void	postProcessSens (scalarField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)

virtual void	postProcessSens (vectorField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)

virtual void	postProcessSens (tensorField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)

virtual void	writeHeader (Ostream &) const

virtual void	writeFooter (Ostream &) const

virtual void	writeData (Ostream &) const

Additional Inherited Members
Static Public Member Functions inherited from option
static autoPtr< option >	New (const word &name, const dictionary &dict, const fvMesh &mesh)

Public Attributes inherited from option
bool	log

Protected Member Functions inherited from interRegionHeatTransferModel
void	setNbrModel ()

void	correct ()

template<class Type >
tmp< Field< Type > >	interpolate (const interRegionHeatTransferModel &nbrModel, const Field< Type > &field) const

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

template<class Type >
void	interpolate (const interRegionHeatTransferModel &nbrModel, const Field< Type > &field, Field< Type > &result) const

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

Protected Member Functions inherited from interRegionOption
void	setMapper ()

Protected Member Functions inherited from option
void	resetApplied ()

Protected Attributes inherited from interRegionHeatTransferModel
word	nbrModelName_

interRegionHeatTransferModel *	nbrModel_

bool	firstIter_

bool	semiImplicit_

label	timeIndex_

volScalarField	htc_

word	TName_

word	TNbrName_

Protected Attributes inherited from interRegionOption
bool	master_

word	nbrRegionName_

autoPtr< meshToMesh >	meshInterpPtr_

Protected Attributes inherited from option
const word	name_

const word	modelType_

const fvMesh &	mesh_

dictionary	dict_

dictionary	coeffs_

wordList	fieldNames_

List< bool >	applied_

bool	active_

Detailed Description

Applies a constant heat transfer model for inter-region heat exchanges.

Required fields:

  htcConst  | Constant heat transfer coefficient        [W/m2/K]
  AoV       | Area per unit volume of heat exchanger    [1/m]

Usage

Minimal example by using constant/fvOptions:

constantHeatTransfer1
{
    // Mandatory entries (unmodifiable)
    type                 constantHeatTransfer;

    // Mandatory/Optional (inherited) entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Dflt
`type`	Type name: constantHeatTransfer	word	yes	-

The inherited entries are elaborated in:

interRegionHeatTransfer.H

See also

Source files

Definition at line 99 of file constantHeatTransfer.H.

Constructor & Destructor Documentation

◆ constantHeatTransfer() [1/2]

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

Definition at line 40 of file constantHeatTransfer.C.

◆ constantHeatTransfer() [2/2]

constantHeatTransfer ( const constantHeatTransfer & )

delete

◆ ~constantHeatTransfer()

virtual ~constantHeatTransfer ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "constantHeatTransfer" )

◆ operator=()

void operator= ( const constantHeatTransfer & )

delete

◆ calculateHtc()

void calculateHtc ( )

virtual

Implements interRegionHeatTransferModel.

Definition at line 92 of file constantHeatTransfer.C.

◆ read()

bool read ( const dictionary & dict )

virtual

Reimplemented from interRegionHeatTransferModel.

Definition at line 96 of file constantHeatTransfer.C.

References dict, and interRegionHeatTransferModel::read().

Here is the call graph for this function:

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

src/fvOptions/sources/interRegion/interRegionHeatTransfer/constantHeatTransfer/constantHeatTransfer.H
src/fvOptions/sources/interRegion/interRegionHeatTransfer/constantHeatTransfer/constantHeatTransfer.C

Public Member Functions

Additional Inherited Members