Physics::ItoKMC::ItoKMCCDRSpecies Class Reference

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

#include <CD_ItoKMCCDRSpecies.H>

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 ParticleSoA< NoPayload > &	getInitialParticles () const
	Get initial particles.
ParticleSoA< NoPayload > &	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.
ParticleSoA< NoPayload >	m_initialParticles
	Initial particles.

Detailed Description

Simple CdrSpecies class for usage with ItoKMC.

Member Typedef Documentation

FunctionXt

using Physics::ItoKMC::ItoKMCCDRSpecies::FunctionXt = std::function<Real(const RealVect a_position, const Real a_time)>

Function alias for e.g. initial data.

Parameters

[in]	a_position	Physical coordinates
[in]	a_time	Time

Constructor & Destructor Documentation

ItoKMCCDRSpecies()

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

[in]	a_name	Name of the species.
[in]	a_chargeNumber	Charge number (elementary charges).
[in]	a_isMobile	Mobile or not.
[in]	a_isDiffusive	Diffusive or not.

Member Function Documentation

initialData()

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	Simulation time.

Returns

Initial density at the given position and time.

Implements CdrSpecies.

setInitialData()

virtual void Physics::ItoKMC::ItoKMCCDRSpecies::setInitialData ( const FunctionXt &  a_initialData )

inlinevirtual

Set the initial data function for this species.

Parameters

[in]

a_initialData

Callable returning the initial density at (position, time).

---

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

• Physics/ItoKMC/PlasmaModels/ItoKMCJSON/CD_ItoKMCCDRSpecies.H