vtkStreamer Class Reference

#include <vtkStreamer.h>

Inheritance diagram for vtkStreamer:

[legend]

Collaboration diagram for vtkStreamer:

[legend]

List of all members.

Detailed Description

abstract object implements integration of massless particle through vector field

vtkStreamer is a filter that integrates a massless particle through a vector field. The integration is performed using second order Runge-Kutta method. vtkStreamer often serves as a base class for other classes that perform numerical integration through a vector field (e.g., vtkStreamLine).

Note that vtkStreamer can integrate both forward and backward in time, or in both directions. The length of the streamer is controlled by specifying an elapsed time. (The elapsed time is the time each particle travels.) Otherwise, the integration terminates after exiting the dataset or if the particle speed is reduced to a value less than the terminal speed.

vtkStreamer integrates through any type of dataset. As a result, if the dataset contains 2D cells such as polygons or triangles, the integration is constrained to lie on the surface defined by the 2D cells.

The starting point of streamers may be defined in three different ways. Starting from global x-y-z "position" allows you to start a single streamer at a specified x-y-z coordinate. Starting from "location" allows you to start at a specified cell, subId, and parametric coordinate. Finally, you may specify a source object to start multiple streamers. If you start streamers using a source object, for each point in the source that is inside the dataset a streamer is created.

vtkStreamer implements the integration process in the Integrate() method. Because vtkStreamer does not implement the Execute() method that its superclass (i.e., Filter) requires, it is an abstract class. Its subclasses implement the execute method and use the Integrate() method, and then build their own representation of the integration path (i.e., lines, dashed lines, points, etc.).

See also:: vtkStreamLine vtkDashedStreamLine vtkStreamPoints

Definition at line 64 of file vtkStreamer.h.


Public Types
typedef vtkPolyDataAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetStartLocation (vtkIdType cellId, int subId, double pcoords[3])
vtkIdType	GetStartLocation (int &subId, double pcoords[3])
void	SetStartPosition (double x[3])
void	SetStartPosition (double x, double y, double z)
double *	GetStartPosition ()
virtual void	SetNumberOfThreads (int)
virtual int	GetNumberOfThreads ()
virtual void	SetSavePointInterval (double)
virtual double	GetSavePointInterval ()

void	SetStartLocation (vtkIdType cellId, int subId, double r, double s, double t)

void	SetSource (vtkDataSet *source)
vtkDataSet *	GetSource ()

virtual void	SetMaximumPropagationTime (double)
virtual double	GetMaximumPropagationTime ()

virtual void	SetIntegrationDirection (int)
virtual int	GetIntegrationDirection ()
void	SetIntegrationDirectionToForward ()
void	SetIntegrationDirectionToBackward ()
void	SetIntegrationDirectionToIntegrateBothDirections ()
const char *	GetIntegrationDirectionAsString ()

virtual void	SetIntegrationStepLength (double)
virtual double	GetIntegrationStepLength ()

virtual void	SetSpeedScalars (int)
virtual int	GetSpeedScalars ()
virtual void	SpeedScalarsOn ()
virtual void	SpeedScalarsOff ()

virtual void	SetOrientationScalars (int)
virtual int	GetOrientationScalars ()
virtual void	OrientationScalarsOn ()
virtual void	OrientationScalarsOff ()

virtual void	SetTerminalSpeed (double)
virtual double	GetTerminalSpeed ()

virtual void	SetVorticity (int)
virtual int	GetVorticity ()
virtual void	VorticityOn ()
virtual void	VorticityOff ()

void	SetIntegrator (vtkInitialValueProblemSolver *)
virtual vtkInitialValueProblemSolver *	GetIntegrator ()

virtual void	SetEpsilon (double)
virtual double	GetEpsilon ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkStreamer *	SafeDownCast (vtkObject *o)
Protected Member Functions
void	Integrate (vtkDataSet input, vtkDataSet source)
void	InitializeThreadedIntegrate ()
virtual int	FillInputPortInformation (int port, vtkInformation *info)

	vtkStreamer ()
	~vtkStreamer ()

