Public Types | Public Member Functions | 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 }
 Type of supplied emissivity. 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 fvPatchFieldMapper &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...
 
scalarField emissivity () const
 Calculate corresponding emissivity field. More...
 
virtual void autoMap (const fvPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object. More...
 
virtual void rmap (const fvPatchScalarField &, const labelList &)
 Reverse map the given fvPatchField onto this fvPatchField. More...
 
void write (Ostream &) const
 Write. More...
 

Protected Attributes

const emissivityMethodType method_
 How to get emissivity. More...
 
scalarField emissivity_
 Emissivity. 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

Source files

Definition at line 55 of file radiationCoupledBase.H.

Member Enumeration Documentation

◆ emissivityMethodType

Type of supplied emissivity.

Enumerator
SOLIDRADIATION 
LOOKUP 

Definition at line 60 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 63 of file radiationCoupledBase.C.

Referenced by NamedEnum< directionType, 3 >::names(), and radiationCoupledBase::radiationCoupledBase().

Here is the caller graph for this function:

◆ radiationCoupledBase() [2/3]

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

Construct from patch, emissivity mode and emissivity and mapper.

Definition at line 76 of file radiationCoupledBase.C.

References radiationCoupledBase::radiationCoupledBase().

Here is the call graph for this function:

◆ radiationCoupledBase() [3/3]

radiationCoupledBase ( const fvPatch patch,
const dictionary dict 
)

Construct from patch and dictionary.

Definition at line 90 of file radiationCoupledBase.C.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, and dictionary::found().

Here is the call graph for this function:

◆ ~radiationCoupledBase()

~radiationCoupledBase ( )
virtual

Destructor.

Definition at line 140 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 132 of file radiationCoupledBase.H.

References radiationCoupledBase::autoMap(), radiationCoupledBase::emissivity(), radiationCoupledBase::method_, radiationCoupledBase::rmap(), and radiationCoupledBase::write().

Here is the call graph for this function:

◆ emissivity()

Foam::scalarField emissivity ( ) const

◆ autoMap()

void autoMap ( const fvPatchFieldMapper m)
virtual

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

Reimplemented in MarshakRadiationFixedTemperatureFvPatchScalarField, and MarshakRadiationFvPatchScalarField.

Definition at line 207 of file radiationCoupledBase.C.

References radiationCoupledBase::rmap().

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

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

◆ rmap()

void rmap ( const fvPatchScalarField ptf,
const labelList addr 
)
virtual

Reverse map the given fvPatchField onto this fvPatchField.

Reimplemented in MarshakRadiationFixedTemperatureFvPatchScalarField, and MarshakRadiationFvPatchScalarField.

Definition at line 216 of file radiationCoupledBase.C.

References radiationCoupledBase::emissivity_, and radiationCoupledBase::rmap().

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

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

◆ write()

void write ( Ostream os) const

Member Data Documentation

◆ method_

const emissivityMethodType method_
protected

How to get emissivity.

Definition at line 83 of file radiationCoupledBase.H.

Referenced by radiationCoupledBase::emissivityMethod().

◆ emissivity_

scalarField emissivity_
protected

Emissivity.

Cached locally when is read from dictionary (lookup mode)

Definition at line 87 of file radiationCoupledBase.H.

Referenced by radiationCoupledBase::rmap().


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