ES_EField Class Reference

Task that implements an electrostatic E-field. It consists of a grid with n-dimensional entries. The field is calculated by taking the derivative of the electrostatic potential. The electric field in the environment of the dust particle(s) is calculated with the same method as in the poisson-solver using reduced grid spacings to follow the spherical dust particle surface. More...

#include <efield.h>

Inheritance diagram for ES_EField:

List of all members.

Public Member Functions
	ES_EField ()
	Default constructor.
virtual	~ES_EField ()
	Destructor.
std::string	GetClassName () const
	Returns the name of the class, here "ES_EField".
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.
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.
virtual grid< Position > *	GetGrid ()
	Returns a pointer to the grid containing the field values.
virtual GridPosition	GetNx ()
	Returns the size of the grid.
void	Scale (double)
	Rescales all the field values with a constant.
Position	At (const Position &dRx) const
	Returns the field at an arbitrary position.
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
PARAMETERMAP *	MakeParamMap (PARAMETERMAP *pm=NULL)
	Register the parameters needed for the Task. A derived class should overwrite this whenever it needs additional parameters from the setup file. It should then ALWAYS call the MakeParamMap of its superclass.
Protected Member Functions inherited from Task
void	AddPredecessor (const std::string &strPred)
	Add the name of a predecessor that has to be executed before this Task.

Protected Attributes
Potential *	pPot
	Pointer to the potential.
grid< Position >	Field
	Contains the actual field values.
Geometry *	pGeom
	Pointer to the Geometry.
Wall *	pWall
	Pointer to the reference Wall.
GridPosition	NG
	Position of a grid point.
double	dx
	Grid spacing in x direction.
double	dy
	Grid spacing in y direction.
double	dz
	Grid spacing in z direction.
int	Rg
	Radius of dust particle.
int	nd
	Number of dust particle(s)
int	ig
	Number of grid points at the dust particle(s)
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

---

Detailed Description

Task that implements an electrostatic E-field. It consists of a grid with n-dimensional entries. The field is calculated by taking the derivative of the electrostatic potential. The electric field in the environment of the dust particle(s) is calculated with the same method as in the poisson-solver using reduced grid spacings to follow the spherical dust particle surface.

Parameters:

geometry	Reference to the geometry
potential	Name of the potential from which to calculate the field
diagnostic	Allows diagnostic output of the field grid
linediag	Allows diagnostic output of a single line of the field

See also:

DiagGridLine

---

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

• efield.h
• efield.cpp