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

Inheritance diagram for Physics::ItoKMC::ItoKMCCDRSpecies:

Collaboration diagram for Physics::ItoKMC::ItoKMCCDRSpecies:

Public Types
using	FunctionXt = std::function< Real(const RealVect a_position, const Real a_time)>
	Function alias for e.g. initial data.

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

virtual	~ItoKMCCDRSpecies () noexcept
	Destructor. Does nothing.

virtual Real	initialData (const RealVect a_pos, const Real a_time) const override final
	Returns initial data for this species.

virtual void	setInitialData (const FunctionXt &a_initialData)
	Set the initial data function for this species.

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.

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.

Protected Attributes
FunctionXt	m_initialData
	Initial data function.

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.

Member Typedef Documentation

Function alias for e.g. initial data.

Parameters

[in]	a_position	Physical coordinates
[in]	a_time	Time

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

virtual Real Physics::ItoKMC::ItoKMCCDRSpecies::initialData	(	const RealVect	a_pos,
		const Real	a_time
	)		const

inlinefinaloverridevirtual

Returns initial data for this species.

Parameters

[in]	a_pos	Physical position
[in]	a_time	Time

Implements CdrSpecies.

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