Calculates and write the heat-flux at wall patches as the volScalarField field 'wallHeatFlux'. More...

Inheritance diagram for wallHeatFlux:

Collaboration diagram for wallHeatFlux:

Public Member Functions
	TypeName ("wallHeatFlux")
	Runtime type information. More...

	wallHeatFlux (const word &name, const Time &runTime, const dictionary &)
	Construct from Time and dictionary. More...

virtual	~wallHeatFlux ()
	Destructor. More...

virtual bool	read (const dictionary &)
	Read the wallHeatFlux data. More...

virtual bool	execute ()
	Calculate the wall heat-flux. More...

virtual bool	write ()
	Write the wall heat-flux. More...

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

	fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

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

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

	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

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

template<class ObjectType >
const ObjectType *	lookupObjectPtr (const word &fieldName) const
	Deprecated(2018-10) More...

template<class ObjectType >
ObjectType *	lookupObjectRefPtr (const word &fieldName) const
	Deprecated(2018-10) More...

Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)
	Construct from components. More...

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

dictionary &	propertyDict ()
	Return access to the property dictionary. More...

bool	foundProperty (const word &entryName) const
	Return true if the property exists. More...

label	getTrigger () const
	Get the current trigger index. More...

bool	setTrigger (const label triggeri)
	Set the current trigger index. More...

bool	getDict (const word &entryName, dictionary &dict) const
	Set dictionary, return true if set. More...

bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
	Set dictionary from named object, return true if set. More...

template<class Type >
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property. More...

template<class Type >
bool	getProperty (const word &entryName, Type &value) const
	Set generic property, return true if set. More...

template<class Type >
void	setProperty (const word &entryName, const Type &value)
	Add generic property. More...

template<class Type >
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from named object. More...

template<class Type >
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const
	Set generic property from named object, return true if set. More...

template<class Type >
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)
	Add generic property from named object. More...

template<class Type >
void	setResult (const word &entryName, const Type &value)
	Add result. More...

template<class Type >
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)
	Add result from named object. More...

template<class Type >
Type	getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result. More...

template<class Type >
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result from named object. More...

template<class Type >
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const
	Set result from named object, return true if set. More...

word	resultType (const word &entryName) const
	Retrieve the result type. More...

word	objectResultType (const word &objectName, const word &entryName) const
	Return the type of result. More...

List< word >	objectResultEntries () const
	Retrieve the result entries. More...

List< word >	objectResultEntries (const word &objectName) const
	Return result entries for named object. More...

void	writeResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

void	writeResultEntries (const word &objectName, Ostream &os) const
	Write the results entries for named object to stream. More...

void	writeAllResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)
	Construct from Time. More...

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

const Time &	time () const
	Return time database. More...

objectRegistry &	storedObjects ()

const objectRegistry &	storedObjects () const

Public Member Functions inherited from functionObject
virtual const word &	type () const =0
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name)
	Construct from components. More...

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

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

const word &	name () const
	Return the name of this functionObject. More...

virtual bool	execute (const label subIndex)
	Execute using the specified subIndex. More...

virtual bool	end ()
	Called when Time::run() determines that the time-loop exits. More...

virtual bool	adjustTimeStep ()
	Called at the end of Time::adjustDeltaT() if adjustTime is true. More...

virtual bool	filesModified () const
	Did any file get changed during execution? More...

virtual void	updateMesh (const mapPolyMesh &mpm)
	Update for changes of mesh. More...

virtual void	movePoints (const polyMesh &mesh)
	Update for changes of mesh. More...

Public Member Functions inherited from writeFile
	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name="undefined", const bool writeToFile=true)
	Construct from objectRegistry, prefix, fileName. More...

	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name, const dictionary &dict, const bool writeToFile=true)

	writeFile (const writeFile &wf)
	Construct copy. More...

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

virtual OFstream &	file ()
	Return access to the file (if only 1) More...

virtual bool	writeToFile () const
	Flag to allow writing to file. More...

virtual label	charWidth () const
	Return width of character stream output. More...

virtual void	writeCommented (Ostream &os, const string &str) const
	Write a commented string to stream. More...

virtual void	writeTabbed (Ostream &os, const string &str) const
	Write a tabbed string to stream. More...

