Loading...
Searching...
No Matches
wall Class Reference

This model computes the wall-heat flux at selected wall patches. More...

#include <wallHeatFlux_wall.H>

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

Public Member Functions

 TypeName ("wall")
 Runtime type information.
 wall (const dictionary &dict, const fvMesh &mesh, const word &name, const word objName, functionObjects::stateFunctionObject &state)
 Construct from components.
virtual ~wall ()=default
 Destructor.
const word & qrName () const noexcept
 Return const reference to name of radiative heat-flux field.
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.

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 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

This model computes the wall-heat flux at selected wall patches.

Usage
Minimal example by using system/controlDict.functions: 
wallHeatFlux1
{
    // Mandatory entries
    type        wallHeatFlux;
    libs        (fieldFunctionObjects);

    model       wall;

    // Optional entries
    patches     (<patch1> ... <patchN>); // (wall1 "(wall2|wall3)");
    qr          <word>;

    // Inherited entries
    ...
}

where the entries mean:

Property Description Type Reqd Deflt
type Type name: wallHeatFlux word yes -
libs Library name: fieldFunctionObjects word yes -
patches Names of operand patches wordList no all wall patches
qr Name of radiative heat flux field word no qr

The inherited entries are elaborated in:

Note
  • The model wall corresponds to wallHeatFlux in OpenFOAM v2506 and earlier versions.
Source files

Definition at line 118 of file wallHeatFlux_wall.H.

Constructor & Destructor Documentation

◆ wall()

wall ( 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:

◆ ~wall()

virtual ~wall ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "wall" )

Runtime type information.

◆ qrName()

const word & qrName ( ) const
inlinenoexcept

Return const reference to name of radiative heat-flux field.

Definition at line 189 of file wallHeatFlux_wall.H.

References Foam::noexcept.

◆ 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: