VTK
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | Friends | List of all members
vtkStreamTracer Class Reference

Streamline generator. More...

#include <vtkStreamTracer.h>

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

Classes

struct  IntervalInformation
 

Public Types

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, FIXED_REASONS_FOR_TERMINATION_COUNT
}
 
enum  { FORWARD, BACKWARD, BOTH }
 
enum  { INTERPOLATOR_WITH_DATASET_POINT_LOCATOR, INTERPOLATOR_WITH_CELL_LOCATOR }
 
typedef vtkPolyDataAlgorithm Superclass
 
typedef bool(* CustomTerminationCallbackType) (void *clientdata, vtkPoints *points, vtkDataArray *velocity, int integrationDirection)
 Asks the user if the current streamline should be terminated. More...
 
- Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkStreamTracerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetStartPosition (double, double, double)
 Specify the starting point (seed) of a streamline in the global coordinate system. More...
 
virtual void SetStartPosition (double[3])
 
virtual double * GetStartPosition ()
 
virtual void GetStartPosition (double &, double &, double &)
 
virtual void GetStartPosition (double[3])
 
void SetSourceData (vtkDataSet *source)
 Specify the source object used to generate starting points (seeds). More...
 
vtkDataSetGetSource ()
 
void SetSourceConnection (vtkAlgorithmOutput *algOutput)
 Specify the source object used to generate starting points (seeds). More...
 
void SetIntegrator (vtkInitialValueProblemSolver *)
 Set/get the integrator type to be used for streamline generation. More...
 
virtual vtkInitialValueProblemSolverGetIntegrator ()
 
void SetIntegratorType (int type)
 
int GetIntegratorType ()
 
void SetIntegratorTypeToRungeKutta2 ()
 
void SetIntegratorTypeToRungeKutta4 ()
 
void SetIntegratorTypeToRungeKutta45 ()
 
void SetInterpolatorTypeToDataSetPointLocator ()
 Set the velocity field interpolator type to the one involving a dataset point locator. More...
 
void SetInterpolatorTypeToCellLocator ()
 Set the velocity field interpolator type to the one involving a cell locator. More...
 
virtual void SetMaximumPropagation (double)
 Specify the maximum length of a streamline expressed in LENGTH_UNIT. More...
 
virtual double GetMaximumPropagation ()
 
void SetIntegrationStepUnit (int unit)
 Specify a uniform integration step unit for MinimumIntegrationStep, InitialIntegrationStep, and MaximumIntegrationStep. More...
 
int GetIntegrationStepUnit ()
 
virtual void SetInitialIntegrationStep (double)
 Specify the Initial step size used for line integration, expressed in: LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 (either the starting size for an adaptive integrator, e.g., RK45, or the constant / fixed size for non-adaptive ones, i.e., RK2 and RK4) More...
 
virtual double GetInitialIntegrationStep ()
 
virtual void SetMinimumIntegrationStep (double)
 Specify the Minimum step size used for line integration, expressed in: LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 (Only valid for an adaptive integrator, e.g., RK45) More...
 
virtual double GetMinimumIntegrationStep ()
 
virtual void SetMaximumIntegrationStep (double)
 Specify the Maximum step size used for line integration, expressed in: LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 (Only valid for an adaptive integrator, e.g., RK45) More...
 
virtual double GetMaximumIntegrationStep ()
 
virtual void SetMaximumError (double)
 Specify the maximum error tolerated throughout streamline integration. More...
 
virtual double GetMaximumError ()
 
virtual void SetMaximumNumberOfSteps (vtkIdType)
 Specify the maximum number of steps for integrating a streamline. More...
 
virtual vtkIdType GetMaximumNumberOfSteps ()
 
virtual void SetTerminalSpeed (double)
 Specify the terminal speed value, below which integration is terminated. More...
 
virtual double GetTerminalSpeed ()
 
virtual bool GetSurfaceStreamlines ()
 Set/Unset the streamlines to be computed on a surface. More...
 
virtual void SetSurfaceStreamlines (bool)
 
virtual void SurfaceStreamlinesOn ()
 
virtual void SurfaceStreamlinesOff ()
 
virtual void SetIntegrationDirection (int)
 Specify whether the streamline is integrated in the upstream or downstream direction. More...
 
virtual int GetIntegrationDirection ()
 
void SetIntegrationDirectionToForward ()
 
