LinearInterpolationTempl< T > Class Template Reference

#include <LinearInterpolation.h>

Inheritance diagram for LinearInterpolationTempl< T >:

Public Member Functions
	LinearInterpolation (const std::vector< Real > &X, const std::vector< Real > &Y, const bool extrap=false)
	LinearInterpolation ()
void	setData (const std::vector< Real > &X, const std::vector< Real > &Y)
	Set the x and y values. More...
void	errorCheck ()
template<typename T >
T	sample (const T &x) const
	This function will take an independent variable input and will return the dependent variable based on the generated fit. More...
template<typename T >
T	sampleDerivative (const T &x) const
	This function will take an independent variable input and will return the derivative of the dependent variable with respect to the independent variable based on the generated fit. More...
unsigned int	getSampleSize () const
	This function returns the size of the array holding the points, i.e. More...
Real	integrate ()
	This function returns the integral of the function. More...
Real	domain (int i) const
Real	range (int i) const

Detailed Description

template<typename T>
class LinearInterpolationTempl< T >

Definition at line 88 of file LinearInterpolation.h.

Member Function Documentation

domain()

Real LinearInterpolation::domain ( int  i ) const

inherited

Definition at line 127 of file LinearInterpolation.C.

{
  return _x[i];
}

errorCheck()

void LinearInterpolation::errorCheck ( )

inherited

Definition at line 28 of file LinearInterpolation.C.

Referenced by LinearInterpolation::LinearInterpolation(), and LinearInterpolation::setData().

{
  if (_x.size() != _y.size())
    throw std::domain_error("Vectors are not the same length");

  for (unsigned int i = 0; i + 1 < _x.size(); ++i)
    if (_x[i] >= _x[i + 1])
    {
      std::ostringstream oss;
      oss << "x-values are not strictly increasing: x[" << i << "]: " << _x[i] << " x[" << i + 1
          << "]: " << _x[i + 1];
      throw std::domain_error(oss.str());
    }
}

getSampleSize()

unsigned int LinearInterpolation::getSampleSize ( ) const

inherited

This function returns the size of the array holding the points, i.e.

the number of sample points

Definition at line 139 of file LinearInterpolation.C.

{
  return _x.size();
}

integrate()

Real LinearInterpolation::integrate ( )

inherited

This function returns the integral of the function.

Definition at line 117 of file LinearInterpolation.C.

{
  Real answer = 0;
  for (unsigned int i = 1; i < _x.size(); ++i)
    answer += 0.5 * (_y[i] + _y[i - 1]) * (_x[i] - _x[i - 1]);

  return answer;
}

LinearInterpolation() [1/2]

template<typename T >

LinearInterpolation::LinearInterpolation

inline

Definition at line 31 of file LinearInterpolation.h.

: _x(std::vector<Real>()), _y(std::vector<Real>()), _extrap(false) {}

LinearInterpolation() [2/2]

template<typename T >

LinearInterpolation::LinearInterpolation

Definition at line 19 of file LinearInterpolation.C.

  : _x(x), _y(y), _extrap(extrap)
{
  errorCheck();
}

range()

Real LinearInterpolation::range ( int  i ) const

inherited

Definition at line 133 of file LinearInterpolation.C.

{
  return _y[i];
}

sample()

template<typename T >

template ChainedReal LinearInterpolation::sample< ChainedReal > ( const T &  x ) const

inherited

This function will take an independent variable input and will return the dependent variable based on the generated fit.

Definition at line 45 of file LinearInterpolation.C.

Referenced by IterationAdaptiveDT::computeDT(), IterationAdaptiveDT::computeInitialDT(), and IterationAdaptiveDT::computeInterpolationDT().

{
  // this is a hard error
  if (_x.empty())
    mooseError("Trying to evaluate an empty LinearInterpolation");

  // special case for single function nodes
  if (_x.size() == 1)
    return _y[0];

  // endpoint cases
  if (_extrap)
  {
    if (x < _x[0])
      return _y[0] + (x - _x[0]) / (_x[1] - _x[0]) * (_y[1] - _y[0]);
    if (x >= _x.back())
      return _y.back() +
             (x - _x.back()) / (_x[_x.size() - 2] - _x.back()) * (_y[_y.size() - 2] - _y.back());
  }
  else
  {
    if (x < _x[0])
      return _y[0];
    if (x >= _x.back())
      return _y.back();
  }

  auto upper = std::upper_bound(_x.begin(), _x.end(), x);
  int i = std::distance(_x.begin(), upper) - 1;
  return _y[i] + (_y[i + 1] - _y[i]) * (x - _x[i]) / (_x[i + 1] - _x[i]);

  // If this point is reached, x must be a NaN.
  mooseException("Sample point in LinearInterpolation is a NaN.");
}

sampleDerivative()

template<typename T >

template ChainedReal LinearInterpolation::sampleDerivative< ChainedReal > ( const T &  x ) const

inherited

This function will take an independent variable input and will return the derivative of the dependent variable with respect to the independent variable based on the generated fit.

Definition at line 86 of file LinearInterpolation.C.

{
  // endpoint cases
  if (_extrap)
  {
    if (x <= _x[0])
      return (_y[1] - _y[0]) / (_x[1] - _x[0]);
    if (x >= _x.back())
      return (_y[_y.size() - 2] - _y.back()) / (_x[_x.size() - 2] - _x.back());
  }
  else
  {
    if (x < _x[0])
      return 0.0;
    if (x >= _x.back())
      return 0.0;
  }

  auto upper = std::upper_bound(_x.begin(), _x.end(), x);
  int i = std::distance(_x.begin(), upper) - 1;
  return (_y[i + 1] - _y[i]) / (_x[i + 1] - _x[i]);

  // If this point is reached, x must be a NaN.
  mooseException("Sample point in LinearInterpolation is a NaN.");
}

setData()

void LinearInterpolation::setData ( const std::vector< Real > &  X, const std::vector< Real > &  Y  )

inlineinherited

Set the x and y values.

Definition at line 38 of file LinearInterpolation.h.

  {
    _x = X;
    _y = Y;
    errorCheck();
  }

---

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

• include/utils/LinearInterpolation.h