Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
wallHeatFlux Class Reference

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

Inheritance diagram for wallHeatFlux:
Inheritance graph
[legend]
Collaboration diagram for wallHeatFlux:
Collaboration graph
[legend]

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 ()
 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 ()
 Destructor. More...
 
- Public Member Functions inherited from functionObject
virtual const wordtype () 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< functionObjectclone () const
 Return clone. More...
 
virtual ~functionObject ()
 Destructor. More...
 
const wordname () const
 Return the name of this functionObject. More...
 
virtual bool end ()
 Called when Time::run() determines that the time-loop exits. More...
 
virtual bool setTimeStep ()
 Called by Time::setDeltaT(). Allows the function object to override. More...
 
virtual scalar timeToNextWrite ()
 Called by Time::adjustTimeStep(). Allows the function object to. 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 logFiles
 logFiles (const objectRegistry &obr, const word &prefix)
 Construct from objectRegistry and prefix. More...
 
virtual ~logFiles ()
 Destructor. More...
 
const wordListnames () const
 Return const access to the names. More...
 
PtrList< OFstream > & files ()
 Return access to the files. More...
 
OFstreamfile ()
 Return access to the file (if only 1) More...
 
OFstreamfile (const label i)
 Return file 'i'. More...
 
- Public Member Functions inherited from writeFile
 writeFile (const objectRegistry &obr, const word &prefix)
 Construct from objectRegistry and prefix. More...
 
 ~writeFile ()
 Destructor. More...
 
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...
 
Omanip< int > valueWidth (const label offset=0) const
 Return the value width when writing to stream with optional offset. More...
 
void writeCommented (Ostream &os, const string &str) const
 Write a commented string to stream. More...
 
void writeTabbed (Ostream &os, const string &str) const
 Write a tabbed string to stream. More...
 
void writeHeader (Ostream &os, const string &str) const
 Write a commented header to stream. More...
 
void writeTime (Ostream &os) const
 Write the current time to 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...
 
label charWidth () const
 Return width of character stream output. More...
 
- Public Member Functions inherited from writeLocalObjects
 writeLocalObjects (const objectRegistry &obr, const Switch &logRef)
 Construct from objectRegistry and inheriting function object. More...
 
virtual ~writeLocalObjects ()
 Destructor. More...
 
const wordListlocalObjectNames () const
 Return const access to the local object names. More...
 
- Public Member Functions inherited from writeObjectsBase
 writeObjectsBase (const objectRegistry &obr, const Switch &logRef)
 Construct from objectRegistry and inheriting function object. More...
 
virtual ~writeObjectsBase ()
 Destructor. More...
 
const wordReListwriteObjectNames () const
 Return const access to the object names requested to be written. More...
 

Protected Member Functions

virtual void writeFileHeader (const label i)
 File header information. More...
 
tmp< volScalarFieldcalcWallHeatFlux (const volScalarField &alpha, const volScalarField &he)
 Calculate the heat-flux. More...
 
- Protected Member Functions inherited from regionFunctionObject
template<class ObjectType >
bool foundObject (const word &fieldName) const
 Find field in the objectRegistry. More...
 
template<class ObjectType >
const ObjectType & lookupObject (const word &fieldName) const
 Lookup object from the objectRegistry. More...
 
template<class ObjectType >
ObjectType & lookupObjectRef (const word &fieldName)
 Lookup non-const object reference from the objectRegistry. More...
 
template<class ObjectType >
bool store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
 Store the given field in the objectRegistry under the given name. More...
 
bool writeObject (const word &fieldName)
 Write field if present in objectRegistry. More...
 
bool clearObject (const word &fieldName)
 Clear field from the objectRegistry if present. More...
 
- Protected Member Functions inherited from logFiles
virtual void createFiles ()
 Create the output file. More...
 
virtual void resetNames (const wordList &names)
 Reset the list of names from a wordList. More...
 
virtual void resetName (const word &name)
 Reset the list of names to a single name entry. More...
 
- Protected Member Functions inherited from writeLocalObjects
void resetLocalObjectName (const word &name)
 Reset the list of local object names from a single word. More...
 
void resetLocalObjectNames (const wordList &names)
 Reset the list of local object names from a wordList. More...
 
virtual wordList objectNames ()
 Get the list of field names to be written. More...
 
- Protected Member Functions inherited from writeObjectsBase
void resetWriteObjectName (const wordRe &name)
 Reset the list of object names to be written to a single regular. More...
 
void resetWriteObjectNames (const wordReList &names)
 Reset the list of object names to be written. More...
 
virtual void writeObject (const regIOobject &obj)
 Write the requested registered IO object. More...
 

Protected Attributes

labelHashSet patchSet_
 Optional list of patches to process. More...
 
- Protected Attributes inherited from fvMeshFunctionObject
const fvMeshmesh_
 Reference to the fvMesh. More...
 
- Protected Attributes inherited from regionFunctionObject
const Timetime_
 Reference to the Time. More...
 
const objectRegistryobr_
 Reference to the region objectRegistry. More...
 
- Protected Attributes inherited from logFiles
wordList names_
 File names. More...
 
PtrList< OFstreamfilePtrs_
 File pointer. More...
 
- Protected Attributes inherited from writeFile
const objectRegistryfileObr_
 Reference to the region objectRegistry. More...
 
const word prefix_
 Prefix. More...
 
- Protected Attributes inherited from writeLocalObjects
wordList localObjectNames_
 Object names that are handled on behalf of the inheritor. More...
 
- Protected Attributes inherited from writeObjectsBase
const objectRegistrywriteObr_
 Reference to the region objectRegistry. More...
 
const Switchlog_
 Reference to the inheriting function object's log variable. More...
 
wordReList writeObjectNames_
 Object names requested by the user to be written. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from functionObject
static autoPtr< functionObjectNew (const word &name, const Time &, const dictionary &)
 Select from dictionary, based on its "type" entry. More...
 
- Public Attributes inherited from functionObject
Switch 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 Public Attributes inherited from writeFile
static const word outputPrefix
 Directory prefix. More...
 
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.

Example of function object specification:

wallHeatFlux1
{
    type        wallHeatFlux;
    libs        ("libfieldFunctionObjects.so");
    ...
    region      fluid;
    patches     (".*Wall");
}
Usage
Property Description Required Default value
type type name: wallHeatFlux yes
patches list of patches to process no all wall patches
region region to be evaluated no default region
Note
Writing field 'wallHeatFlux' is done by default, but it can be overridden by defining an empty objects list. For details see writeLocalObjects.
See also
Foam::functionObject Foam::functionObjects::fvMeshFunctionObject Foam::functionObjects::logFiles Foam::functionObjects::writeLocalObjects Foam::functionObjects::timeControl
Source files

Definition at line 109 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 123 of file wallHeatFlux.C.

References Foam::read().

Here is the call graph for this function:

◆ ~wallHeatFlux()

~wallHeatFlux ( )
virtual

Destructor.

Definition at line 142 of file wallHeatFlux.C.

Member Function Documentation

◆ writeFileHeader()

void writeFileHeader ( const label  i)
protectedvirtual

File header information.

Implements logFiles.

Definition at line 48 of file wallHeatFlux.C.

References wallHeatFlux::calcWallHeatFlux(), Foam::endl(), and Foam::file.

Here is the call graph for this function:

◆ calcWallHeatFlux()

Foam::tmp< Foam::volScalarField > calcWallHeatFlux ( const volScalarField alpha,
const volScalarField he 
)
protected

Calculate the heat-flux.

Definition at line 63 of file wallHeatFlux.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), Foam::dimMass, Foam::dimTime, forAll, patchi, Foam::pow3(), tmp< T >::ref(), and Foam::type().

Referenced by wallHeatFlux::writeFileHeader().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ TypeName()

TypeName ( "wallHeatFlux"  )

Runtime type information.

◆ read()

bool read ( const dictionary dict)
virtual

◆ execute()

bool execute ( )
virtual

◆ write()

bool write ( )
virtual

Member Data Documentation

◆ patchSet_

labelHashSet patchSet_
protected

Optional list of patches to process.

Definition at line 121 of file wallHeatFlux.H.


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