CD_LookupTable1D.H

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2021-2026 SINTEF Energy Research
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 */
 
#ifndef CD_LOOKUPTABLE1D_H
#define CD_LOOKUPTABLE1D_H
 
// Std includes
#include <iostream>
#include <vector>
#include <array>
#include <type_traits>
 
// Our includes
#include <CD_LookupTable.H>
#include <CD_NamespaceHeader.H>
 
template <typename T = Real, size_t N = 1, typename I = std::enable_if_t<std::is_floating_point<T>::value>>
class LookupTable1D
{
public:
  static_assert(N >= 1, "LookupTable1D<N> must have N >= 1");
 
  LookupTable1D() noexcept;
 
  virtual ~LookupTable1D() noexcept = default;
 
  inline void
  reset() noexcept;
 
  template <size_t M, typename... Ts>
  LookupTable1D<T, M, I>
  slice(const Ts&... a_columns) const noexcept;
 
  template <typename... Ts>
  inline void
  addData(const Ts&... x) noexcept;
 
  inline void
  addData(const std::array<T, N + 1>& x) noexcept;
 
  inline void
  swap(size_t a_columnOne, size_t a_columnTwo) noexcept;
 
  template <size_t K>
  inline void
  scale(const T& a_scale) noexcept;
 
  inline void
  truncate(const T& a_min, const T& a_max, size_t a_column) noexcept;
 
  inline void
  setRangeStrategyLo(const LookupTable::OutOfRangeStrategy& a_strategy) noexcept;
 
  inline void
  setRangeStrategyHi(const LookupTable::OutOfRangeStrategy& a_strategy) noexcept;
 
  inline void
  prepareTable(const size_t& a_independentVariable, const size_t& a_numPoints, const LookupTable::Spacing& a_spacing);
 
  template <size_t K>
  inline T
  interpolate(const T& a_x) const;
 
  inline std::array<T, N + 1>
  interpolate(const T& x) const;
 
  inline std::vector<std::array<T, N + 1>>&
  getRawData() noexcept;
 
  inline std::vector<std::array<T, N + 1>>&
  getStructuredData() noexcept;
 
  inline const std::vector<std::array<T, N + 1>>&
  getRawData() const noexcept;
 
  inline const std::vector<std::array<T, N + 1>>&
  getStructuredData() const noexcept;
 
  inline void
  writeRawData(const std::string& a_file) const noexcept;
 
  inline void
  writeStructuredData(const std::string& a_file) const noexcept;
 
  inline void
  outputRawData(std::ostream& a_ostream = std::cout) const noexcept;
 
  inline void
  outputStructuredData(std::ostream& a_ostream = std::cout) const noexcept;
 
protected:
  bool m_isGood;
 
  LookupTable::OutOfRangeStrategy m_rangeStrategyLo;
 
  LookupTable::OutOfRangeStrategy m_rangeStrategyHi;
 
  std::tuple<LookupTable::Spacing, size_t, T, T, T> m_grid;
 
  std::vector<std::array<T, N + 1>> m_rawData;
 
  std::vector<std::array<T, N + 1>> m_structuredData;
 
  inline void
  outputData(std::ostream& a_ostream, const std::vector<std::array<T, N + 1>>& a_data) const noexcept;
 
  inline void
  writeToFile(const std::string& a_file, const std::vector<std::array<T, N + 1>>& a_data) const noexcept;
 
  inline size_t
  getIndexLo(const T& a_x) const;
};
 
#include <CD_NamespaceFooter.H>
 
#include <CD_LookupTable1DImplem.H>
 
#endif