Physics::CdrPlasma::CdrSpeciesJSON Class Reference

Encapsulation of species settings and initial conditions for CDR species in CdrPlasma. More...

#include <CD_CdrSpeciesJSON.H>

Inheritance diagram for Physics::CdrPlasma::CdrSpeciesJSON:

Collaboration diagram for Physics::CdrPlasma::CdrSpeciesJSON:

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

Public Member Functions
	CdrSpeciesJSON ()=default
	Default constructor. Must subsequently call define.
	CdrSpeciesJSON (const std::string &a_name, const int a_Z, const bool a_diffusive, const bool a_mobile, const InitFunction &a_initialData)
	Full constructor. Calls the define function.
	CdrSpeciesJSON (const CdrSpeciesJSON &a_other)=delete
	Disallowed constructor.
	CdrSpeciesJSON (const CdrSpeciesJSON &&a_other)=delete
	Disallowed move constructor.
CdrSpeciesJSON &	operator= (const CdrSpeciesJSON &a_other)=delete
	Disallowed copy assignment.
CdrSpeciesJSON &	operator= (const CdrSpeciesJSON &&a_other)=delete
	Disallowed move assignment.
virtual	~CdrSpeciesJSON ()
	Destructor.
void	define (const std::string &a_name, const int a_Z, const bool a_diffusive, const bool a_mobile, const InitFunction &a_initialData)
	Define function.
Real	initialData (const RealVect &a_pos, const Real a_time) const override final
	Initial data function.
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
bool	m_isDefined
	Make sure model has initial data.
InitFunction	m_initFunction
	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

Encapsulation of species settings and initial conditions for CDR species in CdrPlasma.

Constructor & Destructor Documentation

CdrSpeciesJSON() [1/3]

CdrSpeciesJSON::CdrSpeciesJSON	(	const std::string &	a_name,
		const int	a_Z,
		const bool	a_diffusive,
		const bool	a_mobile,
		const InitFunction &	a_initialData
	)

Full constructor. Calls the define function.

Parameters

[in]	a_name	Species name
[in]	a_Z	Charge number
[in]	a_mobile	Mobile species or not
[in]	a_diffusive	Diffusive species or not
[in]	a_initialData	Initial data function

CdrSpeciesJSON() [2/3]

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

delete

Disallowed constructor.

Parameters

[in]

a_other

Other species

CdrSpeciesJSON() [3/3]

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

delete

Disallowed move constructor.

Parameters

[in]

a_other

Other species

Member Function Documentation

define()

void CdrSpeciesJSON::define	(	const std::string &	a_name,
		const int	a_Z,
		const bool	a_diffusive,
		const bool	a_mobile,
		const InitFunction &	a_initialData
	)

Define function.

Parameters

[in]	a_name	Species name
[in]	a_Z	Charge number
[in]	a_mobile	Mobile species or not
[in]	a_diffusive	Diffusive species or not
[in]	a_initialData	Initial data function

initialData()

Real CdrSpeciesJSON::initialData ( const RealVect &  a_pos, const Real  a_time  ) const

finaloverridevirtual

Initial data function.

Parameters

[in]	a_pos	Physical coordinates
[in]	a_time	Time

Returns

Return value

Implements CdrSpecies.

operator=() [1/2]

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

delete

Disallowed move assignment.

Parameters

[in]

a_other

Other species

operator=() [2/2]

CdrSpeciesJSON & Physics::CdrPlasma::CdrSpeciesJSON::operator= ( const CdrSpeciesJSON &  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_CdrSpeciesJSON.H
• Physics/CdrPlasma/PlasmaModels/CdrPlasmaJSON/CD_CdrSpeciesJSON.cpp