TransFlow  0.1.0
A transient pipeline flow simulation library
HeatTransfer Class Reference

The EquationOfState class is a wrapper around HeatTransferBase that has one heat transfer instance per grid point, and wraps the HeatTransferBase::evaluate() function. More...

#include <heattransfer.hpp>

Public Member Functions

virtual ~HeatTransfer ()
 Declared to avoid the inline compiler-generated default destructor.
 
 HeatTransfer (const Pipeline &pipeline, const std::string &type)
 Construct from pipeline and string to determine the type of heat transfer. More...
 
void evaluate (const std::vector< HeatTransferState > &state, const double timeStep, Pipeline &pipeline) const
 This is a wrapper around HeatTransferBase::evaluate() that calls that function for each grid point. This modifes the pipeline argument. More...
 
const HeatTransferBaseat (std::size_t pos) const
 std::vector-like at(i) getter
 
auto size () const
 std::vector-like size() operator
 

Private Attributes

std::unique_ptr< std::vector< std::unique_ptr< HeatTransferBase > > > m_heat
 Vector of HeatTransferBase instances, one for each grid point.
 

Detailed Description

The EquationOfState class is a wrapper around HeatTransferBase that has one heat transfer instance per grid point, and wraps the HeatTransferBase::evaluate() function.

Constructor & Destructor Documentation

◆ HeatTransfer()

HeatTransfer::HeatTransfer ( const Pipeline pipeline,
const std::string &  type 
)

Construct from pipeline and string to determine the type of heat transfer.

Parameters
pipelinePipeline instance
typeType of heat transfer ("BWRS", "GERG04" or "IdealGas")

Member Function Documentation

◆ evaluate()

void HeatTransfer::evaluate ( const std::vector< HeatTransferState > &  state,
const double  timeStep,
Pipeline pipeline 
) const

This is a wrapper around HeatTransferBase::evaluate() that calls that function for each grid point. This modifes the pipeline argument.

Parameters
stateCurrent heat transfer state
timeStepTime step [s]
pipelinePipeline instance

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