A heat exchanger model where heat exchange is calculated via a temperature table. More...

#include <referenceTemperature.H>

Inheritance diagram for referenceTemperature:

Collaboration diagram for referenceTemperature:

Public Member Functions
	TypeName ("referenceTemperature")
	Runtime type information.
	referenceTemperature (const fvMesh &mesh, const word &name, const dictionary &coeffs)
	Construct from components.
	referenceTemperature (const referenceTemperature &)=delete
	No copy construct.
void	operator= (const referenceTemperature &)=delete
	No copy assignment.
virtual	~referenceTemperature ()=default
	Destructor.
virtual void	initialise ()
	Initialise data members of the model.
virtual tmp< scalarField >	energyDensity (const labelList &cells)
	Return energy density per unit length [J/m3/m].
virtual bool	read (const dictionary &dict)
	Read top-level dictionary.
virtual void	write (const bool log)
	Write data to stream and files.
Public Member Functions inherited from heatExchangerModel
	TypeName ("heatExchangerModel")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, heatExchangerModel, dictionary,(const fvMesh &mesh, const word &name, const dictionary &coeffs),(mesh, name, coeffs))
	heatExchangerModel (const fvMesh &mesh, const word &name, const dictionary &coeffs)
	Construct from components.
	heatExchangerModel (const heatExchangerModel &)=delete
	No copy construct.
void	operator= (const heatExchangerModel &)=delete
	No copy assignment.
virtual	~heatExchangerModel ()=default
	Destructor.
virtual const word &	U () const
	Return const reference to the name of velocity field.
Public Member Functions inherited from writeFile
	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name="undefined", const bool writeToFile=true, const string &ext=".dat")
	Construct from objectRegistry, prefix, fileName.
	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name, const dictionary &dict, const bool writeToFile=true, const string &ext=".dat")
	Construct from objectRegistry, prefix, fileName and read options from dictionary.
	writeFile (const writeFile &wf)
	Construct copy.
virtual	~writeFile ()=default
	Destructor.
virtual const string &	setExt (const string &ext)
	Set extension.
virtual OFstream &	file ()
	Return access to the file (if only 1).
virtual bool	writeToFile () const
	Flag to allow writing to file.
virtual bool	canWriteToFile () const
	Flag to allow writing to the file.
virtual bool	canResetFile () const
	Flag to allow resetting the file.
virtual bool	canWriteHeader () const
	Flag to allow writing the header.
virtual label	charWidth () const
	Return width of character stream output.
virtual void	writeCommented (Ostream &os, const string &str) const
	Write a commented string to stream.
virtual void	writeTabbed (Ostream &os, const string &str) const
	Write a tabbed string to stream.
virtual void	writeHeader (Ostream &os, const string &str) const
	Write a commented header to stream.
virtual void	writeCurrentTime (Ostream &os) const
	Write the current time to stream.
virtual void	writeBreak (Ostream &os) const
	Write a break marker to the stream.
template<class Type>
void	writeHeaderValue (Ostream &os, const string &property, const Type &value) const
	Write a (commented) header property and value pair.
template<class Type>
void	writeValue (Ostream &os, const Type &val) const
	Write a given value to stream with the space delimiter.

Additional Inherited Members
Static Public Member Functions inherited from heatExchangerModel
static autoPtr< heatExchangerModel >	New (const fvMesh &mesh, const word &name, const dictionary &coeffs)
	Return a reference to the selected heat exchanger model.
Static Public Attributes inherited from writeFile
static label	addChars = 8
	Additional characters for writing.
Protected Member Functions inherited from writeFile
void	initStream (Ostream &os) const
	Initialise the output stream for writing.
fileName	baseFileDir () const
	Return the base directory for output.
fileName	baseTimeDir () const
	Return the base directory for the current time value.
fileName	filePath (const fileName &fName) const
	Return the full path for the supplied file name.
virtual autoPtr< OFstream >	newFile (const fileName &fName) const
	Return autoPtr to a new file using file name.
virtual autoPtr< OFstream >	newFileAtTime (const word &name, scalar timeValue) const
	Return autoPtr to a new file for a given time.
virtual autoPtr< OFstream >	newFileAtStartTime (const word &name) const
	Return autoPtr to a new file using the simulation start time.
virtual void	resetFile (const word &name)
	Reset internal file pointer to new file with new name.
Omanip< int >	valueWidth (const label offset=0) const
	Return the value width when writing to stream with optional offset.
void	operator= (const writeFile &)=delete
	No copy assignment.
virtual autoPtr< OFstream >	createFile (const word &name, scalar timeValue) const
	Deprecated(2022-09) Return autoPtr to a new file for a given time.
virtual autoPtr< OFstream >	createFile (const word &name) const
	Deprecated(2022-09) Return autoPtr to a new file using the simulation start time.
Protected Attributes inherited from heatExchangerModel
const fvMesh &	mesh_
	Reference to the mesh.
const dictionary &	coeffs_
	Dictionary containing coefficients specific to the chosen model.
const word &	name_
	Reference to the name of the fvOption source.
