DustPotential Class Reference

Class for the potential in simulations with dust particle(s). More...

#include <potential.h>

Inheritance diagram for DustPotential:

List of all members.

Public Member Functions
	DustPotential ()
	Default constructor.
virtual	~DustPotential ()
	Destructor has to clear allocated memory.
virtual void	Init ()
	The Init method of a Task is called before the Task is executed. It should contain all the necessary initialization. The basic Init method calls the Init of all the sub-Tasks and sorts them according to their predecessor list. Also the Pointer to the Normalization object is retrieved from the Process. A derived class should always call the Task::Init in its own Init method.
virtual bool	Execute ()
	Executes the Task. This is the place where the algorithm for executing a Task it placed. The return value specifies, if the task is finished and can be removed. The basic Execute method executes all its sub-Tasks. The derived classes should call this member function, whenever there are subtasks to be executed.
Public Member Functions inherited from Potential
	Potential ()
	Default constructor.
virtual	~Potential ()
	Destructor.
virtual std::string	GetClassName () const
	Returns the name of the class, here "potential".
virtual grid< double > *	GetGrid ()
	Retruns a pointer to the Pot grid containing the potential.
virtual Position	GetSpaceQuant () const
	Returns the grid spacing.
virtual double &	operator[] (GridPosition i)
	Retruns the potential at a grid point.
virtual GridPosition	GetNx () const
	Returns the grid size.
Public Member Functions inherited from Task
	Task ()
	Default constructor sets the running number nNr of the Task.
virtual	~Task ()
	When destructing a Task is has to be detatched from the parents Task list.
int	GetStep () const
	Return the interval between execution in timesteps.
int	GetEnd () const
	Return the timestep when the Task ends execution.
bool	DoNow ()
	Returns true if the Task is to be executed now.
std::string	GetName () const
	Returns the name given to the Task object.
virtual bool	IsInteractive () const
	If not specified otherwise, a Task is not interactive.
void	AttachTask (Task *pTask)
	Insert Task into Task list and registers it with the Process.
void	DetachTask (Task *pTask)
	DetachTask from Task list.
virtual std::string	Rebuild (std::istream &in)
	Rebuilds the task from the setup. This normally does not need to be overwritten. Rebuild always returns the next token that does not belong to the object setup.
virtual void	DumpTaskList (std::ostream &o, int nDepth=0)
	Recursively dumps the complete Task list into a stream.

Protected Member Functions
virtual PARAMETERMAP *	MakeParamMap (PARAMETERMAP *pm=NULL)
	Serialization.

Protected Attributes
std::valarray< double >	Nd_u
	Lower side diagonal of the Jakobian.
std::valarray< double >	Nd_o
	Upper side diagonal of the Jakobian.
std::valarray< double >	Hd
	Diagonal of the Jakobian.
std::valarray< double >	ni
	Normalized density.
Density *	pRho
	The charge density from which to calculate the potential.
Wall *	pWall
	Pointer to the reference Wall.
double	n0
	Additional density.
Protected Attributes inherited from Potential
int	tstep
	Time step size for output of surface potential of the dust particle.
GridPosition	NG
	Size of the grid.
double	dx
	Grid spacing in x direction.
double	Rd
	The radius of the dust particle(s)
double	cd
	Charge of the dust particle(s)
grid< double >	Pot
	The grid containing the potential values.
Geometry *	pGeom
	Pointer to the Geometry.
Protected Attributes inherited from Task
int	nNr
	The running number of this Task.
std::string	strName
	The name of this Task.
Task *	pParent
	The parent Task to which this Task belongs.
Process *	pProcess
	The Process to which this Task belongs.
std::string	strNorm
	The name of the referenced Normalization object.
Normalization *	Norm
	The pointer to the referenced Normalization object.
TASKLIST	plTasks
	A list of sub-Tasks.
int	nStart
int	nEnd
int	nStep

Additional Inherited Members
Public Attributes inherited from Potential
double	potd [20]
	Surface potential of the dust particle(s), maximum possible number of dust particles: 20.

---

Detailed Description

Class for the potential in simulations with dust particle(s).

Parameters:

geometry	Name of the reference Geometry
density	The charge density from which to calculate the potential
n0	Additional density (be careful with this parameter!!!)
diagnostic	Allows the output of the potantial grid
Outstep	Time step size for output of the surface potential of the dust particle, if no value is given, t=10 is set

---

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

• potential.h
• potential.cpp