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

Common functions used 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,
  mtFunction
}
 

Public Member Functions

 temperatureCoupledBase (const fvPatch &patch, const word &calculationMethod, const word &kappaName, const word &alphaAniName, const word &alphaName)
 
 temperatureCoupledBase (const fvPatch &patch, const dictionary &dict)
 
 temperatureCoupledBase (const fvPatch &patch, const temperatureCoupledBase &base)
 
 temperatureCoupledBase (const temperatureCoupledBase &)
 
virtual ~temperatureCoupledBase ()=default
 
word KMethod () const
 
const wordkappaName () const
 
const wordalphaName () const
 
virtual void autoMap (const fvPatchFieldMapper &)=0
 
virtual void rmap (const fvPatchField< scalar > &, const labelList &)=0
 
virtual tmp< scalarFieldkappa (const scalarField &Tp) const
 
virtual tmp< scalarFieldalpha (const scalarField &Tp) const
 
void write (Ostream &os) const
 

Protected Attributes

const fvPatchpatch_
 
const KMethodType method_
 
const word kappaName_
 
const word alphaAniName_
 
const word alphaName_
 
autoPtr< PatchFunction1< scalar > > kappaFunction1_
 
autoPtr< PatchFunction1< scalar > > alphaFunction1_
 

Static Protected Attributes

static const Enum< KMethodTypeKMethodTypeNames_
 

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
kappaMethod Thermal conductivity method yes
kappa Name of thermal conductivity field no
alpha Name of thermal diffusivity field no
alphaAni Name of non-isotropic alpha no
kappaValue Function1 supplying kappa no
alphaValue Function1 supplying alpha no
Usage
nonIsotropicWall
{
    ...
    kappaMethod     directionalSolidThermo;
    alphaAni        Anialpha;
    ...
}
specifiedWall
{
    ...
    kappaMethod     function;
    kappaFunction   constant 1.0;
    alphaFunction   constant 100.0;
    ...
}
Source files

Definition at line 131 of file temperatureCoupledBase.H.

Member Enumeration Documentation

◆ KMethodType

Enumerator
mtFluidThermo 
mtSolidThermo 
mtDirectionalSolidThermo 
mtLookup 
mtFunction 

Definition at line 138 of file temperatureCoupledBase.H.

Constructor & Destructor Documentation

◆ temperatureCoupledBase() [1/4]

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

Definition at line 47 of file temperatureCoupledBase.C.

◆ temperatureCoupledBase() [2/4]

temperatureCoupledBase ( const fvPatch patch,
const dictionary dict 
)

Definition at line 64 of file temperatureCoupledBase.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::New(), Foam::nl, and Foam::foamVersion::patch.

Here is the call graph for this function:

◆ temperatureCoupledBase() [3/4]

temperatureCoupledBase ( const fvPatch patch,
const temperatureCoupledBase base 
)

Definition at line 147 of file temperatureCoupledBase.C.

◆ temperatureCoupledBase() [4/4]

Definition at line 132 of file temperatureCoupledBase.C.

◆ ~temperatureCoupledBase()

virtual ~temperatureCoupledBase ( )
virtualdefault

Member Function Documentation

◆ KMethod()

word KMethod ( ) const
inline

◆ kappaName()

const word& kappaName ( ) const
inline

Definition at line 224 of file temperatureCoupledBase.H.

References temperatureCoupledBase::kappaName_.

◆ alphaName()

const word& alphaName ( ) const
inline

Definition at line 230 of file temperatureCoupledBase.H.

References temperatureCoupledBase::alphaName_.

◆ autoMap()

void autoMap ( const fvPatchFieldMapper mapper)
pure virtual

◆ rmap()

void rmap ( const fvPatchField< scalar > &  ptf,
const labelList addr 
)
pure virtual

◆ kappa()

Foam::tmp< Foam::scalarField > kappa ( const scalarField Tp) const
virtual

◆ alpha()

Foam::tmp< Foam::scalarField > alpha ( const scalarField Tp) const
virtual

◆ write()

void write ( Ostream os) const

Member Data Documentation

◆ KMethodTypeNames_

const Foam::Enum< Foam::temperatureCoupledBase::KMethodType > KMethodTypeNames_
staticprotected
Initial value:
{
{ KMethodType::mtFluidThermo, "fluidThermo" },
{ KMethodType::mtSolidThermo, "solidThermo" },
{ KMethodType::mtDirectionalSolidThermo, "directionalSolidThermo" },
{ KMethodType::mtLookup, "lookup" },
{ KMethodType::mtFunction, "function" }
}

Definition at line 152 of file temperatureCoupledBase.H.

Referenced by temperatureCoupledBase::KMethod(), and temperatureCoupledBase::write().

◆ patch_

const fvPatch& patch_
protected

Definition at line 155 of file temperatureCoupledBase.H.

◆ method_

const KMethodType method_
protected

◆ kappaName_

const word kappaName_
protected

◆ alphaAniName_

const word alphaAniName_
protected

Definition at line 164 of file temperatureCoupledBase.H.

Referenced by temperatureCoupledBase::write().

◆ alphaName_

const word alphaName_
protected

◆ kappaFunction1_

autoPtr<PatchFunction1<scalar> > kappaFunction1_
protected

Definition at line 170 of file temperatureCoupledBase.H.

Referenced by temperatureCoupledBase::write().

◆ alphaFunction1_

autoPtr<PatchFunction1<scalar> > alphaFunction1_
protected

Definition at line 173 of file temperatureCoupledBase.H.

Referenced by temperatureCoupledBase::write().


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