LinearInterpolation.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "Moose.h"
#include "MooseTypes.h"

#include <vector>
#include <string>

class LinearInterpolation
{
public:
  /* Constructor, Takes two vectors of points for which to apply the fit.  One should be of the
   * independent variable while the other should be of the dependent variable.  These values should
   * correspond to one and other in the same position.
   */
  LinearInterpolation(const std::vector<Real> & X,
                      const std::vector<Real> & Y,
                      const bool extrap = false);
  LinearInterpolation() : _x(std::vector<Real>()), _y(std::vector<Real>()), _extrap(false) {}

  virtual ~LinearInterpolation() = default;

  void setData(const std::vector<Real> & X, const std::vector<Real> & Y)
  {
    _x = X;
    _y = Y;
    errorCheck();
  }

  void errorCheck();

  template <typename T>
  T sample(const T & x) const;

  template <typename T>
  T sampleDerivative(const T & x) const;

  unsigned int getSampleSize() const;

  Real integrate();

  Real integratePartial(Real x1, Real x2) const;

  Real domain(int i) const;
  Real range(int i) const;

private:
  std::vector<Real> _x;
  std::vector<Real> _y;

  bool _extrap;
};

// for backwards compatibility
typedef LinearInterpolation ADLinearInterpolation;

// temporary fixes to avoid breaking bison
template <typename T>
class LinearInterpolationTempl : public LinearInterpolation
{
public:
  using LinearInterpolation::LinearInterpolation;
};