CD_ItoSpecies.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_ITOSPECIES_H
#define CD_ITOSPECIES_H
 
// Chombo includes
#include <List.H>
 
// Our includes
#include <CD_ItoParticle.H>
#include <CD_NamespaceHeader.H>
 
class ItoSpecies
{
public:
  ItoSpecies();
 
  ItoSpecies(const std::string& a_name, const int a_chargeNumber, const bool a_mobile, const bool a_diffusive);
 
  virtual ~ItoSpecies();
 
  std::string
  getName() const;
 
  int
  getChargeNumber() const;
 
  const std::function<Real(const RealVect& x, const Real& t)>&
  getInitialDensity() const;
 
  bool
  isDiffusive() const;
 
  bool
  isMobile() const;
 
  virtual Real
  mobility(const Real a_energy) const;
 
  virtual Real
  diffusion(const Real a_energy) const;
 
  virtual void
  setInitialDensity(const std::function<Real(const RealVect& x, const Real& t)>& a_initialDensity);
 
  List<ItoParticle>&
  getInitialParticles();
 
  const List<ItoParticle>&
  getInitialParticles() const;
 
protected:
  std::string m_name;
 
  int m_chargeNumber;
 
  int m_maxInitialParticlesPerCell;
 
  bool m_isDiffusive;
 
  bool m_isMobile;
 
  List<ItoParticle> m_initialParticles;
 
  std::function<Real(const RealVect& x, const Real& t)> m_initialDensity;
};
 
#include <CD_NamespaceFooter.H>
 
#endif