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

Common functions to emissivity. It gets supplied from lookup into a dictionary or calculated by the solidThermo: More...

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

Public Types

enum  emissivityMethodType { SOLIDRADIATION , LOOKUP }
 Emissivity methods. More...
 

Public Member Functions

 TypeName ("radiationCoupledBase")
 Runtime type information. More...
 
 radiationCoupledBase (const fvPatch &patch, const word &calculationMethod, const scalarField &emissivity)
 Construct from patch, emissivity mode and emissivity. More...
 
 radiationCoupledBase (const fvPatch &patch, const word &calculationMethod, const scalarField &emissivity, const fieldMapper &mapper)
 Construct from patch, emissivity mode and emissivity and mapper. More...
 
 radiationCoupledBase (const fvPatch &patch, const dictionary &dict)
 Construct from patch and dictionary. More...
 
virtual ~radiationCoupledBase ()
 Destructor. More...
 
word emissivityMethod () const
 Method to obtain emissivity. More...
 
tmp< scalarField > emissivity () const
 Calculate corresponding emissivity field. More...
 
virtual void map (const fvPatchScalarField &, const fieldMapper &)
 Map the given fvPatchField onto this fvPatchField. More...
 
virtual void reset (const fvPatchScalarField &)
 Reset the fvPatchField to the given fvPatchField. More...
 
void write (Ostream &) const
 Write. More...
 

Static Public Attributes

static const NamedEnum< emissivityMethodType, 2 > emissivityMethodTypeNames_
 Names of emissivity methods. More...
 

Protected Attributes

const emissivityMethodType method_
 How to get emissivity. More...
 
scalarField emissivity_
 Emissivity. Cached locally when looked up. More...
 

Detailed Description

Common functions to emissivity. It gets supplied from lookup into a dictionary or calculated by the solidThermo:

  • 'lookup' : Read the patch emissivity field from the dictionary
  • 'solidRadiation' : Use the emissivity field mapped from the adjacent solid
Source files

Definition at line 55 of file radiationCoupledBase.H.

Member Enumeration Documentation

◆ emissivityMethodType

enum emissivityMethodType

Emissivity methods.

Enumerator
SOLIDRADIATION 
LOOKUP 

Definition at line 62 of file radiationCoupledBase.H.

Constructor & Destructor Documentation

◆ radiationCoupledBase() [1/3]

radiationCoupledBase ( const fvPatch &  patch,
const word &  calculationMethod,
const scalarField &  emissivity 
)

Construct from patch, emissivity mode and emissivity.

Definition at line 61 of file radiationCoupledBase.C.

◆ radiationCoupledBase() [2/3]

radiationCoupledBase ( const fvPatch &  patch,
const word &  calculationMethod,
const scalarField &  emissivity,
const fieldMapper &  mapper 
)

Construct from patch, emissivity mode and emissivity and mapper.

Definition at line 74 of file radiationCoupledBase.C.

◆ radiationCoupledBase() [3/3]

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

Construct from patch and dictionary.

Definition at line 88 of file radiationCoupledBase.C.

References dict, radiationCoupledBase::emissivity_, radiationCoupledBase::LOOKUP, radiationCoupledBase::method_, fvPatch::size(), radiationCoupledBase::SOLIDRADIATION, and Foam::unitFraction.

Here is the call graph for this function:

◆ ~radiationCoupledBase()

~radiationCoupledBase ( )
virtual

Destructor.

Definition at line 117 of file radiationCoupledBase.C.

Member Function Documentation

◆ TypeName()

TypeName ( "radiationCoupledBase"  )

Runtime type information.

◆ emissivityMethod()

word emissivityMethod ( ) const
inline

Method to obtain emissivity.

Definition at line 134 of file radiationCoupledBase.H.

References radiationCoupledBase::emissivityMethodTypeNames_, and radiationCoupledBase::method_.

◆ emissivity()

Foam::tmp< Foam::scalarField > emissivity ( ) const

