PiecewiseMultiInterpolation.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 "Function.h"
#include "GriddedData.h"

class PiecewiseMultiInterpolation : public Function
{
public:
  static InputParameters validParams();

  PiecewiseMultiInterpolation(const InputParameters & parameters);

  // Necessary for using forward declaration of GriddedData in std::unique_ptr
  virtual ~PiecewiseMultiInterpolation();

  using Function::value;
  virtual Real value(Real t, const Point & pt) const override;
  virtual ADReal value(const ADReal & t, const ADPoint & p) const override;

protected:
  typedef GriddedData::GridPoint GridPoint;
  typedef GriddedData::ADGridPoint ADGridPoint;
  typedef GriddedData::GridIndex GridIndex;

  template <bool is_ad>
  Moose::GenericType<GridPoint, is_ad>
  pointInGrid(const Moose::GenericType<Real, is_ad> & t,
              const Moose::GenericType<Point, is_ad> & p) const;

  virtual Real sample(const GridPoint & pt) const = 0;
  virtual ADReal sample(const ADGridPoint & pt) const;

  std::unique_ptr<GriddedData> _gridded_data;
  unsigned int _dim;

  std::vector<int> _axes;

  std::vector<std::vector<Real>> _grid;

  void getNeighborIndices(std::vector<Real> in_arr,
                          Real x,
                          unsigned int & lower_x,
                          unsigned int & upper_x) const;
};