void SetIntegrationDirectionToBackward ()
 
void SetIntegrationDirectionToBoth ()
 
virtual void SetComputeVorticity (bool)
 Turn on/off vorticity computation at streamline points (necessary for generating proper stream-ribbons using the vtkRibbonFilter. More...
 
virtual bool GetComputeVorticity ()
 
virtual void SetRotationScale (double)
 This can be used to scale the rate with which the streamribbons twist. More...
 
virtual double GetRotationScale ()
 
void SetInterpolatorPrototype (vtkAbstractInterpolatedVelocityField *ivf)
 The object used to interpolate the velocity field during integration is of the same class as this prototype. More...
 
void SetInterpolatorType (int interpType)
 Set the type of the velocity field interpolator to determine whether vtkInterpolatedVelocityField (INTERPOLATOR_WITH_DATASET_POINT_LOCATOR) or vtkCellLocatorInterpolatedVelocityField (INTERPOLATOR_WITH_CELL_LOCATOR) is employed for locating cells during streamline integration. More...
 
void AddCustomTerminationCallback (CustomTerminationCallbackType callback, void *clientdata, int reasonForTermination)
 Adds a custom termination callback. More...
 
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithmNewInstance () const
 
vtkPolyDataGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkPolyDataGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details More...
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkPolyDataGetPolyDataInput (int port)
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 
void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (int, vtkDataObject *)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
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)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
int * GetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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 *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkStreamTracerSafeDownCast (vtkObjectBase *o)
 
static vtkStreamTracerNew ()
 Construct object to start from position (0,0,0), with forward integration, terminal speed 1.0E-12, vorticity computation on, integration step size 0.5 (in cell length unit), maximum number of steps 2000, using Runge-Kutta2, and maximum propagation 1.0 (in arc length unit). More...
 
- Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPolyDataAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkStreamTracer ()
 
 ~vtkStreamTracer () override
 
vtkExecutiveCreateDefaultExecutive () override
 Create a default executive. More...
 
void AddInput (vtkDataObject *)
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
int FillInputPortInformation (int, vtkInformation *) override
 Fill the input port information objects for this algorithm. More...
 
void CalculateVorticity (vtkGenericCell *cell, double pcoords[3], vtkDoubleArray *cellVectors, double vorticity[3])
 
void Integrate (vtkPointData *inputData, vtkPolyData *output, vtkDataArray *seedSource, vtkIdList *seedIds, vtkIntArray *integrationDirections, double lastPoint[3], vtkAbstractInterpolatedVelocityField *func, int maxCellSize, int vecType, const char *vecFieldName, double &propagation, vtkIdType &numSteps, double &integrationTime)
 
double 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 () override
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
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)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
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)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static double ConvertToLength (double interval, int unit, double cellLength)
 
static double ConvertToLength (IntervalInformation &interval, double cellLength)
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 

Protected Attributes

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
 
bool SurfaceStreamlines
 
vtkAbstractInterpolatedVelocityFieldInterpolatorPrototype
 
vtkCompositeDataSetInputData
 
bool HasMatchingPointAttributes
 
std::vector< CustomTerminationCallbackTypeCustomTerminationCallback
 
std::vector< void * > CustomTerminationClientData
 
std::vector< int > CustomReasonForTermination
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Static Protected Attributes

static const double EPSILON
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Friends

class PStreamTracerUtils
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 

Detailed Description

Streamline generator.

vtkStreamTracer is a filter that integrates a vector field to generate streamlines. The integration is performed using a specified integrator, by default Runge-Kutta2.

vtkStreamTracer produces polylines as the output, with each cell (i.e., polyline) representing a streamline. The attribute values associated with each streamline are stored in the cell data, whereas those associated with streamline-points are stored in the point data.

vtkStreamTracer supports forward (the default), backward, and combined (i.e., BOTH) integration. The length of a streamline is governed by specifying a maximum value either in physical arc length or in (local) cell length. Otherwise, the integration terminates upon exiting the flow field domain, or if the particle speed is reduced to a value less than a specified terminal speed, or when a maximum number of steps is completed. The specific reason for the termination is stored in a cell array named ReasonForTermination.

