Simple CdrSpecies class for usage with ItoKMC. More...

Inheritance diagram for Physics::ItoKMC::ItoKMCCDRSpecies:

Collaboration diagram for Physics::ItoKMC::ItoKMCCDRSpecies:

Public Member Functions
	ItoKMCCDRSpecies (const std::string a_name, const int a_chargeNumber, const bool a_isMobile, const bool a_isDiffusive)
	Full constructor. More...

virtual	~ItoKMCCDRSpecies () noexcept
	Destructor. Does nothing.

Real	initialData (const RealVect a_pos, const Real a_time) const override final
	Initial data.

Public Member Functions inherited from CdrSpecies
	CdrSpecies ()
	Weak constructor.

	CdrSpecies (const std::string a_name, const int a_chargeNumber, const bool a_isMobile, const bool a_isDiffusive)
	Full constructor. More...

virtual	~CdrSpecies ()
	Destructor (does nothing)

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.

Additional Inherited Members
Protected Attributes inherited from CdrSpecies
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

Simple CdrSpecies class for usage with ItoKMC.

Constructor & Destructor Documentation

Physics::ItoKMC::ItoKMCCDRSpecies::ItoKMCCDRSpecies	(	const std::string	a_name,
		const int	a_chargeNumber,
		const bool	a_isMobile,
		const bool	a_isDiffusive
	)

inline

Full constructor.

Parameters

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