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

#include <temperatureCoupledBase.H>

Inheritance diagram for temperatureCoupledBase:

[legend]

Collaboration diagram for temperatureCoupledBase:

[legend]

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

Public Member Functions
	temperatureCoupledBase (const fvPatch &patch, const KMethodType method=KMethodType::mtFluidThermo)
	Default construct from patch, using fluidThermo (default) or specified method.
	temperatureCoupledBase (const fvPatch &patch, const KMethodType method, const word &kappaName, const word &alphaName, const word &alphaAniName)
	Construct from patch, method type and field names.
	temperatureCoupledBase (const fvPatch &patch, const dictionary &dict)
	Construct from patch and dictionary.
	temperatureCoupledBase (const fvPatch &patch, const temperatureCoupledBase &base)
	Construct from patch and temperatureCoupledBase.
	temperatureCoupledBase (const temperatureCoupledBase &base)
	Copy construct.
virtual	~temperatureCoupledBase ()=default
	Destructor.
word	KMethod () const
	Method to obtain K.
const word &	kappaName () const noexcept
	Name of thermal conductivity field.
const word &	alphaName () const noexcept
	Name of thermal diffusivity field.
virtual void	autoMap (const fvPatchFieldMapper &)=0
	Map (and resize as needed) from self given a mapping object.
virtual void	rmap (const fvPatchField< scalar > &, const labelList &)=0
	Reverse map the given fvPatchField onto this fvPatchField.
virtual tmp< scalarField >	kappa (const scalarField &Tp) const
	Given patch temperature calculate corresponding K field.
virtual tmp< scalarField >	alpha (const scalarField &Tp) const
	Given patch temperature calculate corresponding alphaEff field.
void	write (Ostream &os) const
	Write.

Protected Attributes
const fvPatch &	patch_
	Underlying patch.
const KMethodType	method_
	How to get K.
const word	kappaName_
	Name of thermal conductivity field (if looked up from database).
const word	alphaName_
	Name of thermal diffusivity.
const word	alphaAniName_
	Name of the non-isotropic alpha (for directional solidThermo).
autoPtr< PatchFunction1< scalar > >	kappaFunction1_
	Function1 for kappa.
autoPtr< PatchFunction1< scalar > >	alphaFunction1_
	Function1 for alpha.

Static Protected Attributes
static const Enum< KMethodType >	KMethodTypeNames_

Detailed Description

Common functions used in temperature coupled boundaries.

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

'lookup' : lookup volScalarField (or volSymmTensorField) with name defined by 'kappa'
'fluidThermo' : use fluidThermo and default compressible::turbulenceModel to calculate kappa
'solidThermo' : use solidThermo kappa()
'directionalSolidThermo': uses look up for volSymmTensorField for transformed kappa vector. Field name definable in 'alphaAni', named 'Anialpha' in solid solver by default
'function' : kappa, alpha directly specified as Function1
'phaseSystem' : used for multiphase thermos

Keywords provided by this class:

Property	Description	Required
`kappaMethod`	Thermal conductivity method	yes
`kappa`	Name of thermal conductivity field	partly
`alpha`	Name of thermal diffusivity field	partly
`alphaAni`	Name of non-isotropic alpha	partly
`kappaValue`	Function1 supplying kappa	partly
`alphaValue`	Function1 supplying alpha	partly

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

enum KMethodType

Type of supplied Kappa.

Enumerator
mtFluidThermo
mtSolidThermo
mtDirectionalSolidThermo
mtLookup
mtFunction

Definition at line 140 of file temperatureCoupledBase.H.

Constructor & Destructor Documentation

◆ temperatureCoupledBase() [1/5]

temperatureCoupledBase	(	const fvPatch &	patch,
		const KMethodType	method = KMethodType::mtFluidThermo )

explicit

Default construct from patch, using fluidThermo (default) or specified method.

Definition at line 47 of file temperatureCoupledBase.C.

References Foam::abort(), alphaAniName_, alphaFunction1_, alphaName_, Foam::FatalError, FatalErrorInFunction, kappaFunction1_, kappaName_, KMethodTypeNames_, method_, mtDirectionalSolidThermo, mtFunction, mtLookup, and patch_.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ temperatureCoupledBase() [2/5]

temperatureCoupledBase	(	const fvPatch &	patch,
		const KMethodType	method,
		const word &	kappaName,
		const word &	alphaName,
		const word &	alphaAniName )

Construct from patch, method type and field names.

Definition at line 81 of file temperatureCoupledBase.C.

References Foam::abort(), alphaAniName_, alphaFunction1_, alphaName(), alphaName_, Foam::FatalError, FatalErrorInFunction, kappaFunction1_, kappaName(), kappaName_, KMethodTypeNames_, method_, mtFunction, and patch_.

Here is the call graph for this function:

◆ temperatureCoupledBase() [3/5]

temperatureCoupledBase	(	const fvPatch &	patch,
		const dictionary &	dict )

Construct from patch and dictionary.

