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

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. More...

	temperatureCoupledBase (const fvPatch &patch, const KMethodType method, const word &kappaName, const word &alphaName, const word &alphaAniName)
	Construct from patch, method type and field names. 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...

	temperatureCoupledBase (const temperatureCoupledBase &base)
	Copy construct. More...

virtual	~temperatureCoupledBase ()=default
	Destructor. More...

word	KMethod () const
	Method to obtain K. More...

const word &	kappaName () const noexcept
	Name of thermal conductivity field. More...

const word &	alphaName () const noexcept
	Name of thermal diffusivity field. More...

virtual void	autoMap (const fvPatchFieldMapper &)=0
	Map (and resize as needed) from self given a mapping object. More...

virtual void	rmap (const fvPatchField< scalar > &, const labelList &)=0
	Reverse map the given fvPatchField onto this fvPatchField. More...

virtual tmp< scalarField >	kappa (const scalarField &Tp) const
	Given patch temperature calculate corresponding K field. More...

virtual tmp< scalarField >	alpha (const scalarField &Tp) const
	Given patch temperature calculate corresponding alphaEff field. More...

void	write (Ostream &os) const
	Write. More...

Protected Attributes
const fvPatch &	patch_
	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	alphaName_
	Name of thermal diffusivity. More...

const word	alphaAniName_
	Name of the non-isotropic alpha (for directional solidThermo) More...

autoPtr< PatchFunction1< scalar > >	kappaFunction1_
	Function1 for kappa. More...

autoPtr< PatchFunction1< scalar > >	alphaFunction1_
	Function1 for alpha. More...

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 48 of file temperatureCoupledBase.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call 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 82 of file temperatureCoupledBase.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

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 117 of file temperatureCoupledBase.C.

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

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 198 of file temperatureCoupledBase.C.

◆ temperatureCoupledBase() [5/5]

temperatureCoupledBase ( const temperatureCoupledBase & base )

Copy construct.

Definition at line 189 of file temperatureCoupledBase.C.

◆ ~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 temperatureCoupledBase::KMethodTypeNames_, and temperatureCoupledBase::method_.

◆ kappaName()

const word& kappaName ( ) const

inlinenoexcept

Name of thermal conductivity field.

Definition at line 261 of file temperatureCoupledBase.H.

References temperatureCoupledBase::kappaName_.

◆ alphaName()

const word& alphaName ( ) const

inlinenoexcept

Name of thermal diffusivity field.

Definition at line 269 of file temperatureCoupledBase.H.

References temperatureCoupledBase::alphaName_.

◆ autoMap()

void autoMap ( const fvPatchFieldMapper & mapper )

pure virtual

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

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

Definition at line 216 of file temperatureCoupledBase.C.

Referenced by fixedIncidentRadiationFvPatchScalarField::autoMap(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::autoMap(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::autoMap(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::autoMap(), and humidityTemperatureCoupledMixedFvPatchScalarField::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 humidityTemperatureCoupledMixedFvPatchScalarField, turbulentTemperatureRadCoupledMixedFvPatchScalarField, externalWallHeatFluxTemperatureFvPatchScalarField, turbulentTemperatureCoupledBaffleMixedFvPatchScalarField, filmPyrolysisRadiativeCoupledMixedFvPatchScalarField, lumpedMassWallTemperatureFvPatchScalarField, and fixedIncidentRadiationFvPatchScalarField.

Definition at line 232 of file temperatureCoupledBase.C.

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

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 turbulentTemperatureRadCoupledMixedFvPatchScalarField, and turbulentTemperatureCoupledBaffleMixedFvPatchScalarField.

Definition at line 254 of file temperatureCoupledBase.C.

References dictName(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::flatOutput(), Foam::constant::electromagnetic::kappa, basicThermo::kappa(), multiphaseInterSystem::kappaEff(), mesh, n, Foam::nl, and pp().

Referenced by turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::kappa(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::kappa(), lumpedMassWallTemperatureFvPatchScalarField::updateCoeffs(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), and externalWallHeatFluxTemperatureFvPatchScalarField::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 415 of file temperatureCoupledBase.C.

References basicThermo::alpha(), dictName(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::flatOutput(), mesh, n, and Foam::nl.

Referenced by filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), and turbulentTemperatureRadCoupledMixedFvPatchScalarField::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 temperatureCoupledBase::alphaAniName_, temperatureCoupledBase::alphaFunction1_, temperatureCoupledBase::alphaName_, temperatureCoupledBase::kappaFunction1_, temperatureCoupledBase::kappaName_, temperatureCoupledBase::KMethodTypeNames_, temperatureCoupledBase::method_, and os().

Referenced by fixedIncidentRadiationFvPatchScalarField::write(), lumpedMassWallTemperatureFvPatchScalarField::write(), filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::write(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::write(), externalWallHeatFluxTemperatureFvPatchScalarField::write(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::write(), and humidityTemperatureCoupledMixedFvPatchScalarField::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 154 of file temperatureCoupledBase.H.

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

◆ patch_

const fvPatch& patch_

protected

Underlying patch.

Definition at line 159 of file temperatureCoupledBase.H.

◆ method_

const KMethodType method_

protected

How to get K.

Definition at line 164 of file temperatureCoupledBase.H.

Referenced by temperatureCoupledBase::KMethod(), and temperatureCoupledBase::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 temperatureCoupledBase::kappaName(), and temperatureCoupledBase::write().

◆ alphaName_

const word alphaName_

protected

Name of thermal diffusivity.

Definition at line 174 of file temperatureCoupledBase.H.

Referenced by temperatureCoupledBase::alphaName(), and temperatureCoupledBase::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 temperatureCoupledBase::write().

◆ kappaFunction1_

autoPtr<PatchFunction1<scalar> > kappaFunction1_

protected

Function1 for kappa.

Definition at line 184 of file temperatureCoupledBase.H.

Referenced by temperatureCoupledBase::write().

◆ alphaFunction1_

autoPtr<PatchFunction1<scalar> > alphaFunction1_

protected

Function1 for alpha.

Definition at line 189 of file temperatureCoupledBase.H.

Referenced by temperatureCoupledBase::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_