CdrSpecies Class Reference

Abstract class that describes the scalar quantity that is advected in CdrSolver. More...

#include <CD_CdrSpecies.H>

Inheritance diagram for CdrSpecies:

Public Member Functions
	CdrSpecies ()
	Weak constructor.
	CdrSpecies (const std::string a_name, const int a_chargeNumber, const bool a_isMobile, const bool a_isDiffusive)
	Full constructor.
virtual	~CdrSpecies ()
	Destructor (does nothing)
virtual Real	initialData (const RealVect a_pos, const Real a_time) const =0
	Initial data.
virtual std::string	getName () const
	Return name.
virtual int	getChargeNumber () const
	Return charge.
virtual bool	isDiffusive () const
	Diffusive species or not.
virtual bool	isMobile () const
	Mobile species or not.
virtual const List< PointParticle > &	getInitialParticles () const
	Get initial particles.
List< PointParticle > &	getInitialParticles ()
	Get initial particles.

Protected Attributes
std::string	m_name
	Cdr_Species name.
int	m_chargeNumber
	Charge.
bool	m_isDiffusive
	Diffusive CdrSpecies or not.
bool	m_isMobile
	Mobile CdrSpecies or not.
List< PointParticle >	m_initialParticles
	Initial particles.

Detailed Description

Abstract class that describes the scalar quantity that is advected in CdrSolver.

Instantiations of CdrSpecies (i.e., derived classes thereof) can be passed into CdrSolver in order to provide run-time information to the class. The user will typically set a name for the advected quantity, the chargeNumber (if there is one), and whether or not advection and diffusion is turned on or off.

Constructor & Destructor Documentation

CdrSpecies()

CdrSpecies::CdrSpecies	(	const std::string	a_name,
		const int	a_chargeNumber,
		const bool	a_isMobile,
		const bool	a_isDiffusive
	)

Full constructor.

Parameters

[in]	a_name	Name of the species
[in]	a_chargeNumber	Charge number
[in]	a_isMbile	Mobile or not
[in]	a_isDiffusive	Diffusive or not

Member Function Documentation

initialData()

Real CdrSpecies::initialData ( const RealVect  a_pos, const Real  a_time  ) const

pure virtual

Initial data.

Parameters

[in]	a_pos	Position.
[in]	a_time	Time

Implemented in Physics::AdvectionDiffusion::AdvectionDiffusionSpecies, Physics::DischargeInception::DischargeInceptionSpecies, Physics::CdrPlasma::CdrSpeciesJSON, and Physics::ItoKMC::ItoKMCCDRSpecies.

---

The documentation for this class was generated from the following files:

• Source/ConvectionDiffusionReaction/CD_CdrSpecies.H
• Source/ConvectionDiffusionReaction/CD_CdrSpecies.cpp