chombo-discharge
CD_ItoKMCCDRSpecies.H
1 /* chombo-discharge
2  * Copyright © 2023 SINTEF Energy Research.
3  * Please refer to Copyright.txt and LICENSE in the chombo-discharge root directory.
4  */
5 
12 #ifndef CD_ItoKMCCDRSpecies_H
13 #define CD_ItoKMCCDRSpecies_H
14 
15 // Our includes
16 #include <CD_CdrSpecies.H>
17 #include <CD_NamespaceHeader.H>
18 
19 namespace Physics {
20  namespace ItoKMC {
21 
26  {
27  public:
35  ItoKMCCDRSpecies(const std::string a_name,
36  const int a_chargeNumber,
37  const bool a_isMobile,
38  const bool a_isDiffusive)
39  {
40  m_name = a_name;
41  m_chargeNumber = a_chargeNumber;
42  m_isMobile = a_isMobile;
43  m_isDiffusive = a_isDiffusive;
44 
45  m_initialParticles.clear();
46  }
47 
51  virtual ~ItoKMCCDRSpecies() noexcept
52  {}
53 
57  Real
58  initialData(const RealVect a_pos, const Real a_time) const override final
59  {
60  return 0.0;
61  }
62  };
63  } // namespace ItoKMC
64 } // namespace Physics
65 
66 #include <CD_NamespaceFooter.H>
67 
68 #endif
Declaration of a class that passes information into CdrSolver (e.g., initial conditions).
Abstract class that describes the scalar quantity that is advected in CdrSolver.
Definition: CD_CdrSpecies.H:30
bool m_isMobile
Mobile CdrSpecies or not.
Definition: CD_CdrSpecies.H:114
List< PointParticle > m_initialParticles
Initial particles.
Definition: CD_CdrSpecies.H:119
bool m_isDiffusive
Diffusive CdrSpecies or not.
Definition: CD_CdrSpecies.H:109
int m_chargeNumber
Charge.
Definition: CD_CdrSpecies.H:104
std::string m_name
Cdr_Species name.
Definition: CD_CdrSpecies.H:99
Simple CdrSpecies class for usage with ItoKMC.
Definition: CD_ItoKMCCDRSpecies.H:26
ItoKMCCDRSpecies(const std::string a_name, const int a_chargeNumber, const bool a_isMobile, const bool a_isDiffusive)
Full constructor.
Definition: CD_ItoKMCCDRSpecies.H:35
Real initialData(const RealVect a_pos, const Real a_time) const override final
Initial data.
Definition: CD_ItoKMCCDRSpecies.H:58
virtual ~ItoKMCCDRSpecies() noexcept
Destructor. Does nothing.
Definition: CD_ItoKMCCDRSpecies.H:51
Name containing various physics models for running chombo-discharge code.
Definition: CD_AdvectionDiffusion.H:15