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

Inheritance diagram for temperatureCoupledBase:

Collaboration diagram for temperatureCoupledBase:

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

Public Member Functions
	temperatureCoupledBase (const fvPatch &patch, const word &calculationMethod, const word &kappaName, const word &alphaAniName, const word &alphaName)
	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...

	temperatureCoupledBase (const temperatureCoupledBase &)
	Construct as copy. More...

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

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

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

const word &	alphaName () const
	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	alphaAniName_
	Name of the non-Isotropic alpha (default: Anialpha) More...

const word	alphaName_
	Name of thermal diffusivity. 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	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 135 of file temperatureCoupledBase.H.

Member Enumeration Documentation

◆ KMethodType

enum KMethodType

Type of supplied Kappa.

Enumerator
mtFluidThermo
mtSolidThermo
mtDirectionalSolidThermo
mtLookup
mtFunction

Definition at line 142 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
	)

Construct from patch and K name.

Definition at line 54 of file temperatureCoupledBase.C.

◆ temperatureCoupledBase() [2/4]

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

Construct from patch and dictionary.

Definition at line 71 of file temperatureCoupledBase.C.

References temperatureCoupledBase::alphaFunction1_, dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::found(), temperatureCoupledBase::kappaFunction1_, temperatureCoupledBase::KMethodTypeNames_, temperatureCoupledBase::method_, temperatureCoupledBase::mtDirectionalSolidThermo, temperatureCoupledBase::mtFunction, temperatureCoupledBase::mtLookup, Time::New(), and Foam::nl.

Here is the call graph for this function:

◆ temperatureCoupledBase() [3/4]

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

Construct from patch and temperatureCoupledBase.

Definition at line 154 of file temperatureCoupledBase.C.

◆ temperatureCoupledBase() [4/4]

temperatureCoupledBase ( const temperatureCoupledBase & base )

Construct as copy.

Definition at line 139 of file temperatureCoupledBase.C.

◆ ~temperatureCoupledBase()

virtual ~temperatureCoupledBase ( )

virtualdefault

Destructor.

Member Function Documentation

◆ KMethod()

word KMethod ( ) const

inline

Method to obtain K.

Definition at line 222 of file temperatureCoupledBase.H.

References temperatureCoupledBase::KMethodTypeNames_, and temperatureCoupledBase::method_.

◆ kappaName()

const word & kappaName ( ) const

inline

Name of thermal conductivity field.

Definition at line 228 of file temperatureCoupledBase.H.

References temperatureCoupledBase::kappaName_.

◆ alphaName()

const word & alphaName ( ) const

inline

Name of thermal diffusivity field.

Definition at line 234 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 filmPyrolysisRadiativeCoupledMixedFvPatchScalarField, externalWallHeatFluxTemperatureFvPatchScalarField, fixedIncidentRadiationFvPatchScalarField, humidityTemperatureCoupledMixedFvPatchScalarField, lumpedMassWallTemperatureFvPatchScalarField, turbulentTemperatureCoupledBaffleMixedFvPatchScalarField, turbulentTemperatureRadCoupledMixedFvPatchScalarField, and contactHeatFluxSource.

Definition at line 172 of file temperatureCoupledBase.C.

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

Definition at line 188 of file temperatureCoupledBase.C.

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

Definition at line 210 of file temperatureCoupledBase.C.

References polyMesh::boundaryMesh(), objectRegistry::cfindObject(), basicThermo::dictName, Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::flatOutput(), objectRegistry::foundObject(), basicThermo::kappa(), multiphaseInterSystem::kappaEff(), objectRegistry::lookupObject(), mesh, polyBoundaryMesh::mesh(), n, fvMesh::name(), Foam::nl, multiphaseInterSystem::phasePropertiesName, and turbulenceModel::propertiesName.

Referenced by filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs(), and humidityTemperatureCoupledMixedFvPatchScalarField::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 366 of file temperatureCoupledBase.C.

References basicThermo::alpha(), polyMesh::boundaryMesh(), objectRegistry::cfindObject(), basicThermo::dictName, Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::flatOutput(), objectRegistry::foundObject(), objectRegistry::lookupObject(), mesh, polyBoundaryMesh::mesh(), n, fvMesh::name(), Foam::nl, and turbulenceModel::propertiesName.

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

Write.

Definition at line 516 of file temperatureCoupledBase.C.

References os(), and Ostream::writeEntry().

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

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

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

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

◆ kappaName_

const word kappaName_

protected

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

Definition at line 165 of file temperatureCoupledBase.H.

Referenced by temperatureCoupledBase::kappaName().

◆ alphaAniName_

const word alphaAniName_

protected

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

Definition at line 168 of file temperatureCoupledBase.H.

◆ alphaName_

const word alphaName_

protected

Name of thermal diffusivity.

Definition at line 171 of file temperatureCoupledBase.H.

Referenced by temperatureCoupledBase::alphaName().

◆ kappaFunction1_

autoPtr<PatchFunction1<scalar> > kappaFunction1_

protected

Function1 for kappa.

Definition at line 174 of file temperatureCoupledBase.H.

Referenced by temperatureCoupledBase::temperatureCoupledBase().

◆ alphaFunction1_

autoPtr<PatchFunction1<scalar> > alphaFunction1_

protected

Function1 for alpha.

Definition at line 177 of file temperatureCoupledBase.H.

Referenced by temperatureCoupledBase::temperatureCoupledBase().

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/4]

◆ temperatureCoupledBase() [2/4]

◆ temperatureCoupledBase() [3/4]

◆ temperatureCoupledBase() [4/4]

◆ ~temperatureCoupledBase()

Member Function Documentation

◆ KMethod()

◆ kappaName()

◆ alphaName()

◆ autoMap()

◆ rmap()

◆ kappa()

◆ alpha()

◆ write()

Member Data Documentation

◆ KMethodTypeNames_

◆ patch_

◆ method_

◆ kappaName_

◆ alphaAniName_

◆ alphaName_

◆ kappaFunction1_

◆ alphaFunction1_