Loading...
Searching...
No Matches
energyTransport Class Reference
FunctionObjects » Solver function objects

Computes the simplified energy transport equation in single-phase or two-phase flow, considering incompressible cases: More...

#include <energyTransport.H>

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

Public Member Functions

 TypeName ("energyTransport")
 Runtime type information.
 energyTransport (const word &name, const Time &runTime, const dictionary &dict)
 Construct from name, Time and dictionary.
virtual ~energyTransport ()=default
 Destructor.
virtual bool read (const dictionary &)
 Read the function-object dictionary.
virtual bool execute ()
 Execute the function-object operations.
virtual bool write ()
 Write the function object output.
Public Member Functions inherited from fvMeshFunctionObject
 TypeName ("fvMeshFunctionObject")
 Runtime type information.
 fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary.
 fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
 Construct from the region objectRegistry and dictionary.
virtual ~fvMeshFunctionObject ()=default
 Destructor.
Public Member Functions inherited from regionFunctionObject
 TypeName ("regionFunctionObject")
 Runtime type information.
 regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary.
 regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
 Construct from the region objectRegistry and dictionary.
virtual ~regionFunctionObject ()=default
 Destructor.
template<class ObjectType>
const ObjectType * lookupObjectPtr (const word &fieldName) const
 Deprecated(2018-10).
template<class ObjectType>
ObjectType * lookupObjectRefPtr (const word &fieldName) const
 Deprecated(2018-10).
Public Member Functions inherited from stateFunctionObject
 stateFunctionObject (const word &name, const Time &runTime)
 Construct from components.
virtual ~stateFunctionObject ()=default
 Destructor.
dictionary & propertyDict ()
 Return access to the property dictionary.
bool foundProperty (const word &entryName) const
 Return true if the property exists.
void clearTrigger ()
 Remove the trigger index from the properties.
label getTrigger () const
 Get the current trigger index.
bool setTrigger (const label triggeri)
 Set new trigger index.
bool getDict (const word &entryName, dictionary &dict) const
 Set dictionary, return true if set.
bool getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
 Set dictionary from named object, return true if set.
template<class Type>
Type getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
 Retrieve generic property.
template<class Type>
bool getProperty (const word &entryName, Type &value) const
 Set generic property, return true if set.
template<class Type>
void setProperty (const word &entryName, const Type &value)
 Add generic property.
template<class Type>
Type getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
 Retrieve generic property from named object.
template<class Type>
bool getObjectProperty (const word &objectName, const word &entryName, Type &value) const
 Set generic property from named object, return true if set.
template<class Type>
void setObjectProperty (const word &objectName, const word &entryName, const Type &value)
 Add generic property from named object.
bool getObjectResultDict (const word &objectName, dictionary &dict) const
template<class Type>
void setResult (const word &entryName, const Type &value)
 Add result.
template<class Type>
void setObjectResult (const word &objectName, const word &entryName, const Type &value)
 Add result from named object.
template<class Type>
Type getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const
 Retrieve result.
template<class Type>
Type getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
 Retrieve result from named object.
template<class Type>
bool getObjectResult (const word &objectName, const word &entryName, Type &value) const
 Set result from named object, return true if set.
word resultType (const word &entryName) const
 Retrieve the result type.
word objectResultType (const word &objectName, const word &entryName) const
 Return the type of result.
wordList objectResultEntries () const
 Retrieve the result entries.
wordList objectResultEntries (const word &objectName) const
 Return result entries for named object.
void writeResultEntries (Ostream &os) const
 Write the results entries for all objects to stream.
void writeResultEntries (const word &objectName, Ostream &os) const
 Write the results entries for named object to stream.
void writeAllResultEntries (Ostream &os) const
 Write the results entries for all objects to stream.
Public Member Functions inherited from timeFunctionObject
 timeFunctionObject (const word &name, const Time &runTime)
 Construct from Time.
virtual ~timeFunctionObject ()=default
 Destructor.
const Time & time () const
 Return time database.
objectRegistry & storedObjects ()
 Write access to the output objects ("functionObjectObjects") registered on Time.
const objectRegistry & storedObjects () const
 Const access to the output objects ("functionObjectObjects") registered on Time.
Public Member Functions inherited from functionObject
 declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))
 functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix)
 Construct from components.
autoPtr< functionObject > clone () const
 Return clone.
virtual ~functionObject ()=default
 Destructor.
virtual const word & type () const =0
 Runtime type information.
const word & name () const noexcept
 Return the name of this functionObject.
bool useNamePrefix () const noexcept
 Return the flag for adding a scoping name prefix.
bool useNamePrefix (bool on) noexcept
 Modify the flag for adding a scoping name prefix.
virtual bool execute (const label subIndex)
 Execute using the specified subIndex.
virtual bool end ()
 Called when Time::run() determines that the time-loop exits.
virtual bool adjustTimeStep ()
 Called at the end of Time::adjustDeltaT() if adjustTime is true.
