Species which is advected/diffused in Brownian walker code. More...

Inheritance diagram for Physics::BrownianWalker::BrownianWalkerSpecies:

Collaboration diagram for Physics::BrownianWalker::BrownianWalkerSpecies:

Public Member Functions
	BrownianWalkerSpecies ()
	Constructor – reads in input parameters.

	~BrownianWalkerSpecies ()
	Destructor (does nothing)

Public Member Functions inherited from ItoSpecies
	ItoSpecies ()
	Default constructor, but user should set the name, charge/mobility/diffusivity etc.

	ItoSpecies (const std::string a_name, const int a_chargeNumber, const bool a_mobile, const bool a_diffusive)
	Full constructor.

virtual	~ItoSpecies ()
	Destructor (does nothing):

std::string	getName () const
	Return name.

int	getChargeNumber () const
	Return charge.

const std::function< Real(const RealVect &x, const Real &t)> &	getInitialDensity () const
	Return the initial density.

bool	isDiffusive () const
	Return diffusive or not.

bool	isMobile () const
	Mobile ItoSpecies or not.

virtual Real	mobility (const Real a_energy) const
	Compute the mobility as a function of energy.

virtual Real	diffusion (const Real a_energy) const
	Compute the diffusion coefficient.

virtual void	setInitialDensity (const std::function< Real(const RealVect &x, const Real &t)> &a_initialDensity)
	Set the initial species density.

List< ItoParticle > &	getInitialParticles ()
	Get initial particles – this is called by ItoSolver when filling the solver with initial particles.

const List< ItoParticle > &	getInitialParticles () const
	Get initial particles – this is called by ItoSolver when filling the solver with initial particles.

Protected Attributes
int	m_numParticles
	Number of initial particles.

Real	m_blobRadius
	Radius for the initial Gaussian distribution of particles.

RealVect	m_blobCenter
	Center-point for the Gaussian particle distribution.

Protected Attributes inherited from ItoSpecies
std::string	m_name
	Ito_Species name.

int	m_chargeNumber
	Charge.

int	m_maxInitialParticlesPerCell
	Maximum number of initial numerical particles per cell.

bool	m_isDiffusive
	Diffusive ItoSpecies or not.

bool	m_isMobile
	Mobile ItoSpecies or not.

List< ItoParticle >	m_initialParticles
	Initial particles.

std::function< Real(const RealVect &x, const Real &t)>	m_initialDensity
	Initial density, in case the user wants to generate particles from a density distribution.

Detailed Description

Species which is advected/diffused in Brownian walker code.

The initial particles are drawn from a Gaussian distribution. The user specifies how many, and the parameters for the distribution.

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

Public Member Functions