Physics::CdrPlasma::RteSpeciesJSON Class Reference

Encapsulation of radiative transfer species for usage with CdrPlasmaJSON. More...

#include <CD_RteSpeciesJSON.H>

Inheritance diagram for Physics::CdrPlasma::RteSpeciesJSON:

Collaboration diagram for Physics::CdrPlasma::RteSpeciesJSON:

Public Types
using	KappaFunction = std::function< Real(const RealVect a_pos)>
	Alias for absorption length function.

Public Member Functions
	RteSpeciesJSON ()=default
	Default constructor. Must subsequently call define.
	RteSpeciesJSON (const std::string &a_name, const KappaFunction &a_kappaFunction)
	Full constructor. Calls the define function.
	RteSpeciesJSON (const RteSpeciesJSON &a_other)=delete
	Disallowed constructor.
	RteSpeciesJSON (const RteSpeciesJSON &&a_other)=delete
	Disallowed move constructor.
RteSpeciesJSON &	operator= (const RteSpeciesJSON &a_other)=delete
	Disallowed copy assignment.
RteSpeciesJSON &	operator= (const RteSpeciesJSON &&a_other)=delete
	Disallowed move assignment.
virtual	~RteSpeciesJSON ()
	Destructor.
void	define (const std::string &a_name, const KappaFunction &a_kappaFunction)
	Define function.
Real	getAbsorptionCoefficient (const RealVect a_pos) const override final
	Initial data function.
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
bool	m_isDefined
	Is defined or not.
KappaFunction	m_absorptionFunction
	Absorption coefficient function.
Protected Attributes inherited from RtSpecies
std::string	m_name
	Group name.

Detailed Description

Encapsulation of radiative transfer species for usage with CdrPlasmaJSON.

Member Typedef Documentation

KappaFunction

using Physics::CdrPlasma::RteSpeciesJSON::KappaFunction = std::function<Real(const RealVect a_pos)>

Alias for absorption length function.

Users must provide this in order to set the absorption coefficient (i.e., kappa) for the radiative transfer equation.

Constructor & Destructor Documentation

RteSpeciesJSON() [1/3]

RteSpeciesJSON::RteSpeciesJSON	(	const std::string &	a_name,
		const KappaFunction &	a_kappaFunction
	)

Full constructor. Calls the define function.

Parameters

[in]	a_name	Species name
[in]	a_kappaFunction	Initial data function

RteSpeciesJSON() [2/3]

Physics::CdrPlasma::RteSpeciesJSON::RteSpeciesJSON ( const RteSpeciesJSON &  a_other )

delete

Disallowed constructor.

Parameters

[in]

a_other

Other species

RteSpeciesJSON() [3/3]

Physics::CdrPlasma::RteSpeciesJSON::RteSpeciesJSON ( const RteSpeciesJSON &&  a_other )

delete

Disallowed move constructor.

Parameters

[in]

a_other

Other species

Member Function Documentation

define()

void RteSpeciesJSON::define	(	const std::string &	a_name,
		const KappaFunction &	a_kappaFunction
	)

Define function.

Parameters

[in]	a_name	Species name
[in]	a_kappaFunction	Function for setting absorption coefficient

getAbsorptionCoefficient()

Real RteSpeciesJSON::getAbsorptionCoefficient ( const RealVect  a_pos ) const

finaloverridevirtual

Initial data function.

Parameters

[in]	a_pos	Physical coordinates
[in]	a_time	Time

Implements RtSpecies.

operator=() [1/2]

RteSpeciesJSON & Physics::CdrPlasma::RteSpeciesJSON::operator= ( const RteSpeciesJSON &&  a_other )

delete

Disallowed move assignment.

Parameters

[in]

a_other

Other species

operator=() [2/2]

RteSpeciesJSON & Physics::CdrPlasma::RteSpeciesJSON::operator= ( const RteSpeciesJSON &  a_other )

delete

Disallowed copy assignment.

Parameters

[in]

a_other

Other species

---

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

• Physics/CdrPlasma/PlasmaModels/CdrPlasmaJSON/CD_RteSpeciesJSON.H
• Physics/CdrPlasma/PlasmaModels/CdrPlasmaJSON/CD_RteSpeciesJSON.cpp