virtual void	writeHeader (Ostream &os, const string &str) const
	Write a commented header to stream. More...

virtual void	writeCurrentTime (Ostream &os) const
	Write the current time to stream. More...

virtual void	writeBreak (Ostream &os) const
	Write a break marker to the stream. More...

template<class Type >
void	writeHeaderValue (Ostream &os, const string &property, const Type &value) const
	Write a (commented) header property and value pair. More...

Protected Member Functions
virtual void	writeFileHeader (Ostream &os) const
	File header information. More...

void	calcHeatFlux (const volScalarField &alpha, const volScalarField &he, volScalarField &wallHeatFlux)
	Calculate the heat-flux. More...

Protected Member Functions inherited from fvMeshFunctionObject
	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	No copy construct. More...

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

Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry &	obr () const
	The region or sub-region registry being used. More...

template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find object (eg, a field) in the (sub) objectRegistry. More...

template<class ObjectType >
const ObjectType *	cfindObject (const word &fieldName) const

template<class ObjectType >
const ObjectType *	findObject (const word &fieldName) const

template<class ObjectType >
ObjectType *	findObject (const word &fieldName)

template<class ObjectType >
ObjectType *	getObjectPtr (const word &fieldName) const

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry. More...

template<class ObjectType >
bool	store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
	Store the field in the (sub) objectRegistry under the given name. More...

bool	writeObject (const word &fieldName)
	Write field if present in the (sub) objectRegistry. More...

bool	clearObject (const word &fieldName)
	Clear field from the (sub) objectRegistry if present. More...

void	clearObjects (const wordList &objNames)
	Clear fields from the (sub) objectRegistry if present. More...

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

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

Protected Member Functions inherited from stateFunctionObject
const IOdictionary &	stateDict () const
	Return a const reference to the state dictionary. More...

IOdictionary &	stateDict ()
	Return non-const access to the state dictionary. More...

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

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

Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)
	Remove specified items from "functionObjectObjects". More...

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

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

Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
	Return a scoped name, e.g. used to construct local field names. More...

Protected Member Functions inherited from writeFile
void	initStream (Ostream &os) const
	Initialise the output stream for writing. More...

fileName	baseFileDir () const
	Return the base directory for output. More...

fileName	baseTimeDir () const
	Return the base directory for the current time value. More...

virtual autoPtr< OFstream >	createFile (const word &name, scalar timeValue) const
	Return autoPtr to a new file for a given time. More...

virtual autoPtr< OFstream >	createFile (const word &name) const
	Return autoPtr to a new file using the simulation start time. More...

virtual void	resetFile (const word &name)
	Reset internal file pointer to new file with new name. More...

Omanip< int >	valueWidth (const label offset=0) const
	Return the value width when writing to stream with optional offset. More...

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

Protected Attributes
labelHashSet	patchSet_
	Optional list of patches to process. More...

word	qrName_
	Name of radiative heat flux name, default = qr. More...

Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
	Reference to the fvMesh. More...

Protected Attributes inherited from regionFunctionObject
word	subRegistryName_
	Name for alternative object registry. More...

const objectRegistry &	obr_
	Reference to the region objectRegistry. More...

const objectRegistry *	obrPtr_
	Pointer to alternative (eg, sub-region) objectRegistry. More...

Protected Attributes inherited from timeFunctionObject
const Time &	time_
	Reference to the time database. More...

Protected Attributes inherited from writeFile
const objectRegistry &	fileObr_
	Reference to the region objectRegistry. More...

const fileName	prefix_
	Prefix. More...

word	fileName_
	Name of file. More...

autoPtr< OFstream >	filePtr_
	File pointer. More...

label	writePrecision_
	Write precision. More...

bool	writeToFile_
	Flag to enable/disable writing to file. More...

bool	writtenHeader_
	Flag to identify whether the header has been written. More...

bool	useUserTime_

scalar	startTime_
	Start time value. More...

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &runTime, const dictionary &dict)
	Select from dictionary, based on its "type" entry. More...

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

Static Public Attributes inherited from functionObject
static int	debug

static bool	postProcess
	Global post-processing mode switch. More...

static word	outputPrefix
	Directory prefix. More...

