VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
vtkPStreamTracer Class Reference

Abstract superclass for parallel streamline generators. More...

#include <vtkPStreamTracer.h>

Inheritance diagram for vtkPStreamTracer:
[legend]
Collaboration diagram for vtkPStreamTracer:
[legend]

Public Types

typedef vtkStreamTracer Superclass
- Public Types inherited from vtkStreamTracer
enum  Units { LENGTH_UNIT = 1, CELL_LENGTH_UNIT = 2 }
enum  Solvers {
  RUNGE_KUTTA2, RUNGE_KUTTA4, RUNGE_KUTTA45, NONE,
  UNKNOWN
}
enum  ReasonForTermination {
  OUT_OF_DOMAIN = vtkInitialValueProblemSolver::OUT_OF_DOMAIN, NOT_INITIALIZED = vtkInitialValueProblemSolver::NOT_INITIALIZED, UNEXPECTED_VALUE = vtkInitialValueProblemSolver::UNEXPECTED_VALUE, OUT_OF_LENGTH = 4,
  OUT_OF_STEPS = 5, STAGNATION = 6
}
enum  { FORWARD, BACKWARD, BOTH }
enum  { INTERPOLATOR_WITH_DATASET_POINT_LOCATOR, INTERPOLATOR_WITH_CELL_LOCATOR }
typedef vtkPolyDataAlgorithm Superclass
- Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm Superclass
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetController (vtkMultiProcessController *controller)
virtual vtkMultiProcessControllerGetController ()
- Public Member Functions inherited from vtkStreamTracer
void SetSourceConnection (vtkAlgorithmOutput *algOutput)
void SetInterpolatorTypeToDataSetPointLocator ()
void SetInterpolatorTypeToCellLocator ()
void SetInterpolatorPrototype (vtkAbstractInterpolatedVelocityField *ivf)
void SetInterpolatorType (int interpType)
virtual void SetStartPosition (double, double, double)
virtual void SetStartPosition (double[3])
virtual double * GetStartPosition ()
virtual void GetStartPosition (double &, double &, double &)
virtual void GetStartPosition (double[3])
void SetSource (vtkDataSet *source)
vtkDataSetGetSource ()
void SetIntegrator (vtkInitialValueProblemSolver *)
virtual
vtkInitialValueProblemSolver
GetIntegrator ()
void SetIntegratorType (int type)
int GetIntegratorType ()
void SetIntegratorTypeToRungeKutta2 ()
void SetIntegratorTypeToRungeKutta4 ()
void SetIntegratorTypeToRungeKutta45 ()
virtual void SetMaximumPropagation (double)
virtual double GetMaximumPropagation ()
void SetIntegrationStepUnit (int unit)
int GetIntegrationStepUnit ()
virtual void SetInitialIntegrationStep (double)
virtual double GetInitialIntegrationStep ()
virtual void SetMinimumIntegrationStep (double)
virtual double GetMinimumIntegrationStep ()
virtual void SetMaximumIntegrationStep (double)
virtual double GetMaximumIntegrationStep ()
virtual void SetMaximumError (double)
virtual double GetMaximumError ()
virtual void SetMaximumNumberOfSteps (vtkIdType)
virtual vtkIdType GetMaximumNumberOfSteps ()
virtual void SetTerminalSpeed (double)
virtual double GetTerminalSpeed ()
virtual void SetIntegrationDirection (int)
virtual int GetIntegrationDirection ()
void SetIntegrationDirectionToForward ()
void SetIntegrationDirectionToBackward ()
void SetIntegrationDirectionToBoth ()
virtual void SetComputeVorticity (bool)
virtual bool GetComputeVorticity ()
virtual void SetRotationScale (double)
virtual double GetRotationScale ()
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkDataObjectGetInput ()
vtkDataObjectGetInput (int port)
vtkPolyDataGetPolyDataInput (int port)
vtkPolyDataGetOutput ()
vtkPolyDataGetOutput (int)
virtual void SetOutput (vtkDataObject *d)
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void SetInput (vtkDataObject *)
void SetInput (int, vtkDataObject *)
void AddInput (int, vtkDataObject *)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void SetAbortExecute (int)
virtual int GetAbortExecute ()
virtual void AbortExecuteOn ()
virtual void AbortExecuteOff ()
virtual void SetProgress (double)
virtual double GetProgress ()
void SetProgressText (const char *ptext)
virtual char * GetProgressText ()
virtual unsigned long GetErrorCode ()
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObjectGetInputDataObject (int port, int connection)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkPStreamTracerSafeDownCast (vtkObject *o)
- Static Public Member Functions inherited from vtkStreamTracer
static vtkStreamTracerNew ()

Protected Types

typedef vtkstd::vector
< vtkSmartPointer< vtkPolyData > > 
TmpOutputsType

Protected Member Functions

 vtkPStreamTracer ()
 ~vtkPStreamTracer ()
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void SetInterpolator (vtkAbstractInterpolatedVelocityField *)
void SendCellPoint (vtkPolyData *data, vtkIdType streamId, vtkIdType idx, int sendToId)
void ReceiveCellPoint (vtkPolyData *tomod, int streamId, vtkIdType idx)
void SendFirstPoints (vtkPolyData *output)
void ReceiveLastPoints (vtkPolyData *output)
void MoveToNextSend (vtkPolyData *output)
virtual void ParallelIntegrate ()=0
- Protected Member Functions inherited from vtkStreamTracer
 vtkStreamTracer ()
 ~vtkStreamTracer ()
virtual vtkExecutiveCreateDefaultExecutive ()
void AddInput (vtkDataObject *)
virtual int FillInputPortInformation (int, vtkInformation *)
void CalculateVorticity (vtkGenericCell *cell, double pcoords[3], vtkDoubleArray *cellVectors, double vorticity[3])
void Integrate (vtkDataSet *input, vtkPolyData *output, vtkDataArray *seedSource, vtkIdList *seedIds, vtkIntArray *integrationDirections, double lastPoint[3], vtkAbstractInterpolatedVelocityField *func, int maxCellSize, const char *vecFieldName, double &propagation, vtkIdType &numSteps)
void SimpleIntegrate (double seed[3], double lastPoint[3], double stepSize, vtkAbstractInterpolatedVelocityField *func)
int CheckInputs (vtkAbstractInterpolatedVelocityField *&func, int *maxCellSize)
void GenerateNormals (vtkPolyData *output, double *firstNormal, const char *vecName)
void ConvertIntervals (double &step, double &minStep, double &maxStep, int direction, double cellLength)
int SetupOutput (vtkInformation *inInfo, vtkInformation *outInfo)
void InitializeSeeds (vtkDataArray *&seeds, vtkIdList *&seedIds, vtkIntArray *&integrationDirections, vtkDataSet *source)
- Protected Member Functions inherited from vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm ()
 ~vtkPolyDataAlgorithm ()
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual void ExecuteData (vtkDataObject *output)
virtual void Execute ()
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual void SetNumberOfInputPorts (int n)
virtual void SetNumberOfOutputPorts (int n)
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual void ReportReferences (vtkGarbageCollector *)
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetErrorCode (unsigned long)
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkMultiProcessControllerController
vtkAbstractInterpolatedVelocityFieldInterpolator
vtkDataArraySeeds
vtkIdListSeedIds
vtkIntArrayIntegrationDirections
int EmptyData
TmpOutputsType TmpOutputs
- Protected Attributes inherited from vtkStreamTracer
bool GenerateNormalsInIntegrate
double StartPosition [3]
double TerminalSpeed
double LastUsedStepSize
double MaximumPropagation
double MinimumIntegrationStep
double MaximumIntegrationStep
double InitialIntegrationStep
int IntegrationStepUnit
int IntegrationDirection
vtkInitialValueProblemSolverIntegrator
double MaximumError
vtkIdType MaximumNumberOfSteps
bool ComputeVorticity
double RotationScale
vtkAbstractInterpolatedVelocityFieldInterpolatorPrototype
vtkCompositeDataSetInputData

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
- Static Protected Member Functions inherited from vtkStreamTracer
static double ConvertToLength (double interval, int unit, double cellLength)
static double ConvertToLength (IntervalInformation &interval, double cellLength)
- Static Protected Attributes inherited from vtkStreamTracer
static const double EPSILON
- Friends inherited from vtkObject

Detailed Description

Abstract superclass for parallel streamline generators.

This class implements some necessary functionality used by distributed and parallel streamline generators. Note that all processes must have access to the WHOLE seed source, i.e. the source must be identical on all processes.

See Also
vtkStreamTracer vtkDistributedStreamTracer vtkMPIStreamTracer

Definition at line 37 of file vtkPStreamTracer.h.

Member Typedef Documentation

Definition at line 40 of file vtkPStreamTracer.h.

typedef vtkstd::vector< vtkSmartPointer<vtkPolyData> > vtkPStreamTracer::TmpOutputsType
protected

Definition at line 84 of file vtkPStreamTracer.h.

Constructor & Destructor Documentation

vtkPStreamTracer::vtkPStreamTracer ( )
protected
vtkPStreamTracer::~vtkPStreamTracer ( )
protected

Member Function Documentation

virtual const char* vtkPStreamTracer::GetClassName ( )
virtual

Reimplemented from vtkStreamTracer.

Reimplemented in vtkDistributedStreamTracer.

static int vtkPStreamTracer::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 vtkStreamTracer.

Reimplemented in vtkDistributedStreamTracer.

virtual int vtkPStreamTracer::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 vtkStreamTracer.

Reimplemented in vtkDistributedStreamTracer.

static vtkPStreamTracer* vtkPStreamTracer::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkStreamTracer.

Reimplemented in vtkDistributedStreamTracer.

virtual void vtkPStreamTracer::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 vtkStreamTracer.

Reimplemented in vtkDistributedStreamTracer.

virtual void vtkPStreamTracer::SetController ( vtkMultiProcessController controller)
virtual

Set/Get the controller use in compositing (set to the global controller by default) If not using the default, this must be called before any other methods.

virtual vtkMultiProcessController* vtkPStreamTracer::GetController ( )
virtual

Set/Get the controller use in compositing (set to the global controller by default) If not using the default, this must be called before any other methods.

virtual int vtkPStreamTracer::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

This is called by the superclass. This is the method you should override.

Reimplemented from vtkStreamTracer.

virtual int vtkPStreamTracer::RequestInformation ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
protectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

virtual int vtkPStreamTracer::RequestUpdateExtent ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
protectedvirtual

This is called by the superclass. This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

void vtkPStreamTracer::SetInterpolator ( vtkAbstractInterpolatedVelocityField )
protected
void vtkPStreamTracer::SendCellPoint ( vtkPolyData data,
vtkIdType  streamId,
vtkIdType  idx,
int  sendToId 
)
protected
void vtkPStreamTracer::ReceiveCellPoint ( vtkPolyData tomod,
int  streamId,
vtkIdType  idx 
)
protected
void vtkPStreamTracer::SendFirstPoints ( vtkPolyData output)
protected
void vtkPStreamTracer::ReceiveLastPoints ( vtkPolyData output)
protected
void vtkPStreamTracer::MoveToNextSend ( vtkPolyData output)
protected
virtual void vtkPStreamTracer::ParallelIntegrate ( )
protectedpure virtual

Implemented in vtkDistributedStreamTracer.

Member Data Documentation

vtkMultiProcessController* vtkPStreamTracer::Controller
protected

Definition at line 60 of file vtkPStreamTracer.h.

vtkAbstractInterpolatedVelocityField* vtkPStreamTracer::Interpolator
protected

Definition at line 62 of file vtkPStreamTracer.h.

vtkDataArray* vtkPStreamTracer::Seeds
protected

Definition at line 77 of file vtkPStreamTracer.h.

vtkIdList* vtkPStreamTracer::SeedIds
protected

Definition at line 78 of file vtkPStreamTracer.h.

vtkIntArray* vtkPStreamTracer::IntegrationDirections
protected

Definition at line 79 of file vtkPStreamTracer.h.

int vtkPStreamTracer::EmptyData
protected

Definition at line 81 of file vtkPStreamTracer.h.

TmpOutputsType vtkPStreamTracer::TmpOutputs
protected

Definition at line 87 of file vtkPStreamTracer.h.


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