HeatTransferBase Class Reference

The HeatTransferBase class is an abstract class, the base class for all heat transfer implementations. It mostly just defines a stencil for the evaluate() function and the HeatTransferState class. More...

#include <heattransferbase.hpp>

Inheritance diagram for HeatTransferBase:

Public Member Functions
virtual	~HeatTransferBase ()
virtual HeatTransferState	evaluate (const HeatTransferState &current, const double timeStep, const double ambientTemperature, const double gasPressure, const double gasTemperature, const double gasReynoldsNumber, const double gasHeatCapacityConstantPressure, const double gasViscosity) const =0
	Evaluate heat transfer. More...
virtual HeatTransferState	makeState (const double heatFlux) const
	Make instance of HeatTransferState from heat flux. More...
virtual HeatTransferState	makeState (const double heatFlux, const double gasTemperature, const double ambientTemperature) const
	Make instance of HeatTransferState from heat flux. Overload. More...

Detailed Description

The HeatTransferBase class is an abstract class, the base class for all heat transfer implementations. It mostly just defines a stencil for the evaluate() function and the HeatTransferState class.

Constructor & Destructor Documentation

~HeatTransferBase()

virtual HeatTransferBase::~HeatTransferBase ( )

virtual

Have to declare virtual destructor to avoid compiler warnings. Only declared here, to avoid the inline compiler-generated default destructor.

Member Function Documentation

evaluate()

virtual HeatTransferState HeatTransferBase::evaluate ( const HeatTransferState &  current, const double  timeStep, const double  ambientTemperature, const double  gasPressure, const double  gasTemperature, const double  gasReynoldsNumber, const double  gasHeatCapacityConstantPressure, const double  gasViscosity  ) const

pure virtual

Evaluate heat transfer.

Parameters

current	Current heat transfer state.
timeStep	Time step [s]
ambientTemperature	Ambient temperature [K]
gasPressure	Gas pressure [Pa]
gasTemperature	Gas temperature [K]
gasReynoldsNumber	Reynolds number of gas [-]
gasHeatCapacityConstantPressure	Heat capacity ( \(c_p\)) [J/kg K]
gasViscosity	Gas dynamic viscosity [Pa s] = [kg/m*s]

Returns

HeatTransferState instance with heat flux and updated temperatures.

Implemented in SteadyStateHeatTransfer, UnsteadyHeatTransfer, FixedQValue, and FixedUValue.

makeState() [1/2]

virtual HeatTransferState HeatTransferBase::makeState ( const double  heatFlux ) const

virtual

Make instance of HeatTransferState from heat flux.

This is meant to be overriden in more advanced heat transfer implementations that that use the optional temperature property.

Parameters

heatFlux

Heat flux [W/m2]

Returns

HeatTransferState instance.

Reimplemented in RadialHeatTransfer.

makeState() [2/2]

virtual HeatTransferState HeatTransferBase::makeState ( const double  heatFlux, const double  gasTemperature, const double  ambientTemperature  ) const

virtual

Make instance of HeatTransferState from heat flux. Overload.

This version just calls HeatTransferBase::makeState(const double), but more advanced implementations should initialize the temperature property from the two temperature arguments.

Parameters

heatFlux	Heat flux [W/m2]
ambientTemperature	Ambient temperature [K]
gasTemperature	Gas temperature [K]

Returns

HeatTransferState instance with temperature.

Reimplemented in RadialHeatTransfer.

---

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

• D:/Code/transient-pipeline-flow-gh-pages/src/heattransfer/heattransferbase.hpp