Note that normalized vectors are adopted in streamline integration, which achieves high numerical accuracy/smoothness of flow lines that is particularly guaranteed for Runge-Kutta45 with adaptive step size and error control). In support of this feature, the underlying step size is ALWAYS in arc length unit (LENGTH_UNIT) while the 'real' time interval (virtual for steady flows) that a particle actually takes to trave in a single step is obtained by dividing the arc length by the LOCAL speed. The overall elapsed time (i.e., the life span) of the particle is the sum of those individual step-wise time intervals.

The quality of streamline integration can be controlled by setting the initial integration step (InitialIntegrationStep), particularly for Runge-Kutta2 and Runge-Kutta4 (with a fixed step size), and in the case of Runge-Kutta45 (with an adaptive step size and error control) the minimum integration step, the maximum integration step, and the maximum error. These steps are in either LENGTH_UNIT or CELL_LENGTH_UNIT while the error is in physical arc length. For the former two integrators, there is a trade-off between integration speed and streamline quality.

The integration time, vorticity, rotation and angular velocity are stored in point data arrays named "IntegrationTime", "Vorticity", "Rotation" and "AngularVelocity", respectively (vorticity, rotation and angular velocity are computed only when ComputeVorticity is on). All point data attributes in the source dataset are interpolated on the new streamline points.

vtkStreamTracer supports integration through any type of dataset. Thus if the dataset contains 2D cells like polygons or triangles, the integration is constrained to lie on the surface defined by 2D cells.

The starting point, or the so-called 'seed', of a streamline may be set in two different ways. Starting from global x-y-z "position" allows you to start a single trace at a specified x-y-z coordinate. If you specify a source object, traces will be generated from each point in the source that is inside the dataset.

See also
vtkRibbonFilter vtkRuledSurfaceFilter vtkInitialValueProblemSolver vtkRungeKutta2 vtkRungeKutta4 vtkRungeKutta45 vtkParticleTracerBase vtkParticleTracer vtkParticlePathFilter vtkStreaklineFilter vtkAbstractInterpolatedVelocityField vtkInterpolatedVelocityField vtkCellLocatorInterpolatedVelocityField

Definition at line 102 of file vtkStreamTracer.h.

Member Typedef Documentation

◆ Superclass

Definition at line 105 of file vtkStreamTracer.h.

◆ CustomTerminationCallbackType

typedef bool(* vtkStreamTracer::CustomTerminationCallbackType) (void *clientdata, vtkPoints *points, vtkDataArray *velocity, int integrationDirection)

Asks the user if the current streamline should be terminated.

clientdata is set by the client when setting up the callback. points is the array of points integrated so far velocity velocity vector integrated to produce the streamline integrationDirection FORWARD of BACKWARD The function returns true if the streamline should be terminated and false otherwise.

Definition at line 365 of file vtkStreamTracer.h.

Member Enumeration Documentation

◆ Units

Enumerator
LENGTH_UNIT 
CELL_LENGTH_UNIT 

Definition at line 153 of file vtkStreamTracer.h.

◆ Solvers

Enumerator
RUNGE_KUTTA2 
RUNGE_KUTTA4 
RUNGE_KUTTA45 
NONE 
UNKNOWN 

Definition at line 159 of file vtkStreamTracer.h.

◆ ReasonForTermination

Enumerator
OUT_OF_DOMAIN 
NOT_INITIALIZED 
UNEXPECTED_VALUE 
OUT_OF_LENGTH 
OUT_OF_STEPS 
STAGNATION 
FIXED_REASONS_FOR_TERMINATION_COUNT 

Definition at line 168 of file vtkStreamTracer.h.

◆ anonymous enum

anonymous enum
Enumerator
FORWARD 
BACKWARD 
BOTH 

Definition at line 295 of file vtkStreamTracer.h.

◆ anonymous enum

anonymous enum
Enumerator
INTERPOLATOR_WITH_DATASET_POINT_LOCATOR 
INTERPOLATOR_WITH_CELL_LOCATOR 

Definition at line 302 of file vtkStreamTracer.h.

Constructor & Destructor Documentation

◆ vtkStreamTracer()

vtkStreamTracer::vtkStreamTracer ( )
protected

◆ ~vtkStreamTracer()

vtkStreamTracer::~vtkStreamTracer ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkStreamTracer::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkStreamTracer::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 vtkTemporalStreamTracer, vtkPTemporalStreamTracer, and vtkPStreamTracer.

◆ SafeDownCast()