virtual bool filesModified () const
 Did any file get changed during execution?
virtual void updateMesh (const mapPolyMesh &mpm)
 Update for changes of mesh.
virtual void movePoints (const polyMesh &mesh)
 Update for changes of mesh.

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.
Public Attributes inherited from functionObject
bool log
 Flag to write log into Info.
Static Public Attributes inherited from functionObject
static int debug
 Flag to execute debug content.
static bool postProcess
 Global post-processing mode switch.
static bool defaultUseNamePrefix
 Global default for useNamePrefix.
static word outputPrefix
 Directory prefix.
Protected Member Functions inherited from fvMeshFunctionObject
 fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
 No copy construct.
void operator= (const fvMeshFunctionObject &)=delete
 No copy assignment.
Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry & obr () const
 The region or sub-region registry being used.
template<class ObjectType>
bool foundObject (const word &fieldName) const
 Find object (eg, a field) in the (sub) objectRegistry.
template<class ObjectType>
const ObjectType * cfindObject (const word &fieldName) const
 Return const pointer to the object (eg, a field) in the (sub) objectRegistry.
template<class ObjectType>
const ObjectType * findObject (const word &fieldName) const
 Return const pointer to the object (eg, a field) in the (sub) objectRegistry.
template<class ObjectType>
ObjectType * findObject (const word &fieldName)
 Return non-const pointer to the object of the given Type, (sub) objectRegistry.
template<class ObjectType>
ObjectType * getObjectPtr (const word &fieldName) const
 Return non-const pointer to the object of the given Type, using a const-cast to have it behave like a mutable.
template<class ObjectType>
const ObjectType & lookupObject (const word &fieldName) const
 Lookup and return object (eg, a field) from the (sub) objectRegistry.
template<class ObjectType>
ObjectType & lookupObjectRef (const word &fieldName) const
 Lookup and return object (eg, a field) from the (sub) objectRegistry.
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.
template<class ObjectType>
bool storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr)
 Store the field in an optional objectRegistry under the given name.
bool writeObject (const word &fieldName)
 Write field if present in the (sub) objectRegistry.
bool clearObject (const word &fieldName)
 Clear field from the (sub) objectRegistry if present.
void clearObjects (const wordList &objNames)
 Clear fields from the (sub) objectRegistry if present.
 regionFunctionObject (const regionFunctionObject &)=delete
 No copy construct.
void operator= (const regionFunctionObject &)=delete
 No copy assignment.
Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties & stateDict () const
 Return a const reference to the state dictionary.
functionObjects::properties & stateDict ()
 Return non-const access to the state dictionary.
 stateFunctionObject (const stateFunctionObject &)=delete
 No copy construct.
void operator= (const stateFunctionObject &)=delete
 No copy assignment.
Protected Member Functions inherited from timeFunctionObject
void clearOutputObjects (const wordList &objNames)
 Remove specified items from "functionObjectObjects".
 timeFunctionObject (const timeFunctionObject &)=delete
 No copy construct.
void operator= (const timeFunctionObject &)=delete
 No copy assignment.
Protected Member Functions inherited from functionObject
word scopedName (const word &name) const
 Return a scoped (prefixed) name.
Protected Attributes inherited from fvMeshFunctionObject
const fvMesh & mesh_
 Reference to the fvMesh.
Protected Attributes inherited from regionFunctionObject
word subRegistryName_
 Name for alternative object registry.
const objectRegistry & obr_
 Reference to the region objectRegistry.
const objectRegistry * obrPtr_
 Pointer to alternative (eg, sub-region) objectRegistry.
Protected Attributes inherited from timeFunctionObject
const Time & time_
 Reference to the time database.

Detailed Description

Computes the simplified energy transport equation in single-phase or two-phase flow, considering incompressible cases:

\‍[ \frac{\partial \rho \, C_p \, T}{\partial t} + \nabla \cdot \left(\rho \, C_p \, \phi \, T \right) - \nabla \cdot \left(\rho \, C_p \, \phi \right) \, T - \nabla \cdot \left(\kappa_{eff} \, \nabla T \right) = S_T \‍]

where:

$ T $=Scalar field
$ \rho $=(Generic) Fluid density which is unity when not specified
$ C_p $=Specific heat capacity at constant pressure
$ \phi $=(Generic) Flux field
$ \kappa_{eff} $=Effective thermal conductivity
$ S_T $=Scalar field source term
Usage
Minimal example in system/controlDict.functions: 
energyTransportFO
{
    // Mandatory entries
    type            energyTransport;
    libs            (solverFunctionObjects);

    // Optional entries
    field           <word>;
    phi             <word>;
    rho             <word>;
    Cp              <scalar>;
    kappa           <scalar>;
    rhoInf          <scalar>;
    Prt             <scalar>;
    schemesField    <word>;
    tolerance       <scalar>;
    nCorr           <int>;
    fvOptions       <dict>;
    phaseThermos    <dict>;

    // Inherited entries
    ...
}

where:

Property Description Type Reqd Deflt
type Type name: energyTransport word yes -
libs Library name: solverFunctionObjects word yes -
field Name of the passive-scalar field word no s
phi Name of flux field word no phi
rho Name of density field word no rho
Cp Specific heat capacity at constant pressure scalar no 0
kappa Thermal conductivity scalar no 0
rhoInf Fluid density scalar no 0
Prt Turbulent Prandtl number scalar no 1
schemesField Name of field to specify schemes word no field
tolerance Outer-loop initial-residual tolerance scalar no 1
nCorr Number of outer-loop correctors int no 0
fvOptions List of finite-volume options dict no -
phaseThermos Dictionary for multi-phase thermo dict no null

The inherited entries are elaborated in:

An example of function object specification to solve a energy transport equation for a single phase flow plus a source term: 

    energyTransport1
    {
        // Mandatory entries
        type            energyTransport;
        libs            (solverFunctionObjects);

        // Optional entries
        field           T;
        phi             phi;
        Cp              Cp    [J/kg/K]  1e3;
        kappa           kappa [W/m/K]   0.0257;
        rhoInf          rho   [kg/m^3]  1.2;
        fvOptions
        {
            viscousDissipation
            {
                type            viscousDissipation;
                enabled         true;

                viscousDissipationCoeffs
                {
                    fields          (T);
                    rhoInf          $....rhoInf;
                }
            }
        }

        // Inherited entries
        enabled         true;
        writeControl    writeTime;
        writeInterval   1;
    }

An example of function object specification to solve a energy transport equation for a multiphase phase flow plus a source term: 

    energyTransport1
    {
        // Mandatory entries
        type            energyTransport;
        libs            (solverFunctionObjects);

        // Optional entries
        field           T;
        rho             rho;
        phi             rhoPhi;

        // Thermal properties of the phases
        phaseThermos
        {
            alpha.air
            {
                Cp          1e3;
                kappa       0.0243;
            }
            alpha.mercury
            {
                Cp          140;
                kappa       8.2;
            }
            alpha.oil
            {
                Cp          2e3;
                kappa       0.2;
            }
            alpha.water
            {
                Cp          4e3;
                kappa       0.6;
            }
        }

        fvOptions
        {
            viscousDissipation
            {
                type            viscousDissipation;
                enabled         true;

                viscousDissipationCoeffs
                {
                    fields          (T);
                    rho             rho;
                }
            }
        }

        // Inherited entries
        enabled         true;
        writeControl    writeTime;
        writeInterval   1;
    }
Note
  • The field name must be temperature and its boundary conditions specified in the time directory.
  • The turbulence model should be incompressible.
Source files

Definition at line 340 of file energyTransport.H.

Constructor & Destructor Documentation

◆ energyTransport()

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

Construct from name, Time and dictionary.

Definition at line 171 of file energyTransport.C.

References Cp, dict, Foam::dimDensity, Foam::dimEnergy, Foam::dimLength, Foam::dimless, Foam::dimMass, Foam::dimTemperature, Foam::dimTime, Foam::dimVolume, Foam::exit(), Foam::FatalError, FatalErrorInFunction, dictionary::findDict(), forAll, forAllConstIters, fvMeshFunctionObject::fvMeshFunctionObject(), fvMeshFunctionObject::mesh_, Foam::name(), phasei, read(), rho, runTime, s(), timeFunctionObject::time(), timeName, and Foam::Zero.

Here is the call graph for this function:

◆ ~energyTransport()

virtual ~energyTransport ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "energyTransport" )

Runtime type information.

References dict, Foam::name(), and runTime.

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict)
virtual

Read the function-object dictionary.

Reimplemented from regionFunctionObject.

Definition at line 299 of file energyTransport.C.

References dict, and functionObject::read().

Referenced by energyTransport().

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

◆ execute()

bool execute ( )
virtual

Execute the function-object operations.

Implements functionObject.

Definition at line 323 of file energyTransport.C.

References Cp, Foam::fvc::ddt(), Foam::fvm::ddt(), Foam::dimMass, Foam::dimTime, Foam::dimVolume, Foam::fvc::div(), Foam::fvm::div(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::fvc::interpolate(), kappaEff, Foam::fvm::laplacian(), Log, fvMeshFunctionObject::mesh_, name, GeometricField< scalar, fvPatchField, volMesh >::New(), Foam::nl, IOobjectOption::NO_REGISTER, phi, fvMatrix< Type >::relax(), rho, rhoCp, rhoCpPhi(), s(), fvMatrix< Type >::solve(), Foam::fvm::Sp(), Foam::tab, and Foam::type().

Here is the call graph for this function:

◆ write()

bool write ( )
virtual

Write the function object output.

The volScalarField is registered and written automatically

Implements functionObject.

Definition at line 431 of file energyTransport.C.

References Foam::endl(), Log, name, Foam::nl, s(), Foam::tab, and Foam::type().

Here is the call graph for this function:
The documentation for this class was generated from the following files: