CD_CdrSpecies.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_CDRSPECIES_H
#define CD_CDRSPECIES_H
 
// Chombo includes
#include <List.H>
#include <RealVect.H>
 
// Our includes
#include <CD_ParticleSoA.H>
#include <CD_NamespaceHeader.H>
 
class CdrSpecies
{
public:
  CdrSpecies();
 
  CdrSpecies(const std::string& a_name, const int a_chargeNumber, const bool a_isMobile, const bool a_isDiffusive);
 
  virtual ~CdrSpecies();
 
  virtual Real
  initialData(const RealVect& a_pos, const Real a_time) const = 0;
 
  virtual std::string
  getName() const;
 
  virtual int
  getChargeNumber() const;
 
  virtual bool
  isDiffusive() const;
 
  virtual bool
  isMobile() const;
 
  virtual const ParticleSoA<NoPayload>&
  getInitialParticles() const;
 
  ParticleSoA<NoPayload>&
  getInitialParticles();
 
protected:
  std::string m_name;
 
  int m_chargeNumber;
 
  bool m_isDiffusive;
 
  bool m_isMobile;
 
  ParticleSoA<NoPayload> m_initialParticles;
};
 
#include <CD_NamespaceFooter.H>
 
#endif