word	UName_
	Name of operand velocity field.
word	TName_
	Name of operand temperature field.
word	phiName_
	Name of operand flux field.
word	faceZoneName_
	Name of the faceZone at the heat exchanger inlet.
labelList	faceId_
	Local list of face IDs.
labelList	facePatchId_
	Local list of patch IDs per face.
labelList	faceSign_
	List of +1/-1 representing face flip map (1 use as is, -1 negate).
Protected Attributes inherited from writeFile
const objectRegistry &	fileObr_
	Reference to the region objectRegistry.
const fileName	prefix_
	Prefix.
word	fileName_
	Name of file.
autoPtr< OFstream >	filePtr_
	File pointer.
label	writePrecision_
	Write precision.
bool	writeToFile_
	Flag to enable/disable writing to file.
bool	updateHeader_
	Flag to update the header, e.g. on mesh changes. Default is true.
bool	writtenHeader_
	Flag to identify whether the header has been written.
bool	useUserTime_
	Flag to use the specified user time, e.g. CA deg instead of seconds. Default = true.
scalar	startTime_
	Start time value.
string	ext_
	File extension; default = .dat.

Detailed Description

A heat exchanger model where heat exchange is calculated via a temperature table.

Usage

Minimal example by using constant/fvOptions:

<name>
{
    // Inherited entries
    ...

    // Mandatory entries
    model                    referenceTemperature;
    targetQdot               <Function1<scalar>>;

    // Conditional mandatory entries

        // Option-1
        Tref                     <scalar>;

        // Option-2
        file                     "<word>";
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`model`	Model name:effectivenessTable	word	yes	-
`targetQdot`	Target heat rejection [J/s]	Function1<scalar>	yes	-
`Tref`	Reference temperature [K]	scalar	choice	-
`file`	2D reference temperature table = function of primary mass flow rate [kg/s] and primary flow temperature	file	choice	-

The inherited entries are elaborated in:

Source files

Definition at line 125 of file referenceTemperature.H.

Constructor & Destructor Documentation

◆ referenceTemperature() [1/2]

referenceTemperature	(	const fvMesh &	mesh,
		const word &	name,
		const dictionary &	coeffs )

Construct from components.

Definition at line 183 of file referenceTemperature.C.

References writeFile::file(), heatExchangerModel::heatExchangerModel(), mesh, heatExchangerModel::mesh_, Foam::name(), and heatExchangerModel::New().

Referenced by operator=(), and referenceTemperature().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ referenceTemperature() [2/2]

referenceTemperature ( const referenceTemperature & )

delete

No copy construct.

References referenceTemperature().

Here is the call graph for this function:

◆ ~referenceTemperature()

virtual ~referenceTemperature ( )

virtualdefault

Destructor.

References cells, dict, and Foam::log().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "referenceTemperature" )

Runtime type information.

References mesh, and Foam::name().

Here is the call graph for this function:

◆ operator=()

void operator= ( const referenceTemperature & )

delete

No copy assignment.

References referenceTemperature().

Here is the call graph for this function:

◆ initialise()

void initialise ( )

virtual

Initialise data members of the model.

Reimplemented from heatExchangerModel.

Definition at line 211 of file referenceTemperature.C.

References heatExchangerModel::initialise().

Here is the call graph for this function:

◆ energyDensity()

Foam::tmp< Foam::scalarField > energyDensity ( const labelList & cells )

virtual

Return energy density per unit length [J/m3/m].

Implements heatExchangerModel.

Definition at line 218 of file referenceTemperature.C.

References cells, Foam::mag(), and heatExchangerModel::mesh_.

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Read top-level dictionary.

Implements heatExchangerModel.

Definition at line 241 of file referenceTemperature.C.

References heatExchangerModel::coeffs_, Foam::decrIndent(), dict, Foam::endl(), heatExchangerModel::faceZoneName_, Foam::incrIndent(), Foam::indent(), Foam::Info, heatExchangerModel::phiName_, heatExchangerModel::TName_, Foam::type(), and heatExchangerModel::UName_.

Here is the call graph for this function:

◆ write()

void write ( const bool log )

virtual

Write data to stream and files.

Implements heatExchangerModel.

Definition at line 277 of file referenceTemperature.C.

References Foam::decrIndent(), Foam::endl(), writeFile::file(), Foam::incrIndent(), Foam::indent(), Foam::Info, Foam::log(), UPstream::master(), heatExchangerModel::name_, Foam::nl, os(), Foam::tab, Foam::type(), and writeFile::writeCurrentTime().

Here is the call graph for this function:

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

src/fvOptions/sources/derived/heatExchangerSource/heatExchangerModels/referenceTemperature/referenceTemperature.H
src/fvOptions/sources/derived/heatExchangerSource/heatExchangerModels/referenceTemperature/referenceTemperature.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ referenceTemperature() [1/2]

◆ referenceTemperature() [2/2]

◆ ~referenceTemperature()

Member Function Documentation

◆ TypeName()

◆ operator=()

◆ initialise()

◆ energyDensity()

◆ read()

◆ write()