MultiDimensionalInterpolation.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 "ADReal.h"
#include "MultiIndex.h"
#include <vector>
#include <string>

template <typename T>
class MultiDimensionalInterpolationTempl
{
public:
  MultiDimensionalInterpolationTempl(const std::vector<std::vector<Real>> & base_points,
                                     const MultiIndex<Real> & data);
  MultiDimensionalInterpolationTempl();

  virtual ~MultiDimensionalInterpolationTempl() = default;

  unsigned int dim() const { return _original_dim; }

  void setData(const std::vector<std::vector<Real>> & base_points, const MultiIndex<Real> & data);

  void linearSearch(std::vector<T> & values, MultiIndex<Real>::size_type & indices) const;

  T multiLinearInterpolation(const std::vector<T> & x) const;

protected:
  void errorCheck();

  unsigned int linearSearchHelper(T & x, const std::vector<Real> & vector) const;

  unsigned int _original_dim;

  std::vector<bool> _degenerate_index;

  bool _degenerate_interpolation = false;

private:
  std::vector<std::vector<Real>> _base_points;
  MultiIndex<Real> _data;
  bool _setup_complete = false;
};

typedef MultiDimensionalInterpolationTempl<Real> MultiDimensionalInterpolation;
typedef MultiDimensionalInterpolationTempl<ADReal> DualMultiDimensionalInterpolation;
typedef DualMultiDimensionalInterpolation ADMultiDimensionalInterpolation;