Definition at line 116 of file temperatureCoupledBase.C.

References alphaAniName_, alphaFunction1_, alphaName_, dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, kappaFunction1_, kappaName_, KMethodTypeNames_, method_, mtDirectionalSolidThermo, mtFunction, mtLookup, Foam::nl, and patch_.

Here is the call graph for this function:

◆ temperatureCoupledBase() [4/5]

temperatureCoupledBase	(	const fvPatch &	patch,
		const temperatureCoupledBase &	base )

Construct from patch and temperatureCoupledBase.

Definition at line 197 of file temperatureCoupledBase.C.

References alphaAniName_, alphaFunction1_, alphaName_, kappaFunction1_, kappaName_, method_, patch_, and temperatureCoupledBase().

Here is the call graph for this function:

◆ temperatureCoupledBase() [5/5]

temperatureCoupledBase ( const temperatureCoupledBase & base )

Copy construct.

Definition at line 188 of file temperatureCoupledBase.C.

References patch_, and temperatureCoupledBase().

Here is the call graph for this function:

◆ ~temperatureCoupledBase()

virtual ~temperatureCoupledBase ( )

virtualdefault

Destructor.

Member Function Documentation

◆ KMethod()

word KMethod ( ) const

inline

Method to obtain K.

Definition at line 253 of file temperatureCoupledBase.H.

References KMethodTypeNames_, and method_.

◆ kappaName()

const word & kappaName ( ) const

inlinenoexcept

Name of thermal conductivity field.

Definition at line 261 of file temperatureCoupledBase.H.

References kappaName_, and Foam::noexcept.

Referenced by temperatureCoupledBase().

Here is the caller graph for this function:

◆ alphaName()

const word & alphaName ( ) const

inlinenoexcept

Name of thermal diffusivity field.

Definition at line 269 of file temperatureCoupledBase.H.

References alphaName_, and Foam::noexcept.

Referenced by temperatureCoupledBase().

Here is the caller graph for this function:

◆ autoMap()

void autoMap ( const fvPatchFieldMapper & mapper )

pure virtual

Map (and resize as needed) from self given a mapping object.

Implemented in turbulentTemperatureCoupledBaffleMixedFvPatchScalarField, turbulentTemperatureRadCoupledMixedFvPatchScalarField, externalWallHeatFluxTemperatureFvPatchScalarField, filmPyrolysisRadiativeCoupledMixedFvPatchScalarField, humidityTemperatureCoupledMixedFvPatchScalarField, lumpedMassWallTemperatureFvPatchScalarField, and fixedIncidentRadiationFvPatchScalarField.

Definition at line 215 of file temperatureCoupledBase.C.

References alphaFunction1_, and kappaFunction1_.