Static Public Attributes inherited from writeFile
static label	addChars = 8
	Additional characters for writing. More...

Detailed Description

Calculates and write the heat-flux at wall patches as the volScalarField field 'wallHeatFlux'.

All wall patches are included by default; to restrict the calculation to certain patches, use the optional 'patches' entry.

Usage

Example of function object specification:

wallHeatFlux1
{
    type        wallHeatFlux;
    libs        ("libfieldFunctionObjects.so");
    ...
    region      fluid;
    patches     (".*Wall");
}

Where the entries comprise:

Property	Description	Required	Default value
`type`	type name: wallHeatFlux	yes
`patches`	list of patches to process	no	all wall patches
`qr`	name of radiative heat flux field	no	qr
`region`	region to be evaluated	no	default region

See also: Foam::functionObject Foam::functionObjects::fvMeshFunctionObject Foam::functionObjects::writeFile Foam::functionObjects::timeControl

Source files

Definition at line 116 of file wallHeatFlux.H.

Constructor & Destructor Documentation

◆ wallHeatFlux()

wallHeatFlux	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict
	)

Construct from Time and dictionary.

Definition at line 106 of file wallHeatFlux.C.

References dict, Foam::dimMass, Foam::dimTime, IOobject::NO_READ, IOobject::NO_WRITE, Foam::pow3(), Foam::read(), Foam::type(), and Foam::Zero.

Here is the call graph for this function:

◆ ~wallHeatFlux()

~wallHeatFlux ( )

virtual

Destructor.

Definition at line 144 of file wallHeatFlux.C.

Member Function Documentation

◆ writeFileHeader()

void writeFileHeader ( Ostream & os ) const

protectedvirtual

File header information.

Definition at line 52 of file wallHeatFlux.C.

References Foam::endl(), writeFile::writeCommented(), writeFile::writeHeader(), and writeFile::writeTabbed().

Here is the call graph for this function:

◆ calcHeatFlux()

void calcHeatFlux	(	const volScalarField &	alpha,
		const volScalarField &	he,
		volScalarField &	wallHeatFlux
	)

protected

Calculate the heat-flux.

Definition at line 66 of file wallHeatFlux.C.

References Foam::constant::atomic::alpha, GeometricField< Type, PatchField, GeoMesh >::boundaryField(), forAll, and he.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "wallHeatFlux" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the wallHeatFlux data.

Reimplemented from writeFile.

Definition at line 150 of file wallHeatFlux.C.

References dict, Foam::endl(), forAll, Foam::Info, HashSet< Key, Hash >::insert(), IOobject::name(), Foam::name(), Foam::nl, polyBoundaryMesh::patchSet(), writeFile::read(), regionFunctionObject::read(), Foam::type(), and WarningInFunction.

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Calculate the wall heat-flux.

Implements functionObject.

Definition at line 207 of file wallHeatFlux.C.

References ThermalDiffusivity< BasicTurbulenceModel >::alphaEff(), dictionary::dictName(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, turbulenceModel::propertiesName, and Foam::type().

Here is the call graph for this function:

◆ write()

bool write ( )

virtual

Write the wall heat-flux.

Implements functionObject.

Definition at line 262 of file wallHeatFlux.C.

References Foam::endl(), Foam::gMax(), Foam::gMin(), Foam::gSum(), Log, UPstream::master(), fvPatch::name(), functionObject::name(), Foam::name(), Foam::nl, patches, token::TAB, Foam::type(), and wallHeatFlux::write().

Referenced by wallHeatFlux::write().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ patchSet_

labelHashSet patchSet_

protected

Optional list of patches to process.

Definition at line 127 of file wallHeatFlux.H.

◆ qrName_

word qrName_

protected

Name of radiative heat flux name, default = qr.

Definition at line 130 of file wallHeatFlux.H.

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

src/functionObjects/field/wallHeatFlux/wallHeatFlux.H
src/functionObjects/field/wallHeatFlux/wallHeatFlux.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ wallHeatFlux()

◆ ~wallHeatFlux()

Member Function Documentation

◆ writeFileHeader()

◆ calcHeatFlux()

◆ TypeName()

◆ read()

◆ execute()

◆ write()

Member Data Documentation

◆ patchSet_

◆ qrName_