This model computes the wall-heat flux at a selected patch using imaginary heat-flux gauges. More...

#include <wallHeatFlux_gauge.H>

Inheritance diagram for gauge:

[legend]

Collaboration diagram for gauge:

[legend]

Public Member Functions
	TypeName ("gauge")
	Runtime type information.
	gauge (const dictionary &dict, const fvMesh &mesh, const word &name, const word objName, functionObjects::stateFunctionObject &state)
	Construct from components.
virtual	~gauge ()=default
	Destructor.
virtual bool	read (const dictionary &dict)
	Read the settings.
virtual bool	execute ()
	Calculate the heat-flux data.
virtual bool	write ()
	Write the heat-flux data.
Public Member Functions inherited from wallHeatFluxModel
	TypeName ("wallHeatFluxModel")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, wallHeatFluxModel, dictionary,(const dictionary &dict, const fvMesh &mesh, const word &name, const word objName, functionObjects::stateFunctionObject &state),(dict, mesh, name, objName, state))
	wallHeatFluxModel (const wallHeatFluxModel &)=delete
	No copy construct.
void	operator= (const wallHeatFluxModel &)=delete
	No copy assignment.
	wallHeatFluxModel (const dictionary &dict, const fvMesh &mesh, const word &name, const word objName, functionObjects::stateFunctionObject &state)
	Construct from components.
virtual	~wallHeatFluxModel ()
	Destructor.
const fvMesh &	mesh () const noexcept
	Return const reference to the mesh.
functionObjects::stateFunctionObject &	state () const noexcept
	Return const reference to the state function object.
const word &	objName () const noexcept
	Return const reference to the function-object name.
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.
Public Member Functions inherited from patchFieldProbe
	TypeName ("patchFieldProbe")
	Runtime type information.
	patchFieldProbe (const fvMesh &mesh, const dictionary &dict)
	Construct from Time and dictionary.
virtual	~patchFieldProbe ()=default
	Destructor.
const labelList &	patchIDs () const noexcept
	Return the index of the patches to sample.
template<class Type>
tmp< Field< Type > >	sample (const VolumeField< Type > &) const
	Sample a volume field at all locations.
template<class Type>
tmp< Field< Type > >	sample (const SurfaceField< Type > &) const
	Sample a surface field at all locations.
template<class Type>
tmp< Field< Type > >	sample (const word &fieldName) const
	Sample a volume field at all locations.
template<class Type>
tmp< Field< Type > >	sampleSurfaceField (const word &fieldName) const
	Sample a surface field at all locations.
Public Member Functions inherited from probeModel
	TypeName ("probeModel")
	Runtime type information.
	probeModel (const probeModel &)=delete
	No copy construct.
void	operator= (const probeModel &)=delete
	No copy assignment.
	probeModel (const fvMesh &mesh, const dictionary &dict)
	Construct from Time and dictionary.
virtual	~probeModel ()=default
	Destructor.
bool	empty () const
	Return true if no probe locations.
label	size () const
	Return number of probe locations.
bool	fixedLocations () const
	Return true if fixed locations.
bool	includeOutOfBounds () const
	Return true if include out of bounds probes.
const word &	samplePointScheme () const
	Return the interpolation scheme to obtain values at the points.
const pointField &	probeLocations () const
	Return const reference to the probe locations.
pointField &	probeLocations ()
	Return reference to the probe locations.
const point &	probe (const label i) const
	Return the location of probe i.
const labelList &	elements () const
	Cells to be probed (obtained from the locations).
const labelList &	faces () const
	Return const reference to the faces to be probed.
const labelList &	processors () const
	Return const reference to the processor list.
const labelList &	patchIDList () const noexcept
	Return const reference to the patch ID list.
const pointField &	oldPoints () const noexcept
	Return const reference to the original probe locations.
virtual void	updateMesh (const mapPolyMesh &)
	Update for changes of mesh.
virtual void	movePoints (const polyMesh &)
	Update for changes of mesh.

Additional Inherited Members
Static Public Member Functions inherited from wallHeatFluxModel
static autoPtr< wallHeatFluxModel >	New (const dictionary &dict, const fvMesh &mesh, const word &name, const word objName, functionObjects::stateFunctionObject &state)
	Return a reference to the selected heat-flux 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 Member Functions inherited from patchFieldProbe
