12 #ifndef CD_ItoKMCBackgroundSpecies_H
13 #define CD_ItoKMCBackgroundSpecies_H
22 #include <CD_NamespaceHeader.H>
96 #include <CD_NamespaceFooter.H>
Encapsulation of a background species for usage with ItoKMCJSON.
Definition: CD_ItoKMCBackgroundSpecies.H:31
std::string getName() const noexcept
Get the species name.
Definition: CD_ItoKMCBackgroundSpecies.cpp:49
void define(const std::string &a_name, const MolarFraction &a_molarFraction) noexcept
Define function. Puts object in usable state.
Definition: CD_ItoKMCBackgroundSpecies.cpp:33
ItoKMCBackgroundSpecies() noexcept
Default constructor. Must subsequently call the define function.
Definition: CD_ItoKMCBackgroundSpecies.cpp:18
MolarFraction m_molarFraction
Initial data function.
Definition: CD_ItoKMCBackgroundSpecies.H:91
Real molarFraction(const RealVect a_pos) const noexcept
Get molar fraction at the physical coordinates.
Definition: CD_ItoKMCBackgroundSpecies.cpp:41
std::string m_name
Neutral species name.
Definition: CD_ItoKMCBackgroundSpecies.H:86
std::function< Real(const RealVect a_pos)> MolarFraction
Alias for position-dependent molar fraction.
Definition: CD_ItoKMCBackgroundSpecies.H:36
bool m_isDefined
Make sure model has initial data.
Definition: CD_ItoKMCBackgroundSpecies.H:81
Name containing various physics models for running chombo-discharge code.
Definition: CD_AdvectionDiffusion.H:15