Referenced by turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::autoMap(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::autoMap(), externalWallHeatFluxTemperatureFvPatchScalarField::autoMap(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::autoMap(), humidityTemperatureCoupledMixedFvPatchScalarField::autoMap(), lumpedMassWallTemperatureFvPatchScalarField::autoMap(), and fixedIncidentRadiationFvPatchScalarField::autoMap().

Here is the caller graph for this function:

◆ rmap()

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

pure virtual

Reverse map the given fvPatchField onto this fvPatchField.

Implemented in turbulentTemperatureCoupledBaffleMixedFvPatchScalarField, turbulentTemperatureRadCoupledMixedFvPatchScalarField, filmPyrolysisRadiativeCoupledMixedFvPatchScalarField, and lumpedMassWallTemperatureFvPatchScalarField.

Definition at line 231 of file temperatureCoupledBase.C.

References alphaFunction1_, Foam::isA(), and kappaFunction1_.

Referenced by turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::rmap(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::rmap(), externalWallHeatFluxTemperatureFvPatchScalarField::rmap(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::rmap(), humidityTemperatureCoupledMixedFvPatchScalarField::rmap(), lumpedMassWallTemperatureFvPatchScalarField::rmap(), and fixedIncidentRadiationFvPatchScalarField::rmap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ kappa()

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

virtual

Given patch temperature calculate corresponding K field.

Reimplemented in turbulentTemperatureCoupledBaffleMixedFvPatchScalarField, and turbulentTemperatureRadCoupledMixedFvPatchScalarField.

Definition at line 253 of file temperatureCoupledBase.C.

References alphaAniName_, basicThermo::dictName, Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::flatOutput(), kappa(), kappaFunction1_, kappaName_, KMethodTypeNames_, mesh, method_, mtDirectionalSolidThermo, mtFluidThermo, mtFunction, mtLookup, mtSolidThermo, n, Foam::nl, patch_, multiphaseInterSystem::phasePropertiesName, pp(), and turbulenceModel::propertiesName.

Referenced by turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::kappa(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::kappa(), kappa(), externalWallHeatFluxTemperatureFvPatchScalarField::updateCoeffs(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), humidityTemperatureCoupledMixedFvPatchScalarField::updateCoeffs(), lumpedMassWallTemperatureFvPatchScalarField::updateCoeffs(), and fixedIncidentRadiationFvPatchScalarField::updateCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ alpha()

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

virtual

Given patch temperature calculate corresponding alphaEff field.

Definition at line 414 of file temperatureCoupledBase.C.

References alphaAniName_, alphaFunction1_, alphaName_, basicThermo::dictName, Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::flatOutput(), KMethodTypeNames_, mesh, method_, mtDirectionalSolidThermo, mtFluidThermo, mtFunction, mtLookup, mtSolidThermo, n, Foam::nl, patch_, and turbulenceModel::propertiesName.

Referenced by turbulentTemperatureRadCoupledMixedFvPatchScalarField::updateCoeffs(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), and humidityTemperatureCoupledMixedFvPatchScalarField::updateCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

void write ( Ostream & os ) const

Write.

Definition at line 563 of file temperatureCoupledBase.C.

References alphaAniName_, alphaFunction1_, alphaName_, kappaFunction1_, kappaName_, KMethodTypeNames_, method_, and os().

Referenced by turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::write(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::write(), externalWallHeatFluxTemperatureFvPatchScalarField::write(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::write(), humidityTemperatureCoupledMixedFvPatchScalarField::write(), lumpedMassWallTemperatureFvPatchScalarField::write(), and fixedIncidentRadiationFvPatchScalarField::write().

Here is the call graph for this function:

Here is the caller graph for this function:

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 35 of file temperatureCoupledBase.H.

Referenced by alpha(), kappa(), KMethod(), temperatureCoupledBase(), temperatureCoupledBase(), temperatureCoupledBase(), and write().

◆ patch_

const fvPatch& patch_

protected

Underlying patch.

Definition at line 159 of file temperatureCoupledBase.H.

Referenced by alpha(), kappa(), temperatureCoupledBase(), temperatureCoupledBase(), temperatureCoupledBase(), temperatureCoupledBase(), and temperatureCoupledBase().

◆ method_

const KMethodType method_

protected

How to get K.

Definition at line 164 of file temperatureCoupledBase.H.

Referenced by alpha(), kappa(), KMethod(), temperatureCoupledBase(), temperatureCoupledBase(), temperatureCoupledBase(), temperatureCoupledBase(), and write().

◆ kappaName_

const word kappaName_

protected

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

Definition at line 169 of file temperatureCoupledBase.H.

Referenced by kappa(), kappaName(), temperatureCoupledBase(), temperatureCoupledBase(), temperatureCoupledBase(), temperatureCoupledBase(), and write().

◆ alphaName_

const word alphaName_

protected

Name of thermal diffusivity.

Definition at line 174 of file temperatureCoupledBase.H.

Referenced by alpha(), alphaName(), temperatureCoupledBase(), temperatureCoupledBase(), temperatureCoupledBase(), temperatureCoupledBase(), and write().

◆ alphaAniName_

const word alphaAniName_

protected

Name of the non-isotropic alpha (for directional solidThermo).

Definition at line 179 of file temperatureCoupledBase.H.

Referenced by alpha(), kappa(), temperatureCoupledBase(), temperatureCoupledBase(), temperatureCoupledBase(), temperatureCoupledBase(), and write().

◆ kappaFunction1_

autoPtr<PatchFunction1<scalar> > kappaFunction1_

protected

Function1 for kappa.

Definition at line 184 of file temperatureCoupledBase.H.

Referenced by autoMap(), kappa(), rmap(), temperatureCoupledBase(), temperatureCoupledBase(), temperatureCoupledBase(), temperatureCoupledBase(), and write().

◆ alphaFunction1_

autoPtr<PatchFunction1<scalar> > alphaFunction1_

protected

Function1 for alpha.

Definition at line 189 of file temperatureCoupledBase.H.

Referenced by alpha(), autoMap(), rmap(), temperatureCoupledBase(), temperatureCoupledBase(), temperatureCoupledBase(), temperatureCoupledBase(), and write().

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

src/thermoTools/derivedFvPatchFields/temperatureCoupledBase/temperatureCoupledBase.H
src/thermoTools/derivedFvPatchFields/temperatureCoupledBase/temperatureCoupledBase.C

Public Types

Public Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ KMethodType

Constructor & Destructor Documentation

◆ temperatureCoupledBase() [1/5]

◆ temperatureCoupledBase() [2/5]

◆ temperatureCoupledBase() [3/5]

◆ temperatureCoupledBase() [4/5]

◆ temperatureCoupledBase() [5/5]

◆ ~temperatureCoupledBase()

Member Function Documentation

◆ KMethod()

◆ kappaName()

◆ alphaName()

◆ autoMap()

◆ rmap()

◆ kappa()

◆ alpha()

◆ write()

Member Data Documentation

◆ KMethodTypeNames_

◆ patch_

◆ method_

◆ kappaName_

◆ alphaName_

◆ alphaAniName_

◆ kappaFunction1_

◆ alphaFunction1_