static vtkStreamTracer* vtkStreamTracer::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkStreamTracer::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkStreamTracer* vtkStreamTracer::NewInstance ( ) const

◆ PrintSelf()

void vtkStreamTracer::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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 vtkTemporalStreamTracer, vtkPTemporalStreamTracer, and vtkPStreamTracer.

◆ New()

static vtkStreamTracer* vtkStreamTracer::New ( )
static

Construct object to start from position (0,0,0), with forward integration, terminal speed 1.0E-12, vorticity computation on, integration step size 0.5 (in cell length unit), maximum number of steps 2000, using Runge-Kutta2, and maximum propagation 1.0 (in arc length unit).

◆ SetStartPosition() [1/2]

virtual void vtkStreamTracer::SetStartPosition ( double  ,
double  ,
double   
)
virtual

Specify the starting point (seed) of a streamline in the global coordinate system.

Search must be performed to find the initial cell from which to start integration.

◆ SetStartPosition() [2/2]

virtual void vtkStreamTracer::SetStartPosition ( double  [3])
virtual

◆ GetStartPosition() [1/3]

virtual double* vtkStreamTracer::GetStartPosition ( )
virtual

◆ GetStartPosition() [2/3]

virtual void vtkStreamTracer::GetStartPosition ( double &  ,
double &  ,
double &   
)
virtual

◆ GetStartPosition() [3/3]

virtual void vtkStreamTracer::GetStartPosition ( double  [3])
virtual

◆ SetSourceData()

void vtkStreamTracer::SetSourceData ( vtkDataSet source)

Specify the source object used to generate starting points (seeds).

Note that this method does not connect the pipeline. The algorithm will work on the input data as it is without updating the producer of the data. See SetSourceConnection for connecting the pipeline.

◆ GetSource()

vtkDataSet* vtkStreamTracer::GetSource ( )

◆ SetSourceConnection()

void vtkStreamTracer::SetSourceConnection ( vtkAlgorithmOutput algOutput)

Specify the source object used to generate starting points (seeds).

New style.

◆ SetIntegrator()

void vtkStreamTracer::SetIntegrator ( vtkInitialValueProblemSolver )

Set/get the integrator type to be used for streamline generation.

The object passed is not actually used but is cloned with NewInstance in the process of integration (prototype pattern). The default is Runge-Kutta2. The integrator can also be changed using SetIntegratorType. The recognized solvers are: RUNGE_KUTTA2 = 0 RUNGE_KUTTA4 = 1 RUNGE_KUTTA45 = 2

◆ GetIntegrator()

virtual vtkInitialValueProblemSolver* vtkStreamTracer::GetIntegrator ( )
virtual

◆ SetIntegratorType()

void vtkStreamTracer::SetIntegratorType ( int  type)

◆ GetIntegratorType()

int vtkStreamTracer::GetIntegratorType ( )

◆ SetIntegratorTypeToRungeKutta2()

void vtkStreamTracer::SetIntegratorTypeToRungeKutta2 ( )
inline

Definition at line 194 of file vtkStreamTracer.h.

◆ SetIntegratorTypeToRungeKutta4()

void vtkStreamTracer::SetIntegratorTypeToRungeKutta4 ( )
inline

Definition at line 195 of file vtkStreamTracer.h.

◆ SetIntegratorTypeToRungeKutta45()

void vtkStreamTracer::SetIntegratorTypeToRungeKutta45 ( )
inline

Definition at line 196 of file vtkStreamTracer.h.

◆ SetInterpolatorTypeToDataSetPointLocator()

void vtkStreamTracer::SetInterpolatorTypeToDataSetPointLocator ( )

Set the velocity field interpolator type to the one involving a dataset point locator.

◆ SetInterpolatorTypeToCellLocator()

void vtkStreamTracer::SetInterpolatorTypeToCellLocator ( )

Set the velocity field interpolator type to the one involving a cell locator.

◆ SetMaximumPropagation()

virtual void vtkStreamTracer::SetMaximumPropagation ( double  )
virtual

Specify the maximum length of a streamline expressed in LENGTH_UNIT.

◆ GetMaximumPropagation()

virtual double vtkStreamTracer::GetMaximumPropagation ( )
virtual

◆ SetIntegrationStepUnit()

void vtkStreamTracer::SetIntegrationStepUnit ( int  unit)

