CD_MultiIndex.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_MULTIINDEX_H
#define CD_MULTIINDEX_H
 
// Std includes
#include <map>
 
// Chombo includes
#include <IntVect.H>
#include <RealVect.H>
 
// Our includes
#include <CD_NamespaceHeader.H>
 
class MultiIndex
{
public:
  MultiIndex() = delete;
 
  MultiIndex(const MultiIndex& a_index) = default;
 
  MultiIndex(const int a_order);
 
  ~MultiIndex() = default;
 
  void
  define(const int a_order);
 
  int
  factorial() const;
 
  IntVect
  getCurrentIndex() const;
 
  int
  getOrder() const;
 
  int
  getLinearIndex(const IntVect a_MultiIndex) const;
 
  IntVect
  getMultiIndex(const int a_linearIndex) const;
 
  MultiIndex&
  operator=(const MultiIndex& a_other) = default;
 
  int
  operator[](const int a_dir) const;
 
  void
  operator++();
 
  void
  reset();
 
  bool
  ok() const;
 
  int
  norm() const;
 
  int
  getNumIndices() const;
 
  Real
  pow(const RealVect& a_vec);
 
protected:
  int m_order;
 
  IntVect m_curIndex;
 
  std::vector<IntVect>::iterator m_iter;
 
  std::vector<IntVect> m_indices;
 
  std::map<IntVect, int> m_mapToLinearIndex;
 
  std::map<int, IntVect> m_mapToMultiIndex;
 
  int
  factorial(const int a_n) const;
 
  void
  makeIndices();
 
  void
  makeMaps();
 
private:
  static int
  norm(const IntVect a_iv);
};
 
#include <CD_NamespaceFooter.H>
 
#endif