Calculate corresponding emissivity field.

Definition at line 123 of file radiationCoupledBase.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, mappedFvPatchBaseBase::getMap(), fvPatch::index(), objectRegistry::lookupObject(), mappedFvPatchBaseBase::nbrFvPatch(), mappedFvPatchBaseBase::nbrMesh(), and radiation().

Referenced by viewFactor::calculate(), and wideBandDiffusiveRadiationMixedFvPatchScalarField::wideBandDiffusiveRadiationMixedFvPatchScalarField().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ map()

void map ( const fvPatchScalarField &  ptf,
const fieldMapper &  mapper 
)
virtual

Map the given fvPatchField onto this fvPatchField.

Reimplemented in wideBandDiffusiveRadiationMixedFvPatchScalarField, MarshakRadiationFixedTemperatureFvPatchScalarField, MarshakRadiationFvPatchScalarField, greyDiffusiveViewFactorFixedValueFvPatchScalarField, and greyDiffusiveRadiationMixedFvPatchScalarField.

Definition at line 176 of file radiationCoupledBase.C.

References radiationCoupledBase::emissivity_.

Referenced by greyDiffusiveRadiationMixedFvPatchScalarField::map(), greyDiffusiveViewFactorFixedValueFvPatchScalarField::map(), MarshakRadiationFvPatchScalarField::map(), MarshakRadiationFixedTemperatureFvPatchScalarField::map(), and wideBandDiffusiveRadiationMixedFvPatchScalarField::map().

Here is the caller graph for this function:

◆ reset()

void reset ( const fvPatchScalarField &  ptf)
virtual

Reset the fvPatchField to the given fvPatchField.

Used for mesh to mesh mapping

Reimplemented in wideBandDiffusiveRadiationMixedFvPatchScalarField, MarshakRadiationFixedTemperatureFvPatchScalarField, MarshakRadiationFvPatchScalarField, greyDiffusiveViewFactorFixedValueFvPatchScalarField, and greyDiffusiveRadiationMixedFvPatchScalarField.

Definition at line 189 of file radiationCoupledBase.C.

References radiationCoupledBase::emissivity_.

Referenced by greyDiffusiveRadiationMixedFvPatchScalarField::reset(), greyDiffusiveViewFactorFixedValueFvPatchScalarField::reset(), MarshakRadiationFvPatchScalarField::reset(), MarshakRadiationFixedTemperatureFvPatchScalarField::reset(), and wideBandDiffusiveRadiationMixedFvPatchScalarField::reset().

Here is the caller graph for this function:

◆ write()

void write ( Ostream &  os) const

Write.

Definition at line 201 of file radiationCoupledBase.C.

References Foam::writeEntry().

Referenced by greyDiffusiveRadiationMixedFvPatchScalarField::write(), greyDiffusiveViewFactorFixedValueFvPatchScalarField::write(), MarshakRadiationFvPatchScalarField::write(), MarshakRadiationFixedTemperatureFvPatchScalarField::write(), and wideBandDiffusiveRadiationMixedFvPatchScalarField::write().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ emissivityMethodTypeNames_

const Foam::NamedEnum< Foam::radiationCoupledBase::emissivityMethodType, 2 > emissivityMethodTypeNames_
static

Names of emissivity methods.

Definition at line 70 of file radiationCoupledBase.H.

Referenced by radiationCoupledBase::emissivityMethod().

◆ method_

const emissivityMethodType method_
protected

How to get emissivity.

Definition at line 86 of file radiationCoupledBase.H.

Referenced by radiationCoupledBase::emissivityMethod(), and radiationCoupledBase::radiationCoupledBase().

◆ emissivity_

scalarField emissivity_
protected

Emissivity. Cached locally when looked up.

Definition at line 89 of file radiationCoupledBase.H.

Referenced by radiationCoupledBase::map(), radiationCoupledBase::radiationCoupledBase(), and radiationCoupledBase::reset().

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