CD_ItoKMCCDRSpecies.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_ITOKMCCDRSPECIES_H
#define CD_ITOKMCCDRSPECIES_H
 
// Std includes
#include <functional>
 
// Our includes
#include <CD_CdrSpecies.H>
#include <CD_NamespaceHeader.H>
 
namespace Physics {
  namespace ItoKMC {
 
    class ItoKMCCDRSpecies : public CdrSpecies
    {
    public:
      using FunctionXt = std::function<Real(const RealVect a_position, const Real a_time)>;
 
      ItoKMCCDRSpecies(const std::string& a_name,
                       const int          a_chargeNumber,
                       const bool         a_isMobile,
                       const bool         a_isDiffusive)
      {
        m_name         = a_name;
        m_chargeNumber = a_chargeNumber;
        m_isMobile     = a_isMobile;
        m_isDiffusive  = a_isDiffusive;
 
        m_initialParticles.clear();
 
        m_initialData = [&](const RealVect& a_pos, const Real a_time) -> Real {
          return 0.0;
        };
      }
 
      virtual ~ItoKMCCDRSpecies() noexcept
      {}
 
      virtual Real
      initialData(const RealVect& a_pos, const Real a_time) const override final
      {
        return m_initialData(a_pos, a_time);
      }
 
      virtual void
      setInitialData(const FunctionXt& a_initialData)
      {
        m_initialData = a_initialData;
      }
 
    protected:
      FunctionXt m_initialData;
    };
 
  } // namespace ItoKMC
} // namespace Physics
 
#include <CD_NamespaceFooter.H>
 
#endif