CD_KMCDualState.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_KMCDUALSTATE_H
#define CD_KMCDUALSTATE_H
 
// Std includes
#include <vector>
#include <cstddef>
#include <ostream>
 
// Our includes
#include <CD_NamespaceHeader.H>
 
template <typename T = long long>
class KMCDualState
{
public:
  using State = std::vector<T>;
 
  inline KMCDualState() = default;
 
  inline KMCDualState(const KMCDualState&) = default;
 
  inline KMCDualState(const KMCDualState&&) = delete;
 
  inline KMCDualState(const size_t a_numReactiveSpecies, const size_t a_numNonReactiveSpecies) noexcept;
 
  virtual ~KMCDualState();
 
  inline KMCDualState&
  operator=(const KMCDualState& a_other) = default;
 
  inline KMCDualState&
  operator=(const KMCDualState&&) = delete;
 
  inline void
  define(const size_t a_numReactiveSpecies, const size_t a_numNonReactiveSpecies) noexcept;
 
  inline bool
  isValidState() const noexcept;
 
  inline State&
  getReactiveState() noexcept;
 
  inline const State&
  getReactiveState() const noexcept;
 
  inline State&
  getNonReactiveState() noexcept;
 
  inline const State&
  getNonReactiveState() const noexcept;
 
  inline std::vector<T>
  linearOut() const noexcept;
 
  inline void
  linearIn(const std::vector<T>& a_linearizedState) noexcept;
 
protected:
  int m_numReactiveSpecies;
 
  int m_numNonReactiveSpecies;
 
  State m_reactiveState;
 
  State m_nonReactiveState;
};
 
template <typename T>
inline std::ostream&
operator<<(std::ostream& ostr, const KMCDualState<T>& a_state);
 
#include <CD_NamespaceFooter.H>
 
#include <CD_KMCDualStateImplem.H>
 
#endif