Specify a uniform integration step unit for MinimumIntegrationStep, InitialIntegrationStep, and MaximumIntegrationStep.

NOTE: The valid unit is now limited to only LENGTH_UNIT (1) and CELL_LENGTH_UNIT (2), EXCLUDING the previously-supported TIME_UNIT.

◆ GetIntegrationStepUnit()

int vtkStreamTracer::GetIntegrationStepUnit ( )
inline

Definition at line 226 of file vtkStreamTracer.h.

◆ SetInitialIntegrationStep()

virtual void vtkStreamTracer::SetInitialIntegrationStep ( double  )
virtual

Specify the Initial step size used for line integration, expressed in: LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 (either the starting size for an adaptive integrator, e.g., RK45, or the constant / fixed size for non-adaptive ones, i.e., RK2 and RK4)

◆ GetInitialIntegrationStep()

virtual double vtkStreamTracer::GetInitialIntegrationStep ( )
virtual

◆ SetMinimumIntegrationStep()

virtual void vtkStreamTracer::SetMinimumIntegrationStep ( double  )
virtual

Specify the Minimum step size used for line integration, expressed in: LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 (Only valid for an adaptive integrator, e.g., RK45)

◆ GetMinimumIntegrationStep()

virtual double vtkStreamTracer::GetMinimumIntegrationStep ( )
virtual

◆ SetMaximumIntegrationStep()

virtual void vtkStreamTracer::SetMaximumIntegrationStep ( double  )
virtual

Specify the Maximum step size used for line integration, expressed in: LENGTH_UNIT = 1 CELL_LENGTH_UNIT = 2 (Only valid for an adaptive integrator, e.g., RK45)

◆ GetMaximumIntegrationStep()

virtual double vtkStreamTracer::GetMaximumIntegrationStep ( )
virtual

◆ SetMaximumError()

virtual void vtkStreamTracer::SetMaximumError ( double  )
virtual

Specify the maximum error tolerated throughout streamline integration.

◆ GetMaximumError()

virtual double vtkStreamTracer::GetMaximumError ( )
virtual

◆ SetMaximumNumberOfSteps()

virtual void vtkStreamTracer::SetMaximumNumberOfSteps ( vtkIdType  )
virtual

Specify the maximum number of steps for integrating a streamline.

◆ GetMaximumNumberOfSteps()

virtual vtkIdType vtkStreamTracer::GetMaximumNumberOfSteps ( )
virtual

◆ SetTerminalSpeed()

virtual void vtkStreamTracer::SetTerminalSpeed ( double  )
virtual

Specify the terminal speed value, below which integration is terminated.

◆ GetTerminalSpeed()

virtual double vtkStreamTracer::GetTerminalSpeed ( )
virtual

◆ GetSurfaceStreamlines()

virtual bool vtkStreamTracer::GetSurfaceStreamlines ( )
virtual

Set/Unset the streamlines to be computed on a surface.

◆ SetSurfaceStreamlines()

virtual void vtkStreamTracer::SetSurfaceStreamlines ( bool  )
virtual

◆ SurfaceStreamlinesOn()

virtual void vtkStreamTracer::SurfaceStreamlinesOn ( )
virtual

◆ SurfaceStreamlinesOff()

virtual void vtkStreamTracer::SurfaceStreamlinesOff ( )
virtual

◆ SetIntegrationDirection()

virtual void vtkStreamTracer::SetIntegrationDirection ( int  )
virtual

Specify whether the streamline is integrated in the upstream or downstream direction.

◆ GetIntegrationDirection()

virtual int vtkStreamTracer::GetIntegrationDirection ( )
virtual

◆ SetIntegrationDirectionToForward()

void vtkStreamTracer::SetIntegrationDirectionToForward ( )
inline

Definition at line 315 of file vtkStreamTracer.h.

◆ SetIntegrationDirectionToBackward()

void vtkStreamTracer::SetIntegrationDirectionToBackward ( )
inline

Definition at line 316 of file vtkStreamTracer.h.

◆ SetIntegrationDirectionToBoth()

void vtkStreamTracer::SetIntegrationDirectionToBoth ( )
inline

Definition at line 317 of file vtkStreamTracer.h.

◆ SetComputeVorticity()

virtual void vtkStreamTracer::SetComputeVorticity ( bool  )
virtual

