CdrSpecies subclass for use with DischargeInceptionStepper. More...

#include <CD_DischargeInceptionSpecies.H>

Inheritance diagram for Physics::DischargeInception::DischargeInceptionSpecies:

Collaboration diagram for Physics::DischargeInception::DischargeInceptionSpecies:

[legend]

Public Member Functions
	DischargeInceptionSpecies (const std::function< Real(const RealVect &a_pos)> &a_initialData, const bool a_mobile, const bool a_diffusive)
	Full constructor.

virtual	~DischargeInceptionSpecies ()
	Destructor.

Real	initialData (const RealVect &a_pos, const Real a_time) const override
	Return the initial species density at the given position.

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
std::function< Real(const RealVect &a_pos)>	m_initialData
	Callable that maps a position to the initial species density.

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

CdrSpecies subclass for use with DischargeInceptionStepper.

Represents a charged or neutral species whose initial density, mobility, and diffusivity are all set at construction time via function and flag arguments. The initial density is provided as a callable that maps a position to a density value.

Constructor & Destructor Documentation

◆ DischargeInceptionSpecies()

Physics::DischargeInception::DischargeInceptionSpecies::DischargeInceptionSpecies	(	const std::function< Real(const RealVect &a_pos)> &	a_initialData,
		const bool	a_mobile,
		const bool	a_diffusive
	)

inline

Full constructor.

Parameters

[in]	a_initialData	Callable returning the initial density at a given position.
[in]	a_mobile	True if the species has a non-zero drift velocity.
[in]	a_diffusive	True if the species has a non-zero diffusion coefficient.

Member Function Documentation

◆ initialData()

Real Physics::DischargeInception::DischargeInceptionSpecies::initialData	(	const RealVect &	a_pos,
		const Real	a_time
	)		const

inlineoverridevirtual

Return the initial species density at the given position.

Parameters

[in]	a_pos	Physical position.
[in]	a_time	Current time (not used; initial data is time-independent).

Returns: Initial density value from the stored function.

Implements CdrSpecies.

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

Physics/DischargeInception/CD_DischargeInceptionSpecies.H

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DischargeInceptionSpecies()

Member Function Documentation

◆ initialData()