virtual void	findElements (const fvMesh &mesh)
	Find elements containing patchFieldProbe.
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.
Protected Attributes inherited from patchFieldProbe
wordRes	patchNames_
	Names of the patches to sample.
labelList	patchIDs_
	Index of the patches to sample.
Protected Attributes inherited from probeModel
const fvMesh &	thisMesh_
	Const reference to the mesh.
bool	fixedLocations_
	Fixed locations (default: true).
bool	includeOutOfBounds_
	Include probes that were not found (default: true).
word	samplePointScheme_
	Interpolation/sample scheme to obtain values at the points.
pointField	probes_
	Probe locations.
labelList	cellIds_
	Cells to be probed (obtained from the locations).
labelList	faceIds_
	Faces to be probed.
labelList	procIds_
	Processor holding the cell or face (-1 if point not found on any processor).
labelList	patchIds_
	Patch IDs on which the new probes are located.
pointField	oldPoints_
	Original probes location.

Detailed Description

This model computes the wall-heat flux at a selected patch using imaginary heat-flux gauges.

Heat-flux gauges are measurement tools that are placed on walls. The temperature of the gauges is usually different from that of the surrounding wall - an order of magnitude lower. The model allows the user to specify the gauge temperature and other gauge properties such as absorptivity or emissivity without creating separate patches. The model calculates the net convective and radiative heat fluxes at the gauge locations, combines them, and writes the results to the output files.

Usage

Minimal example by using system/controlDict.functions:

wallHeatFlux1
{
    // Mandatory entries
    type        wallHeatFlux;
    libs        (fieldFunctionObjects);

    model       gauge;

    Tgauge      <scalar>;
    patch       <word>;

    // Optional entries
    absorptivity  <scalar>;
    emissivity    <scalar>;
    T             <word>;
    qin           <word>;
    alphat        <word>;
    convective    <bool>;
    radiative     <bool>;
    writeFields   <bool>;

    // Inherited entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`type`	Type name: wallHeatFlux	word	yes	-
`libs`	Library name: fieldFunctionObjects	word	yes	-
`model`	Model name: gauge	word	no	wall
`Tgauge`	Gauge temperature (K)	scalar	yes	-
`patch`	Name of the patch to probe	word	yes	-
`absorptivity`	Absorptivity of the gauge	scalar	no	1
`emissivity`	Emissivity of the gauge	scalar	no	1
`T`	Name of the temperature field	word	no	T
`qin`	Name of the incident radiative heat flux field	word	no	qin
`alphat`	Name of turbulent thermal diffusivity field	word	no	alphat
`convective`	Calculate convective heat flux	bool	no	false
`radiative`	Calculate radiative heat flux	bool	no	false
`writeFields`	Write the fields to file	bool	no	false

The inherited entries are elaborated in:

Source files

wallHeatFlux_gauge.H wallHeatFlux_
gauge.cxx

Definition at line 199 of file wallHeatFlux_gauge.H.

Constructor & Destructor Documentation

◆ gauge()

gauge	(	const dictionary &	dict,
		const fvMesh &	mesh,
		const word &	name,
		const word	objName,
		functionObjects::stateFunctionObject &	state )

Construct from components.

References dict, wallHeatFluxModel::mesh(), Foam::name(), wallHeatFluxModel::objName(), and wallHeatFluxModel::state().

Here is the call graph for this function:

◆ ~gauge()

virtual ~gauge ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "gauge" )

Runtime type information.

◆ read()

virtual bool read ( const dictionary & dict )

virtual

Read the settings.

Implements wallHeatFluxModel.

References dict.

◆ execute()

virtual bool execute ( )

virtual

Calculate the heat-flux data.

Implements wallHeatFluxModel.

◆ write()

virtual bool write ( )

virtual

Write the heat-flux data.

Implements wallHeatFluxModel.

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

src/functionObjects/field/wallHeatFlux/wallHeatFluxModels/gauge/wallHeatFlux_gauge.H

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ gauge()

◆ ~gauge()

Member Function Documentation

◆ TypeName()

◆ read()

◆ execute()

◆ write()