Turn on/off vorticity computation at streamline points (necessary for generating proper stream-ribbons using the vtkRibbonFilter.

◆ GetComputeVorticity()

virtual bool vtkStreamTracer::GetComputeVorticity ( )
virtual

◆ SetRotationScale()

virtual void vtkStreamTracer::SetRotationScale ( double  )
virtual

This can be used to scale the rate with which the streamribbons twist.

The default is 1.

◆ GetRotationScale()

virtual double vtkStreamTracer::GetRotationScale ( )
virtual

◆ SetInterpolatorPrototype()

void vtkStreamTracer::SetInterpolatorPrototype ( vtkAbstractInterpolatedVelocityField ivf)

The object used to interpolate the velocity field during integration is of the same class as this prototype.

◆ SetInterpolatorType()

void vtkStreamTracer::SetInterpolatorType ( int  interpType)

Set the type of the velocity field interpolator to determine whether vtkInterpolatedVelocityField (INTERPOLATOR_WITH_DATASET_POINT_LOCATOR) or vtkCellLocatorInterpolatedVelocityField (INTERPOLATOR_WITH_CELL_LOCATOR) is employed for locating cells during streamline integration.

The latter (adopting vtkAbstractCellLocator sub-classes such as vtkCellLocator and vtkModifiedBSPTree) is more robust then the former (through vtkDataSet / vtkPointSet::FindCell() coupled with vtkPointLocator).

◆ AddCustomTerminationCallback()

void vtkStreamTracer::AddCustomTerminationCallback ( CustomTerminationCallbackType  callback,
void *  clientdata,
int  reasonForTermination 
)

Adds a custom termination callback.

callback is a function provided by the user that says if the streamline should be terminated. clientdata user specific data passed to the callback reasonForTermination this value will be set in the ReasonForTermination cell array if the streamline is terminated by this callback.

◆ CreateDefaultExecutive()

vtkExecutive* vtkStreamTracer::CreateDefaultExecutive ( )
overrideprotectedvirtual

Create a default executive.

If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). Otherwise, vtkStreamingDemandDrivenPipeline is created.

Reimplemented from vtkAlgorithm.

◆ AddInput()

void vtkStreamTracer::AddInput ( vtkDataObject )
inlineprotected

Definition at line 386 of file vtkStreamTracer.h.

◆ RequestData()

int vtkStreamTracer::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkTemporalStreamTracer, vtkPTemporalStreamTracer, and vtkPStreamTracer.

◆ FillInputPortInformation()

int vtkStreamTracer::FillInputPortInformation ( int  port,
vtkInformation info 
)
overrideprotectedvirtual

Fill the input port information objects for this algorithm.

This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkTemporalStreamTracer.

◆ CalculateVorticity()

void vtkStreamTracer::CalculateVorticity ( vtkGenericCell cell,
double  pcoords[3],
vtkDoubleArray cellVectors,
double  vorticity[3] 
)
protected

◆ Integrate()

void vtkStreamTracer::Integrate ( vtkPointData inputData,
vtkPolyData output,
vtkDataArray seedSource,
vtkIdList seedIds,
vtkIntArray integrationDirections,
double  lastPoint[3],
vtkAbstractInterpolatedVelocityField func,
int  maxCellSize,
int  vecType,
const char *  vecFieldName,
double &  propagation,
vtkIdType numSteps,
double &  integrationTime 
)
protected

◆ SimpleIntegrate()

double vtkStreamTracer::SimpleIntegrate ( double  seed[3],
double  lastPoint[3],
double  stepSize,
vtkAbstractInterpolatedVelocityField func 
)
protected

◆ CheckInputs()

int vtkStreamTracer::CheckInputs ( vtkAbstractInterpolatedVelocityField *&  func,
int *  maxCellSize 
)
protected

◆ GenerateNormals()

void vtkStreamTracer::GenerateNormals ( vtkPolyData output,
double *  firstNormal,
const char *  vecName 
)
protected

◆ ConvertIntervals()

void vtkStreamTracer::ConvertIntervals ( double &  step,
double &  minStep,
double &  maxStep,
int  direction,
double  cellLength 
)
protected

◆ ConvertToLength() [1/2]

static double vtkStreamTracer::ConvertToLength ( double  interval,
int  unit,
double  cellLength 
)
staticprotected

◆ ConvertToLength() [2/2]

