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")
	Runtime type information. More...

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

	constantHeatTransfer (const constantHeatTransfer &)=delete
	No copy construct. More...

void	operator= (const constantHeatTransfer &)=delete
	No copy assignment. More...

virtual	~constantHeatTransfer ()=default
	Destructor. More...

virtual void	calculateHtc ()
	Calculate the heat transfer coefficient. More...

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

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

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

virtual	~interRegionHeatTransferModel ()=default
	Destructor. More...

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

const meshToMesh &	meshInterp () const
	Return const access to the mapToMap pointer. More...

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

const interRegionHeatTransferModel &	nbrModel () const
	Return const access to the neighbour model. More...

interRegionHeatTransferModel &	nbrModel ()
	Return access to the neighbour model. More...

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

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

virtual void	calculateHtc ()=0
	Calculate heat transfer coefficient. More...

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

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")
	Runtime type information. More...

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

	interRegionOption (const interRegionOption &)=delete
	No copy construct. More...

void	operator= (const interRegionOption &)=delete
	No copy assignment. More...

virtual	~interRegionOption ()=default
	Destructor. More...

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

const meshToMesh &	meshInterp () const
	Return const access to the mapToMap pointer. More...

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

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

	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)
	Construct from components. More...

autoPtr< option >	clone () const
	Return clone. More...

virtual	~option ()=default
	Destructor. More...

const word &	name () const noexcept
	Return const access to the source name. More...

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

const dictionary &	coeffs () const noexcept
	Return dictionary. More...

bool	active () const noexcept
	True if source is active. More...

void	setApplied (const label fieldi)
	Set the applied flag to true for field index fieldi. More...

bool	active (const bool on) noexcept
	Change source active flag, return previous value. More...

virtual bool	isActive ()
	Is the source active? More...

virtual label	applyToField (const word &fieldName) const
	Return index of field name if found in fieldNames list. More...

virtual void	checkApplied () const
	Check that the source has been applied. More...

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

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< scalar > &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
	Write the source header information. More...

virtual void	writeFooter (Ostream &) const
	Write the source footer information. More...

virtual void	writeData (Ostream &) const
	Write the source properties. More...

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

Additional Inherited Members
Static Public Member Functions inherited from option
static autoPtr< option >	New (const word &name, const dictionary &dict, const fvMesh &mesh)
	Return a reference to the selected fvOption model. More...

Public Attributes inherited from option
bool	log
	Switch write log to Info. More...

Protected Member Functions inherited from interRegionHeatTransferModel
void	setNbrModel ()
	Set the neighbour interRegionHeatTransferModel. More...

void	correct ()
	Correct to calculate the inter-region heat transfer coefficient. More...

template<class Type >
tmp< Field< Type > >	interpolate (const interRegionHeatTransferModel &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 interRegionHeatTransferModel &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...

Protected Member Functions inherited from interRegionOption
void	setMapper ()
	Set the mesh to mesh interpolation object. More...

Protected Member Functions inherited from option
void	resetApplied ()
	Resize/reset applied flag list for all fieldNames_ entries. More...

Protected Attributes inherited from interRegionHeatTransferModel
word	nbrModelName_
	Name of the model in the neighbour mesh. More...

interRegionHeatTransferModel *	nbrModel_
	Pointer to neighbour interRegionHeatTransferModel. More...

bool	firstIter_
	Flag to determine the first iteration. More...

bool	semiImplicit_
	Flag to activate semi-implicit coupling. More...

label	timeIndex_
	Time index - used for updating htc. More...

volScalarField	htc_
	Heat transfer coefficient [W/m2/k] times area/volume [1/m]. More...

word	TName_
	Name of operand temperature field. More...

word	TNbrName_
	Name of operand neighbour temperature field. More...

Protected Attributes inherited from interRegionOption
bool	master_
	Master or slave region. More...

word	nbrRegionName_
	Name of the neighbour region to map. More...

autoPtr< meshToMesh >	meshInterpPtr_
	Mesh to mesh interpolation object. More...

Protected Attributes inherited from option
const word	name_
	Source name. More...

const word	modelType_
	Model type. More...

const fvMesh &	mesh_
	Reference to the mesh database. More...

dictionary	dict_
	Top level source dictionary. More...

dictionary	coeffs_
	Dictionary containing source coefficients. More...

wordList	fieldNames_
	Field names to apply source to - populated by derived models. More...

List< bool >	applied_
	Applied flag list - corresponds to each fieldNames_ entry. More...

bool	active_
	Source active flag. More...

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 103 of file constantHeatTransfer.H.

Constructor & Destructor Documentation

◆ constantHeatTransfer() [1/2]

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

Construct from components.

Definition at line 46 of file constantHeatTransfer.C.

References option::active(), IOobject::AUTO_WRITE, interRegionHeatTransferModel::htc_, interRegionOption::master_, option::mesh_, IOobject::MUST_READ, Foam::name(), fvMesh::time(), and Time::timeName().

Here is the call graph for this function:

◆ constantHeatTransfer() [2/2]

constantHeatTransfer ( const constantHeatTransfer & )

delete

No copy construct.

◆ ~constantHeatTransfer()

virtual ~constantHeatTransfer ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "constantHeatTransfer" )

Runtime type information.

◆ operator=()

void operator= ( const constantHeatTransfer & )

delete

No copy assignment.

◆ calculateHtc()

void calculateHtc ( )

virtual

Calculate the heat transfer coefficient.

Implements interRegionHeatTransferModel.

Definition at line 99 of file constantHeatTransfer.C.

◆ read()

bool read ( const dictionary & dict )

virtual

Read dictionary.

Reimplemented from interRegionHeatTransferModel.

Definition at line 103 of file constantHeatTransfer.C.

References dict, and kEpsilonLopesdaCosta< BasicTurbulenceModel >::read().