BilinearInterpolation.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* 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 "BidimensionalInterpolation.h"

// C++ includes
#include <vector>

class BilinearInterpolation : public BidimensionalInterpolation
{
public:
  BilinearInterpolation(const std::vector<Real> & xaxis,
                        const std::vector<Real> & yaxis,
                        const ColumnMajorMatrix & zsurface);

  virtual ~BilinearInterpolation() = default;

  Real sample(const Real s1, const Real s2) const override;
  ADReal sample(const ADReal & s1, const ADReal & s2) const override;
  ChainedReal sample(const ChainedReal & s1, const ChainedReal & s2) const override;

  Real sampleDerivative(const Real s1, const Real s2, unsigned int deriv_var) const override;
  ADReal
  sampleDerivative(const ADReal & s1, const ADReal & s2, unsigned int deriv_var) const override;
  ChainedReal sampleDerivative(const ChainedReal & s1,
                               const ChainedReal & s2,
                               unsigned int deriv_var) const override;

  using BidimensionalInterpolation::sampleValueAndDerivatives;
  void sampleValueAndDerivatives(
      Real s1, Real s2, Real & y, Real & dy_ds1, Real & dy_ds2) const override;

  void getNeighborIndices(const std::vector<Real> & inArr,
                          Real x,
                          unsigned int & lowerX,
                          unsigned int & upperX) const;

private:
  template <typename T>
  T sampleInternal(const T & s1, const T & s2) const;

  template <typename T>
  T sampleDerivativeInternal(const T s1, const T s2, const unsigned int deriv_var) const;

  ColumnMajorMatrix _z_surface;
  static int _file_number;
};