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

#include "SplineInterpolationBase.h"

class BicubicSplineInterpolation : public SplineInterpolationBase
{
public:
  BicubicSplineInterpolation();
  BicubicSplineInterpolation(const std::vector<Real> & x1,
                             const std::vector<Real> & x2,
                             const std::vector<std::vector<Real>> & y,
                             const std::vector<Real> & yx11 = std::vector<Real>(),
                             const std::vector<Real> & yx1n = std::vector<Real>(),
                             const std::vector<Real> & yx21 = std::vector<Real>(),
                             const std::vector<Real> & yx2n = std::vector<Real>());

  virtual ~BicubicSplineInterpolation() = default;

  void setData(const std::vector<Real> & x1,
               const std::vector<Real> & x2,
               const std::vector<std::vector<Real>> & y,
               const std::vector<Real> & yx11 = std::vector<Real>(),
               const std::vector<Real> & yx1n = std::vector<Real>(),
               const std::vector<Real> & yx21 = std::vector<Real>(),
               const std::vector<Real> & yx2n = std::vector<Real>());

  void errorCheck();

  Real sample(Real x1, Real x2, Real yx11 = _deriv_bound, Real yx1n = _deriv_bound);

  void sampleValueAndDerivatives(Real x1,
                                 Real x2,
                                 Real & y,
                                 Real & dy1,
                                 Real & dy2,
                                 Real yx11 = _deriv_bound,
                                 Real yx1n = _deriv_bound,
                                 Real yx21 = _deriv_bound,
                                 Real yx2n = _deriv_bound);

  Real sampleDerivative(
      Real x1, Real x2, unsigned int deriv_var, Real yp1 = _deriv_bound, Real ypn = _deriv_bound);

  Real sample2ndDerivative(
      Real x1, Real x2, unsigned int deriv_var, Real yp1 = _deriv_bound, Real ypn = _deriv_bound);

protected:
  std::vector<Real> _x1;
  std::vector<Real> _x2;
  std::vector<std::vector<Real>> _y;
  std::vector<std::vector<Real>> _y_trans;

  std::vector<Real> _yx11;
  std::vector<Real> _yx1n;
  std::vector<Real> _yx21;
  std::vector<Real> _yx2n;

  std::vector<std::vector<Real>> _y2_rows;
  std::vector<std::vector<Real>> _y2_columns;

  std::vector<Real> _row_spline_second_derivs;
  std::vector<Real> _row_spline_eval;
  std::vector<Real> _column_spline_second_derivs;
  std::vector<Real> _column_spline_eval;

  void constructRowSplineSecondDerivativeTable();
  void constructColumnSplineSecondDerivativeTable();

  void solve();

  void constructRowSpline(Real x1,
                          std::vector<Real> & spline_eval,
                          std::vector<Real> & spline_second_derivs,
                          Real yx11 = _deriv_bound,
                          Real yx1n = _deriv_bound);

  void constructColumnSpline(Real x2,
                             std::vector<Real> & spline_eval,
                             std::vector<Real> & spline_second_derivs,
                             Real yx21 = _deriv_bound,
                             Real yx2n = _deriv_bound);

  static int _file_number;
};