BSMPT::ThermalFunctions::ThermalCoefficientCalculator Class Reference

The ThermalCoefficientCalculator class is a thread-safe wrapper around the calculation of the coefficients for the thermal expansions used in ThermalFunctions. More...

#include <BSMPT/ThermalFunctions/thermalcoefficientcalculator.h>

Public Member Functions
	ThermalCoefficientCalculator (std::function< double(int)> func, int maxOrderToPrecalc)
	ThermalCoefficientCalculator.
double	GetCoefficentAtOrder (int n) const
	GetCoefficentAtOrder.

Private Attributes
std::function< double(int)>	Calculater
	Calculater stores the function to calculate the coefficient.
const int	MaxOrderToSave
	MaxOrderToSave defines the highest order until which the coefficents are precalculated.
std::map< int, double >	PreCalculatedCoefficents
	PreCalculatedCoefficents Stores the precalculated coefficents. This will only be changed during the constructor to remain thread-safe!

Detailed Description

The ThermalCoefficientCalculator class is a thread-safe wrapper around the calculation of the coefficients for the thermal expansions used in ThermalFunctions.

Constructor & Destructor Documentation

ThermalCoefficientCalculator()

BSMPT::ThermalFunctions::ThermalCoefficientCalculator::ThermalCoefficientCalculator	(	std::function< double(int)>	func,
		int	maxOrderToPrecalc
	)

ThermalCoefficientCalculator.

Parameters

func	Describes the function to calculate the coefficents
maxOrderToPrecalc	defines until which order the coefficents are precalculated

Member Function Documentation

GetCoefficentAtOrder()

double BSMPT::ThermalFunctions::ThermalCoefficientCalculator::GetCoefficentAtOrder

(

int

n

)

const

GetCoefficentAtOrder.

Parameters

n	describes the order at which the coefficient should be calculated

Returns

The coefficent at the given order. If it was precalculated the result stored in the map will be returned, otherwise the result will be calculated.

---

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

• include/BSMPT/ThermalFunctions/thermalcoefficientcalculator.h
• src/ThermalFunctions/thermalcoefficientcalculator.cpp