Base class for heat exchanger models to handle various characteristics for the heatExchangerSource fvOption. More...

#include <heatExchangerModel.H>

Inheritance diagram for heatExchangerModel:

[legend]

Collaboration diagram for heatExchangerModel:

[legend]

Public Member Functions
	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.
virtual void	initialise ()
	Initialise data members of the model.
virtual tmp< scalarField >	energyDensity (const labelList &cells)=0
	Return energy density per unit length [J/m3/m].
virtual bool	read (const dictionary &dict)=0
	Read top-level dictionary.
virtual void	write (const bool log)=0
	Write data to stream and files.
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.

Static Public Member Functions
static autoPtr< heatExchangerModel >	New (const fvMesh &mesh, const word &name, const dictionary &coeffs)
	Return a reference to the selected heat exchanger model.

Protected Attributes
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.

Additional Inherited Members
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.

Detailed Description

Base class for heat exchanger models to handle various characteristics for the heatExchangerSource fvOption.

Source files

Definition at line 56 of file heatExchangerModel.H.

Constructor & Destructor Documentation

◆ heatExchangerModel() [1/2]

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

Construct from components.

Definition at line 36 of file heatExchangerModel.C.

References coeffs_, faceId_, facePatchId_, faceSign_, faceZoneName_, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, mesh, mesh_, Foam::name(), name_, phiName_, TName_, UName_, and writeFile::writeFile().

Referenced by declareRunTimeSelectionTable(), effectivenessTable::effectivenessTable(), heatExchangerModel(), operator=(), and referenceTemperature::referenceTemperature().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ heatExchangerModel() [2/2]

heatExchangerModel ( const heatExchangerModel & )

delete

No copy construct.

References heatExchangerModel().

Here is the call graph for this function:

◆ ~heatExchangerModel()

virtual ~heatExchangerModel ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "heatExchangerModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		heatExchangerModel	,
		dictionary	,
		(const fvMesh &mesh, const word &name, const dictionary &coeffs)	,
		(mesh, name, coeffs)	)

References heatExchangerModel(), mesh, and Foam::name().

Here is the call graph for this function:

◆ New()

Foam::autoPtr< Foam::heatExchangerModel > New	(	const fvMesh &	mesh,
		const word &	name,
		const dictionary &	coeffs )

static

Return a reference to the selected heat exchanger model.

Definition at line 25 of file heatExchangerModelNew.C.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, dictionary::get(), mesh, and Foam::name().

Referenced by referenceTemperature::referenceTemperature().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

void operator= ( const heatExchangerModel & )

delete

No copy assignment.

References heatExchangerModel().

Here is the call graph for this function:

◆ U()

virtual const word & U ( ) const

inlinevirtual

Return const reference to the name of velocity field.

Definition at line 188 of file heatExchangerModel.H.

References UName_.

Referenced by effectivenessTable::energyDensity().

Here is the caller graph for this function:

◆ initialise()

void initialise ( )

virtual

Initialise data members of the model.

Reimplemented in effectivenessTable, and referenceTemperature.

Definition at line 59 of file heatExchangerModel.C.

References Foam::exit(), faceId(), faceId_, facePatchId_, faceSign_, faceZoneName_, Foam::FatalError, FatalErrorInFunction, faceZone::flipMap(), forAll, Foam::isA(), mesh_, name_, pp(), UList< T >::size(), and Foam::type().

Referenced by effectivenessTable::initialise(), and referenceTemperature::initialise().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ energyDensity()

virtual tmp< scalarField > energyDensity ( const labelList & cells )

pure virtual

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

Implemented in effectivenessTable, and referenceTemperature.

References cells.

◆ read()

virtual bool read ( const dictionary & dict )

pure virtual

Read top-level dictionary.

Reimplemented from writeFile.

Implemented in effectivenessTable, and referenceTemperature.

References dict.

◆ write()

virtual void write ( const bool log )

pure virtual

Write data to stream and files.

Implemented in effectivenessTable, and referenceTemperature.

References Foam::log().

Here is the call graph for this function:

Member Data Documentation

◆ mesh_

const fvMesh& mesh_

protected

Reference to the mesh.

Definition at line 67 of file heatExchangerModel.H.

Referenced by effectivenessTable::energyDensity(), referenceTemperature::energyDensity(), heatExchangerModel(), initialise(), and referenceTemperature::referenceTemperature().

◆ coeffs_

const dictionary& coeffs_

protected

Dictionary containing coefficients specific to the chosen model.

Definition at line 72 of file heatExchangerModel.H.

Referenced by heatExchangerModel(), effectivenessTable::initialise(), effectivenessTable::read(), and referenceTemperature::read().

◆ name_

const word& name_

protected

Reference to the name of the fvOption source.

Definition at line 77 of file heatExchangerModel.H.

Referenced by heatExchangerModel(), initialise(), effectivenessTable::write(), and referenceTemperature::write().

◆ UName_

word UName_

protected

Name of operand velocity field.

Definition at line 82 of file heatExchangerModel.H.

Referenced by effectivenessTable::energyDensity(), heatExchangerModel(), effectivenessTable::read(), referenceTemperature::read(), and U().

◆ TName_

word TName_

protected

Name of operand temperature field.

Definition at line 87 of file heatExchangerModel.H.

Referenced by effectivenessTable::energyDensity(), heatExchangerModel(), effectivenessTable::read(), and referenceTemperature::read().

◆ phiName_

word phiName_

protected

Name of operand flux field.

Definition at line 92 of file heatExchangerModel.H.

Referenced by effectivenessTable::energyDensity(), heatExchangerModel(), effectivenessTable::read(), and referenceTemperature::read().

◆ faceZoneName_

word faceZoneName_

protected

Name of the faceZone at the heat exchanger inlet.

Definition at line 97 of file heatExchangerModel.H.

Referenced by heatExchangerModel(), initialise(), effectivenessTable::read(), and referenceTemperature::read().

◆ faceId_

labelList faceId_

protected

Local list of face IDs.

Definition at line 102 of file heatExchangerModel.H.

Referenced by effectivenessTable::energyDensity(), heatExchangerModel(), and initialise().

◆ facePatchId_

labelList facePatchId_

protected

Local list of patch IDs per face.

Definition at line 107 of file heatExchangerModel.H.

Referenced by effectivenessTable::energyDensity(), heatExchangerModel(), and initialise().

◆ faceSign_

labelList faceSign_

protected

List of +1/-1 representing face flip map (1 use as is, -1 negate).

Definition at line 112 of file heatExchangerModel.H.

Referenced by effectivenessTable::energyDensity(), heatExchangerModel(), and initialise().

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

src/fvOptions/sources/derived/heatExchangerSource/heatExchangerModels/heatExchangerModel/heatExchangerModel.H
src/fvOptions/sources/derived/heatExchangerSource/heatExchangerModels/heatExchangerModel/heatExchangerModel.C
src/fvOptions/sources/derived/heatExchangerSource/heatExchangerModels/heatExchangerModel/heatExchangerModelNew.C

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ heatExchangerModel() [1/2]

◆ heatExchangerModel() [2/2]

◆ ~heatExchangerModel()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New()

◆ operator=()

◆ U()

◆ initialise()

◆ energyDensity()

◆ read()

◆ write()

Member Data Documentation

◆ mesh_

◆ coeffs_

◆ name_

◆ UName_

◆ TName_

◆ phiName_

◆ faceZoneName_

◆ faceId_

◆ facePatchId_

◆ faceSign_