temperatureCoupledBase Class Reference

Common functions used in temperature coupled boundaries. More...

Inheritance diagram for temperatureCoupledBase:
Collaboration diagram for temperatureCoupledBase:

Public Types

enum  KMethodType { mtFluidThermo, mtSolidThermo, mtDirectionalSolidThermo, mtLookup }
 Type of supplied Kappa. More...
 

Public Member Functions

 temperatureCoupledBase (const fvPatch &patch, const word &calculationMethod, const word &kappaName, const word &alphaAniName)
 Construct from patch and K name. More...
 
 temperatureCoupledBase (const fvPatch &patch, const dictionary &dict)
 Construct from patch and dictionary. More...
 
 temperatureCoupledBase (const fvPatch &patch, const temperatureCoupledBase &base)
 Construct from patch and temperatureCoupledBase. More...
 
word KMethod () const
 Method to obtain K. More...
 
const wordkappaName () const
 Name of thermal conductivity field. More...
 
tmp< scalarFieldkappa (const scalarField &Tp) const
 Given patch temperature calculate corresponding K field. More...
 
void write (Ostream &) const
 Write. More...
 

Protected Attributes

const fvPatchpatch_
 Underlying patch. More...
 
const KMethodType method_
 How to get K. More...
 
const word kappaName_
 Name of thermal conductivity field (if looked up from database) More...
 
const word alphaAniName_
 Name of the non-Isotropic alpha (default: Anialpha) More...
 

Static Protected Attributes

static const NamedEnum< KMethodType, 4 > KMethodTypeNames_
 

Detailed Description

Common functions used in temperature coupled boundaries.

The thermal conductivity kappa may be obtained by the following methods:

Keywords provided by this class:
Property Description Required Default value
kappaMethod Thermal conductivity method yes
kappa Name of thermal conductivity field no none
alphaAni Name of the non-isotropic alpha no Anialpha
Usage
nonIsotropicWall
{
    ...
    kappaMethod     directionalSolidThermo;
    kappa           none;
    alphaAni        Anialpha;
    ...
}
Source files

Definition at line 100 of file temperatureCoupledBase.H.

Member Enumeration Documentation

◆ KMethodType

Type of supplied Kappa.

Enumerator
mtFluidThermo 
mtSolidThermo 
mtDirectionalSolidThermo 
mtLookup 

Definition at line 107 of file temperatureCoupledBase.H.

Constructor & Destructor Documentation

◆ temperatureCoupledBase() [1/3]

temperatureCoupledBase ( const fvPatch patch,
const word calculationMethod,
const word kappaName,
const word alphaAniName 
)

Construct from patch and K name.

Definition at line 58 of file temperatureCoupledBase.C.

Referenced by NamedEnum< directionType, 3 >::names(), and temperatureCoupledBase::temperatureCoupledBase().

Here is the caller graph for this function:

◆ temperatureCoupledBase() [2/3]

temperatureCoupledBase ( const fvPatch patch,
const dictionary dict 
)

Construct from patch and dictionary.

Definition at line 73 of file temperatureCoupledBase.C.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::found(), Foam::nl, and temperatureCoupledBase::temperatureCoupledBase().

Here is the call graph for this function:

◆ temperatureCoupledBase() [3/3]

temperatureCoupledBase ( const fvPatch patch,
const temperatureCoupledBase base 
)

Construct from patch and temperatureCoupledBase.

Definition at line 122 of file temperatureCoupledBase.C.

References temperatureCoupledBase::kappa().

Here is the call graph for this function:

Member Function Documentation

◆ KMethod()

word KMethod ( ) const
inline

Method to obtain K.

Definition at line 166 of file temperatureCoupledBase.H.

References temperatureCoupledBase::method_.

◆ kappaName()

const word& kappaName ( ) const
inline

Name of thermal conductivity field.

Definition at line 172 of file temperatureCoupledBase.H.

References temperatureCoupledBase::kappa(), temperatureCoupledBase::kappaName_, and temperatureCoupledBase::write().

Here is the call graph for this function:

◆ kappa()

◆ write()

Member Data Documentation

◆ KMethodTypeNames_

const Foam::NamedEnum< Foam::temperatureCoupledBase::KMethodType, 4 > KMethodTypeNames_
staticprotected

Definition at line 120 of file temperatureCoupledBase.H.

Referenced by NamedEnum< directionType, 3 >::names().

◆ patch_

const fvPatch& patch_
protected

Underlying patch.

Definition at line 123 of file temperatureCoupledBase.H.

◆ method_

const KMethodType method_
protected

How to get K.

Definition at line 126 of file temperatureCoupledBase.H.

Referenced by temperatureCoupledBase::KMethod().

◆ kappaName_

const word kappaName_
protected

Name of thermal conductivity field (if looked up from database)

Definition at line 129 of file temperatureCoupledBase.H.

Referenced by temperatureCoupledBase::kappaName().

◆ alphaAniName_

const word alphaAniName_
protected

Name of the non-Isotropic alpha (default: Anialpha)

Definition at line 132 of file temperatureCoupledBase.H.


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