Simple RtSpecies class for usage with ItoKMCJSON. More...

Inheritance diagram for Physics::ItoKMC::ItoKMCPhotonSpecies:

Collaboration diagram for Physics::ItoKMC::ItoKMCPhotonSpecies:

Public Member Functions
	ItoKMCPhotonSpecies (const std::string a_name, const std::function< Real(const RealVect &a_pos)> &a_kappaFunction)
	Full constructor.

virtual	~ItoKMCPhotonSpecies () noexcept
	Destructor. Does nothing.

Real	getAbsorptionCoefficient (const RealVect a_pos) const override final
	Initial data.

Public Member Functions inherited from RtSpecies
	RtSpecies ()
	Weak constructor. Sets absorption length and scattering coefficients to one.

virtual	~RtSpecies ()
	Weak constructor. Sets absorption length and scattering coefficients to one.

std::string	getName () const
	Get species name.

virtual Real	getScatteringCoefficient (const RealVect a_pos) const
	Get scattering coefficient (i.e. the inverse scattering length) at physical coordinates.

Protected Attributes
std::function< Real(const RealVect &a_position)>	m_kappa
	Absorption function.

Protected Attributes inherited from RtSpecies
std::string	m_name
	Group name.

Detailed Description

Simple RtSpecies class for usage with ItoKMCJSON.

Constructor & Destructor Documentation

Physics::ItoKMC::ItoKMCPhotonSpecies::ItoKMCPhotonSpecies	(	const std::string	a_name,
		const std::function< Real(const RealVect &a_pos)> &	a_kappaFunction
	)

inline

Full constructor.

Parameters

[in]	a_name	Name of the species
[in]	a_kappaFunction	Absorption function

Real Physics::ItoKMC::ItoKMCPhotonSpecies::getAbsorptionCoefficient ( const RealVect a_pos ) const

inlinefinaloverridevirtual

Initial data.

Implements RtSpecies.

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