Advection and diffused species for AdvectionDiffusionStepper. More...

Inheritance diagram for Physics::AdvectionDiffusion::AdvectionDiffusionSpecies:

Collaboration diagram for Physics::AdvectionDiffusion::AdvectionDiffusionSpecies:

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

virtual	~AdvectionDiffusionSpecies ()
	Destructor.

Real	initialData (const RealVect a_pos, const Real a_time) const override
	Initial data.

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 List< PointParticle > &	getInitialParticles () const
	Get initial particles.

List< PointParticle > &	getInitialParticles ()
	Get initial particles.

Protected Attributes
std::function< Real(const RealVect &a_pos)>	m_initialData

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.

List< PointParticle >	m_initialParticles
	Initial particles.

Detailed Description

Advection and diffused species for AdvectionDiffusionStepper.

The initial conditions and mobility/diffusion settings are initialized upon construction.

Constructor & Destructor Documentation

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

inline

Constructor.

Parameters

Real Physics::AdvectionDiffusion::AdvectionDiffusionSpecies::initialData	(	const RealVect	a_pos,
		const Real	a_time
	)		const

inlineoverridevirtual

Initial data.

This returns a super-Gaussian blob.

Parameters

[in]	a_pos	Position.
[in]	a_time	Time

Implements CdrSpecies.

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