virtual vtkIdType	GetNumberOfStreamers ()
StreamArray *	GetStreamers ()
Static Protected Member Functions
static VTK_THREAD_RETURN_TYPE	ThreadedIntegrate (void *arg)
Protected Attributes
int	StartFrom
vtkIdType	StartCell
int	StartSubId
double	StartPCoords [3]
double	StartPosition [3]
StreamArray *	Streamers
vtkIdType	NumberOfStreamers
double	MaximumPropagationTime
int	IntegrationDirection
double	IntegrationStepLength
int	Vorticity
double	TerminalSpeed
int	SpeedScalars
int	OrientationScalars
vtkInitialValueProblemSolver *	Integrator
double	Epsilon
double	SavePointInterval
vtkMultiThreader *	Threader
int	NumberOfThreads
Friends
class	StreamArray
Classes
class	StreamArray
class	StreamPoint

Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkStreamer::Superclass

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkDashedStreamLine, vtkStreamLine, and vtkStreamPoints.

Definition at line 67 of file vtkStreamer.h.

Constructor & Destructor Documentation

vtkStreamer::vtkStreamer ( ) [protected]

Construct object to start from position (0,0,0); integrate forward; terminal speed 0.0; vorticity computation off; integrations step length 0.2; and maximum propagation time 100.0.

vtkStreamer::~vtkStreamer ( ) [protected]

Construct object to start from position (0,0,0); integrate forward; terminal speed 0.0; vorticity computation off; integrations step length 0.2; and maximum propagation time 100.0.

Member Function Documentation

virtual const char* vtkStreamer::GetClassName ( ) [virtual]

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkDashedStreamLine, vtkStreamLine, and vtkStreamPoints.

static int vtkStreamer::IsTypeOf ( const char * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkDashedStreamLine, vtkStreamLine, and vtkStreamPoints.

virtual int vtkStreamer::IsA ( const char * name ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkDashedStreamLine, vtkStreamLine, and vtkStreamPoints.

static vtkStreamer* vtkStreamer::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkDashedStreamLine, vtkStreamLine, and vtkStreamPoints.

void vtkStreamer::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkDashedStreamLine, vtkStreamLine, and vtkStreamPoints.

void vtkStreamer::SetStartLocation	(	vtkIdType	cellId,
		int	subId,
		double	pcoords[3]
	)

Specify the start of the streamline in the cell coordinate system. That is, cellId and subId (if composite cell), and parametric coordinates.

void vtkStreamer::SetStartLocation	(	vtkIdType	cellId,
		int	subId,
		double	r,
		double	s,
		double	t
	)

Specify the start of the streamline in the cell coordinate system. That is, cellId and subId (if composite cell), and parametric coordinates.

vtkIdType vtkStreamer::GetStartLocation	(	int &	subId,
		double	pcoords[3]
	)

Get the starting location of the streamline in the cell coordinate system.

void vtkStreamer::SetStartPosition ( double x[3] )

Specify the start of the streamline in the global coordinate system. Search must be performed to find initial cell to start integration from.

void vtkStreamer::SetStartPosition	(	double	x,
		double	y,
		double	z
	)

Specify the start of the streamline in the global coordinate system. Search must be performed to find initial cell to start integration from.

double* vtkStreamer::GetStartPosition ( )

Get the start position in global x-y-z coordinates.

void vtkStreamer::SetSource ( vtkDataSet * source )

Specify the source object used to generate starting points.

vtkDataSet* vtkStreamer::GetSource ( )

Specify the source object used to generate starting points.

virtual void vtkStreamer::SetMaximumPropagationTime ( double ) [virtual]

Specify the maximum length of the Streamer expressed in elapsed time.

virtual double vtkStreamer::GetMaximumPropagationTime ( ) [virtual]

Specify the maximum length of the Streamer expressed in elapsed time.

virtual void vtkStreamer::SetIntegrationDirection ( int ) [virtual]