Trajectory Class Reference

Diagnostic to write out the trajectory of a single particle of a Species. More...

#include <diagnostic.h>

Inheritance diagram for Trajectory:

List of all members.

Public Member Functions
	Trajectory ()
	Default constructor.
virtual	~Trajectory ()
	Destructor.
virtual void	Init ()
	Gets the species pointer from the pParent member of the Task.
virtual bool	Execute ()
	Write out the particles position. The particles position is transferred to a vector of double and then sent to the port.
Public Member Functions inherited from Diagnostic
	Diagnostic ()
	Default constructor.
virtual	~Diagnostic ()
	Destructor.
virtual std::string	GetClassName () const
	Returns the name of the class, here "Diagnostic".
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)
	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 Attributes
Species *	pS
	A pointer to the species this Task belongs to.
int	ParticleNo
	The particle number.
Protected Attributes inherited from Diagnostic
Simulation *	Sim
	A pointer to the overall simulation object.
DiagPort *	DP
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

Diagnostic to write out the trajectory of a single particle of a Species.

Parameters:

particle

The number of the particle to be diagnosed.

Todo:

This doesn't work properly when particles are created and destroyed.

---

Member Function Documentation

void Trajectory::Init ( )

virtual

Gets the species pointer from the pParent member of the Task.

Todo:

Safe typecast.

Reimplemented from Diagnostic.

---

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

• diagnostic.h
• diagnostic.cpp