static double vtkStreamTracer::ConvertToLength ( IntervalInformation interval,
double  cellLength 
)
staticprotected

◆ SetupOutput()

int vtkStreamTracer::SetupOutput ( vtkInformation inInfo,
vtkInformation outInfo 
)
protected

◆ InitializeSeeds()

void vtkStreamTracer::InitializeSeeds ( vtkDataArray *&  seeds,
vtkIdList *&  seedIds,
vtkIntArray *&  integrationDirections,
vtkDataSet source 
)
protected

Friends And Related Function Documentation

◆ PStreamTracerUtils

friend class PStreamTracerUtils
friend

Definition at line 459 of file vtkStreamTracer.h.

Member Data Documentation

◆ GenerateNormalsInIntegrate

bool vtkStreamTracer::GenerateNormalsInIntegrate
protected

Definition at line 405 of file vtkStreamTracer.h.

◆ StartPosition

double vtkStreamTracer::StartPosition[3]
protected

Definition at line 408 of file vtkStreamTracer.h.

◆ EPSILON

const double vtkStreamTracer::EPSILON
staticprotected

Definition at line 410 of file vtkStreamTracer.h.

◆ TerminalSpeed

double vtkStreamTracer::TerminalSpeed
protected

Definition at line 411 of file vtkStreamTracer.h.

◆ LastUsedStepSize

double vtkStreamTracer::LastUsedStepSize
protected

Definition at line 413 of file vtkStreamTracer.h.

◆ MaximumPropagation

double vtkStreamTracer::MaximumPropagation
protected

Definition at line 421 of file vtkStreamTracer.h.

◆ MinimumIntegrationStep

double vtkStreamTracer::MinimumIntegrationStep
protected

Definition at line 422 of file vtkStreamTracer.h.

◆ MaximumIntegrationStep

double vtkStreamTracer::MaximumIntegrationStep
protected

Definition at line 423 of file vtkStreamTracer.h.

◆ InitialIntegrationStep

double vtkStreamTracer::InitialIntegrationStep
protected

Definition at line 424 of file vtkStreamTracer.h.

◆ IntegrationStepUnit

int vtkStreamTracer::IntegrationStepUnit
protected

Definition at line 435 of file vtkStreamTracer.h.

◆ IntegrationDirection

int vtkStreamTracer::IntegrationDirection
protected

Definition at line 436 of file vtkStreamTracer.h.

◆ Integrator

vtkInitialValueProblemSolver* vtkStreamTracer::Integrator
protected

Definition at line 439 of file vtkStreamTracer.h.

◆ MaximumError

double vtkStreamTracer::MaximumError
protected

Definition at line 441 of file vtkStreamTracer.h.

◆ MaximumNumberOfSteps

vtkIdType vtkStreamTracer::MaximumNumberOfSteps
protected

Definition at line 442 of file vtkStreamTracer.h.

◆ ComputeVorticity

bool vtkStreamTracer::ComputeVorticity
protected

Definition at line 444 of file vtkStreamTracer.h.

◆ RotationScale

double vtkStreamTracer::RotationScale
protected

Definition at line 445 of file vtkStreamTracer.h.

◆ SurfaceStreamlines

bool vtkStreamTracer::SurfaceStreamlines
protected

Definition at line 448 of file vtkStreamTracer.h.

◆ InterpolatorPrototype

vtkAbstractInterpolatedVelocityField* vtkStreamTracer::InterpolatorPrototype
protected

Definition at line 450 of file vtkStreamTracer.h.

◆ InputData

vtkCompositeDataSet* vtkStreamTracer::InputData
protected

Definition at line 452 of file vtkStreamTracer.h.

◆ HasMatchingPointAttributes

bool vtkStreamTracer::HasMatchingPointAttributes
protected

Definition at line 454 of file vtkStreamTracer.h.

◆ CustomTerminationCallback

std::vector<CustomTerminationCallbackType> vtkStreamTracer::CustomTerminationCallback
protected

Definition at line 455 of file vtkStreamTracer.h.

◆ CustomTerminationClientData

std::vector<void*> vtkStreamTracer::CustomTerminationClientData
protected

Definition at line 456 of file vtkStreamTracer.h.

◆ CustomReasonForTermination

std::vector<int> vtkStreamTracer::CustomReasonForTermination
protected

Definition at line 457 of file vtkStreamTracer.h.


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