Physics::ItoKMC::ItoKMCPhotonSpecies Class Reference

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

#include <CD_ItoKMCPhotonSpecies.H>

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.
	~ItoKMCPhotonSpecies () noexcept override=default
	Destructor. Does nothing.
	ItoKMCPhotonSpecies (const ItoKMCPhotonSpecies &a_other)=default
	Copy constructor.
ItoKMCPhotonSpecies &	operator= (const ItoKMCPhotonSpecies &a_other)=default
	Copy assignment operator.
	ItoKMCPhotonSpecies (ItoKMCPhotonSpecies &&a_other)=default
	Move constructor.
ItoKMCPhotonSpecies &	operator= (ItoKMCPhotonSpecies &&a_other)=default
	Move assignment operator.
Real	getAbsorptionCoefficient (const RealVect &a_pos) const final
	Get absorption coefficient at a physical position.
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

ItoKMCPhotonSpecies() [1/3]

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

ItoKMCPhotonSpecies() [2/3]

Physics::ItoKMC::ItoKMCPhotonSpecies::ItoKMCPhotonSpecies ( const ItoKMCPhotonSpecies &  a_other )

default

Copy constructor.

Parameters

[in]

a_other

Object to copy.

ItoKMCPhotonSpecies() [3/3]

Physics::ItoKMC::ItoKMCPhotonSpecies::ItoKMCPhotonSpecies ( ItoKMCPhotonSpecies &&  a_other )

default

Move constructor.

Parameters

[in,out]

a_other

Object to move from.

Member Function Documentation

getAbsorptionCoefficient()

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

inlinefinalvirtual

Get absorption coefficient at a physical position.

Parameters

[in]

a_pos

Physical position.

Returns

Absorption coefficient (inverse absorption length) at a_pos.

Implements RtSpecies.

operator=() [1/2]

ItoKMCPhotonSpecies & Physics::ItoKMC::ItoKMCPhotonSpecies::operator= ( const ItoKMCPhotonSpecies &  a_other )

default

Copy assignment operator.

Parameters

[in]

a_other

Object to copy.

Returns

Reference to this object.

operator=() [2/2]

ItoKMCPhotonSpecies & Physics::ItoKMC::ItoKMCPhotonSpecies::operator= ( ItoKMCPhotonSpecies &&  a_other )

default

Move assignment operator.

Parameters

[in,out]

a_other

Object to move from.

Returns

Reference to this object.

---

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

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