CD_KMCSingleState.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_KMCSINGLESTATE_H
#define CD_KMCSINGLESTATE_H
 
// Std includes
#include <vector>
#include <cstddef>
#include <ostream>
 
// Our includes
#include <CD_NamespaceHeader.H>
 
template <typename T = long long>
class KMCSingleState
{
public:
  using State = std::vector<T>;
 
  inline KMCSingleState() = delete;
 
  inline KMCSingleState(const KMCSingleState& a_state) = default;
 
  inline KMCSingleState(const KMCSingleState&&) = delete;
 
  inline KMCSingleState(const size_t a_numSpecies) noexcept;
 
  virtual ~KMCSingleState();
 
  inline KMCSingleState&
  operator=(const KMCSingleState& a_other) = default;
 
  inline KMCSingleState&
  operator=(const KMCSingleState&&) = delete;
 
  inline T&
  operator[](const size_t a_idx) noexcept;
 
  inline const T&
  operator[](const size_t a_idx) const noexcept;
 
  inline bool
  isValidState() const noexcept;
 
  inline std::vector<T>
  linearOut() const noexcept;
 
  inline void
  linearIn(const std::vector<T>& a_linearizedState) noexcept;
 
  inline State&
  getState() noexcept;
 
  inline const State&
  getState() const noexcept;
 
protected:
  State m_state;
};
 
#include <CD_NamespaceFooter.H>
 
#include <CD_KMCSingleStateImplem.H>
 
#endif