Physics::CdrPlasma::NeutralSpeciesJSON Class Reference

Encapsulation of species settings and initial conditiosn for use with CdrPlasma. This is for tracked species. More...

#include <CD_NeutralSpeciesJSON.H>

Public Types
using	NumberDensityFunction = std::function< Real(const RealVect a_pos)>
	Alias for initial data function.

Public Member Functions
	NeutralSpeciesJSON ()
	Default constructor. Must subsequently call define.
	NeutralSpeciesJSON (const std::string &a_name, const Real a_molarFraction, const NumberDensityFunction &a_function)
	Full constructor. Calls the define function.
virtual	~NeutralSpeciesJSON ()
	Destructor.
void	define (const std::string &a_name, const Real a_molarFraction, const NumberDensityFunction &a_function)
	Full constructor. Calls the define function.
Real	operator() (const RealVect &a_pos) const
	Get (number) density at the physical coordinates.
Real	getMolarFraction () const
	Get the molar fraction.
std::string	getName () const
	Get the species name.

Protected Attributes
bool	m_isDefined
	Make sure model has initial data.
std::string	m_name
	Neutral species name.
Real	m_molarFraction
	Molar fraction.
NumberDensityFunction	m_function
	Initial data function. Set by CdrPlasmaGenericModel.

Detailed Description

Encapsulation of species settings and initial conditiosn for use with CdrPlasma. This is for tracked species.

Constructor & Destructor Documentation

NeutralSpeciesJSON()

NeutralSpeciesJSON::NeutralSpeciesJSON	(	const std::string &	a_name,
		const Real	a_molarFraction,
		const NumberDensityFunction &	a_function
	)

Full constructor. Calls the define function.

Parameters

[in]	a_name	Species name
[in]	a_molarFraction	Molar fraction
[in]	a_function	Number density function

Member Function Documentation

define()

void NeutralSpeciesJSON::define	(	const std::string &	a_name,
		const Real	a_molarFraction,
		const NumberDensityFunction &	a_function
	)

Full constructor. Calls the define function.

Parameters

[in]	a_name	Species name
[in]	a_molarFraction	Molar fraction
[in]	a_function	Number density function

getMolarFraction()

Real NeutralSpeciesJSON::getMolarFraction

(

)

const

Get the molar fraction.

Returns

m_molarFraction

getName()

std::string NeutralSpeciesJSON::getName

(

)

const

Get the species name.

Returns

m_name

operator()()

Real NeutralSpeciesJSON::operator()

(

const RealVect &

a_pos

)

const

Get (number) density at the physical coordinates.

Parameters

[in]

a_pos

Physical position

Returns

Return value

---

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

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