1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
/*=========================================================================
Program: Visualization Toolkit
Module: $RCSfile: vtkInterpolatedVelocityField.h,v $
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkInterpolatedVelocityField - Interface for obtaining
// interpolated velocity values
// .SECTION Description
// vtkInterpolatedVelocityField acts as a continuous velocity field
// by performing cell interpolation on the underlying vtkDataSet.
// This is a concrete sub-class of vtkFunctionSet with
// NumberOfIndependentVariables = 4 (x,y,z,t) and
// NumberOfFunctions = 3 (u,v,w). Normally, every time an evaluation
// is performed, the cell which contains the point (x,y,z) has to
// be found by calling FindCell. This is a computationally expansive
// operation. In certain cases, the cell search can be avoided or shortened
// by providing a guess for the cell id. For example, in streamline
// integration, the next evaluation is usually in the same or a neighbour
// cell. For this reason, vtkInterpolatedVelocityField stores the last
// cell id. If caching is turned on, it uses this id as the starting point.
// .SECTION Caveats
// vtkInterpolatedVelocityField is not thread safe. A new instance should
// be created by each thread.
// .SECTION See Also
// vtkFunctionSet vtkStreamer
#ifndef __vtkInterpolatedVelocityField_h
#define __vtkInterpolatedVelocityField_h
#include "vtkFunctionSet.h"
class vtkDataSet;
class vtkGenericCell;
class vtkInterpolatedVelocityFieldDataSetsType;
class VTK_FILTERING_EXPORT vtkInterpolatedVelocityField : public vtkFunctionSet
{
public:
vtkTypeRevisionMacro(vtkInterpolatedVelocityField,vtkFunctionSet);
virtual void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Construct a vtkInterpolatedVelocityField with no initial data set.
// Caching is on. LastCellId is set to -1.
static vtkInterpolatedVelocityField *New();
// Description:
// Evaluate the velocity field, f, at (x, y, z, t).
// For now, t is ignored.
virtual int FunctionValues(double* x, double* f);
// Description:
// Add a dataset used for the implicit function evaluation.
// If more than one dataset is added, the evaluation point is
// searched in all until a match is found. THIS FUNCTION
// DOES NOT CHANGE THE REFERENCE COUNT OF dataset FOR THREAD
// SAFETY REASONS.
virtual void AddDataSet(vtkDataSet* dataset);
// Description:
// Return the cell id cached from last evaluation.
vtkGetMacro(LastCellId, vtkIdType);
vtkSetMacro(LastCellId, vtkIdType);
// Description:
// Set the last cell id to -1 so that the next search does not
// start from the previous cell
void ClearLastCellId() { this->LastCellId = -1; }
// Description:
// Returns the interpolation weights cached from last evaluation
// if the cached cell is valid (returns 1). Otherwise, it does not
// change w and returns 0.
int GetLastWeights(double* w);
int GetLastLocalCoordinates(double pcoords[3]);
// Description:
// Turn caching on/off.
vtkGetMacro(Caching, int);
vtkSetMacro(Caching, int);
vtkBooleanMacro(Caching, int);
// Description:
// Caching statistics.
vtkGetMacro(CacheHit, int);
vtkGetMacro(CacheMiss, int);
// Description:
// If you want to work with an arbitrary vector array, then set its name
// here. By default this in NULL and the filter will use the active vector
// array.
vtkGetStringMacro(VectorsSelection);
void SelectVectors(const char *fieldName)
{this->SetVectorsSelection(fieldName);}
// Description:
// Returns the last dataset that was visited. Can be used
// as a first guess as to where the next point will be as
// well as to avoid searching through all datasets to get
// more information about the point.
vtkGetObjectMacro(LastDataSet, vtkDataSet);
// Description:
// Copy the user set parameters from source. This copies
// the Caching parameters. Sub-classes can add more after
// chaining.
virtual void CopyParameters(vtkInterpolatedVelocityField* from);
protected:
vtkInterpolatedVelocityField();
~vtkInterpolatedVelocityField();
vtkGenericCell* GenCell; // last cell
vtkGenericCell* Cell;
double* Weights; // last weights
int WeightsSize;
double LastPCoords[3]; // last local coordinates
vtkIdType LastCellId;
int CacheHit;
int CacheMiss;
int Caching;
vtkDataSet* LastDataSet;
vtkSetStringMacro(VectorsSelection);
char *VectorsSelection;
vtkInterpolatedVelocityFieldDataSetsType* DataSets;
int FunctionValues(vtkDataSet* ds, double* x, double* f);
static const double TOLERANCE_SCALE;
private:
vtkInterpolatedVelocityField(const vtkInterpolatedVelocityField&); // Not implemented.
void operator=(const vtkInterpolatedVelocityField&); // Not implemented.
};
#endif
|
