BidimensionalInterpolation.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

// MOOSE includes
#include "ColumnMajorMatrix.h"
#include "MooseTypes.h"

// C++ includes
#include <vector>

class BidimensionalInterpolation
{
public:
  BidimensionalInterpolation(const std::vector<Real> & x1, const std::vector<Real> & x2);

  virtual ~BidimensionalInterpolation() = default;

  std::vector<Real> _x1;
  std::vector<Real> _x2;

  virtual Real sample(const Real x1, const Real x2) const = 0;
  virtual ADReal sample(const ADReal & x1, const ADReal & x2) const = 0;
  virtual ChainedReal sample(const ChainedReal & x1, const ChainedReal & x2) const = 0;

  virtual Real
  sampleDerivative(const Real /*x1*/, const Real /*x2*/, unsigned int /*deriv_var*/) const
  {
    mooseError("sampleDerivative for Real numbers is not implemented for this interpolation class");
  }
  virtual ADReal
  sampleDerivative(const ADReal & /*x1*/, const ADReal & /*x2*/, unsigned int /*deriv_var*/) const
  {
    mooseError(
        "sampleDerivative for ADReal numbers is not implemented for this interpolation class");
  }
  virtual ChainedReal sampleDerivative(const ChainedReal & /*x1*/,
                                       const ChainedReal & /*x2*/,
                                       unsigned int /*deriv_var*/) const
  {
    mooseError(
        "sampleDerivative for ChainedReal numbers is not implemented for this interpolation class");
  }

  virtual Real sample2ndDerivative(Real /*x1*/, Real /*x2*/, unsigned int /*deriv_var*/) const
  {
    mooseError("sample2ndDerivative is not implemented for this interpolation class");
  }

  virtual void sampleValueAndDerivatives(
      Real /*x1*/, Real /*x2*/, Real & /* y*/, Real & /* dy1*/, Real & /* dy2*/) const
  {
    mooseError("sampleValueAndDerivatives for Real numbers is not implemented for this "
               "interpolation class");
  }
  virtual void sampleValueAndDerivatives(const ADReal & /*x1*/,
                                         const ADReal & /*x2*/,
                                         ADReal & /* y*/,
                                         ADReal & /* dy1*/,
                                         ADReal & /* dy2*/) const
  {
    mooseError("sampleValueAndDerivatives for ADReal numbers is not implemented for this "
               "interpolation class");
  }
  virtual void sampleValueAndDerivatives(const ChainedReal & /*x1*/,
                                         const ChainedReal & /*x2*/,
                                         ChainedReal & /* y*/,
                                         ChainedReal & /* dy1*/,
                                         ChainedReal & /* dy2*/) const
  {
    mooseError("sampleValueAndDerivatives for ChainedReal numbers is not implemented for this "
               "interpolation class");
  }
};