Generation Class Reference

An abstract Task class for the initial generation of particles. More...

#include <generation.h>

Inheritance diagram for Generation:

List of all members.

Public Member Functions
	Generation ()
	Default constructor.
virtual	~Generation ()
	Destructor.
std::string	GetClassName () const
	Returns the name of the class, here "generation".
void	Init ()
	Initializes the pointers to the geometry and the species.
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 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 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
Species *	pS
	Pointer to the Species to be generated.
Geometry *	pGeom
	Pointer to the Geometry.
GridPosition	NG
	Size of the grid.
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

An abstract Task class for the initial generation of particles.

Parameters:

geometry

Name of the referenced Geometry

Todo:

(For next version) The Generation objects should somehow carry infomation about the density and the number of particles to be created. The superparticle size should be calculated from that.

---

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

• generation.h
• generation.cpp