Public Types | Public Member Functions | Protected Attributes | Static Protected Attributes | List of all members
temperatureCoupledBase Class Reference

Common functions for use in temperature coupled boundaries. More...

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

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 for use in temperature coupled boundaries.

For now only provides the following methods:


Keywords provided by this class

Property Description Required Default value
kappa heat conduction type at patch, as listed above yes
kappaName Name of thermal conductivity field yes
alphaAniName name of the non-isotropic alpha no 'Anialpha'

Usage examples:

    nonIsotropicWall
    {
        ...
        kappa           directionalSolidThermo;
        kappaName       none;
        alphaAniName    Anialpha;
        ...
    }
Source files

Definition at line 104 of file temperatureCoupledBase.H.

Member Enumeration Documentation

Type of supplied Kappa.

Enumerator
mtFluidThermo 
mtSolidThermo 
mtDirectionalSolidThermo 
mtLookup 

Definition at line 111 of file temperatureCoupledBase.H.

Constructor & Destructor Documentation

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< Enum, nEnum >::names(), and temperatureCoupledBase::temperatureCoupledBase().

Here is the caller graph for this function:

temperatureCoupledBase ( const fvPatch patch,
const dictionary dict 
)

Construct from patch and dictionary.

Definition at line 73 of file temperatureCoupledBase.C.

References temperatureCoupledBase::temperatureCoupledBase().

Here is the call graph for this function:

temperatureCoupledBase ( const fvPatch patch,
const temperatureCoupledBase base 
)

Construct from patch and temperatureCoupledBase.

Definition at line 86 of file temperatureCoupledBase.C.

References temperatureCoupledBase::kappa().

Here is the call graph for this function:

Member Function Documentation

word KMethod ( ) const
inline

Method to obtain K.

Definition at line 170 of file temperatureCoupledBase.H.

References temperatureCoupledBase::method_.

const word& kappaName ( ) const
inline

Name of thermal conductivity field.

Definition at line 176 of file temperatureCoupledBase.H.

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

Here is the call graph for this function:

Foam::tmp< Foam::scalarField > kappa ( const scalarField Tp) const
void write ( Ostream os) const

Member Data Documentation

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

Definition at line 124 of file temperatureCoupledBase.H.

Referenced by NamedEnum< Enum, nEnum >::names().

const fvPatch& patch_
protected

Underlying patch.

Definition at line 127 of file temperatureCoupledBase.H.

const KMethodType method_
protected

How to get K.

Definition at line 130 of file temperatureCoupledBase.H.

Referenced by temperatureCoupledBase::KMethod().

const word kappaName_
protected

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

Definition at line 133 of file temperatureCoupledBase.H.

Referenced by temperatureCoupledBase::kappaName().

const word alphaAniName_
protected

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

Definition at line 136 of file temperatureCoupledBase.H.


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