DiagGrid< TYPE > Class Template Reference

Template Diagnostic to write out a grid of any type. The TYPE has to be cast-able to double. More...

#include <diagnostic.h>

Inheritance diagram for DiagGrid< TYPE >:

List of all members.

Public Member Functions
	DiagGrid (grid< TYPE > *apG)
	Construct with a pointer to the grid.
virtual	~DiagGrid ()
	Destructor.
virtual void	Init ()
	Initializes parameters and the temporary grid.
virtual bool	Execute ()
	Sends the grid to the DiagPort using one of the Out(grid<T>) methods.
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
int	LastOne
	Remembers when the last diagnostic was written.
int	Mean
	Allows taking the average over a number of time steps.
int	F
double	Scale
	Scaling factor.
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

template<class TYPE>
class DiagGrid< TYPE >

Template Diagnostic to write out a grid of any type. The TYPE has to be cast-able to double.

Parameters:

mean	The number of time steps over which to average
scale	The values on the grid can be rescaled

Todo:

(For next version) Allow a displacement velocity (mainly for calculating the average)

---

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

• diagnostic.h