vtkTemporalStreamTracer.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkTemporalStreamTracer.h
 
  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.
 
=========================================================================*/
#ifndef vtkTemporalStreamTracer_h
#define vtkTemporalStreamTracer_h
 
#include "vtkDeprecation.h"            // For VTK_DEPRECATED_IN_9_0_0
#include "vtkFiltersFlowPathsModule.h" // For export macro
#include "vtkSmartPointer.h"           // For protected ivars.
#include "vtkStreamTracer.h"
 
#include <list>   // STL Header
#include <vector> // STL Header
 
class vtkMultiProcessController;
 
class vtkMultiBlockDataSet;
class vtkDataArray;
class vtkDoubleArray;
class vtkGenericCell;
class vtkIntArray;
class vtkTemporalInterpolatedVelocityField;
class vtkPoints;
class vtkCellArray;
class vtkDoubleArray;
class vtkFloatArray;
class vtkIntArray;
class vtkSignedCharArray;
class vtkAbstractParticleWriter;
 
namespace vtkTemporalStreamTracerNamespace
{
struct Position_t
{
  double x[4];
};
using Position = struct Position_t;
 
struct ParticleInformation_t
{
  // These are used during iteration
  Position CurrentPosition;
  int CachedDataSetId[2];
  vtkIdType CachedCellId[2];
  int LocationState;
  // These are computed scalars we might display
  int SourceID;
  int TimeStepAge;
  int InjectedPointId;
  int InjectedStepId;
  int UniqueParticleId;
  // These are useful to track for debugging etc
  int ErrorCode;
  float age;
  // these are needed across time steps to compute vorticity
  float rotation;
  float angularVel;
  float time;
  float speed;
};
using ParticleInformation = struct ParticleInformation_t;
 
typedef std::vector<ParticleInformation> ParticleVector;
typedef ParticleVector::iterator ParticleIterator;
typedef std::list<ParticleInformation> ParticleDataList;
typedef ParticleDataList::iterator ParticleListIterator;
};
 
VTK_DEPRECATED_IN_9_0_0("Use one of vtkParticleTracerBase, vtkParticleTracer, "
                        "vtkParticlePathFilter, or vtkStreaklineFilter")
class VTKFILTERSFLOWPATHS_EXPORT vtkTemporalStreamTracer : public vtkStreamTracer
{
public:
  vtkTypeMacro(vtkTemporalStreamTracer, vtkStreamTracer);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  static vtkTemporalStreamTracer* New();
 
 
  vtkSetMacro(TimeStep, unsigned int);
  vtkGetMacro(TimeStep, unsigned int);
 
 
  vtkSetMacro(IgnorePipelineTime, vtkTypeBool);
  vtkGetMacro(IgnorePipelineTime, vtkTypeBool);
  vtkBooleanMacro(IgnorePipelineTime, vtkTypeBool);
 
 
  vtkSetMacro(TimeStepResolution, double);
  vtkGetMacro(TimeStepResolution, double);
 
 
  vtkSetMacro(ForceReinjectionEveryNSteps, int);
  vtkGetMacro(ForceReinjectionEveryNSteps, int);
 
  enum Units
  {
    TERMINATION_TIME_UNIT,
    TERMINATION_STEP_UNIT
  };
 
 
  vtkSetMacro(TerminationTime, double);
  vtkGetMacro(TerminationTime, double);
 
 
  vtkSetMacro(TerminationTimeUnit, int);
  vtkGetMacro(TerminationTimeUnit, int);
  void SetTerminationTimeUnitToTimeUnit() { this->SetTerminationTimeUnit(TERMINATION_TIME_UNIT); }
  void SetTerminationTimeUnitToStepUnit() { this->SetTerminationTimeUnit(TERMINATION_STEP_UNIT); }
 
 
  vtkSetMacro(StaticSeeds, vtkTypeBool);
  vtkGetMacro(StaticSeeds, vtkTypeBool);
  vtkBooleanMacro(StaticSeeds, vtkTypeBool);
 
 
  vtkSetMacro(StaticMesh, vtkTypeBool);
  vtkGetMacro(StaticMesh, vtkTypeBool);
  vtkBooleanMacro(StaticMesh, vtkTypeBool);
 
 
  virtual void SetParticleWriter(vtkAbstractParticleWriter* pw);
  vtkGetObjectMacro(ParticleWriter, vtkAbstractParticleWriter);
 
 
  vtkSetFilePathMacro(ParticleFileName);
  vtkGetFilePathMacro(ParticleFileName);
 
 
  vtkSetMacro(EnableParticleWriting, vtkTypeBool);
  vtkGetMacro(EnableParticleWriting, vtkTypeBool);
  vtkBooleanMacro(EnableParticleWriting, vtkTypeBool);
 
 
  void AddSourceConnection(vtkAlgorithmOutput* input);
  void RemoveAllSources();
 
protected:
  vtkTemporalStreamTracer();
  ~vtkTemporalStreamTracer() override;
 
  //
  // Make sure the pipeline knows what type we expect as input
  //
  int FillInputPortInformation(int port, vtkInformation* info) override;
 
  //
  // The usual suspects
  //
  vtkTypeBool ProcessRequest(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
 
  //
  // Store any information we need in the output and fetch what we can
  // from the input
  //
  int RequestInformation(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
 
  //
  // Compute input time steps given the output step
  //
  int RequestUpdateExtent(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
 
  //
  // what the pipeline calls for each time step
  //
  int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
 
  //
  // these routines are internally called to actually generate the output
  //
  virtual int ProcessInput(vtkInformationVector** inputVector);
 
  virtual int GenerateOutput(
    vtkInformationVector** inputVector, vtkInformationVector* outputVector);
 
  //
  // Initialization of input (vector-field) geometry
  //
  int InitializeInterpolator();
  int SetTemporalInput(vtkDataObject* td, int index);
 
  //
 
  void TestParticles(vtkTemporalStreamTracerNamespace::ParticleVector& candidates,
    vtkTemporalStreamTracerNamespace::ParticleVector& passed, int& count);
 
  virtual void AssignSeedsToProcessors(vtkDataSet* source, int sourceID, int ptId,
    vtkTemporalStreamTracerNamespace::ParticleVector& LocalSeedPoints, int& LocalAssignedCount);
 
  virtual void AssignUniqueIds(vtkTemporalStreamTracerNamespace::ParticleVector& LocalSeedPoints);
 
  void UpdateParticleList(vtkTemporalStreamTracerNamespace::ParticleVector& candidates);
 
  virtual void TransmitReceiveParticles(
    vtkTemporalStreamTracerNamespace::ParticleVector& outofdomain,
    vtkTemporalStreamTracerNamespace::ParticleVector& received, bool removeself);
 
  void IntegrateParticle(vtkTemporalStreamTracerNamespace::ParticleListIterator& it,
    double currenttime, double terminationtime, vtkInitialValueProblemSolver* integrator);
 
  bool RetryWithPush(
    vtkTemporalStreamTracerNamespace::ParticleInformation& info, double velocity[3], double delT);
 
  // if the particle is added to send list, then returns value is 1,
  // if it is kept on this process after a retry return value is 0
  bool SendParticleToAnotherProcess(
    vtkTemporalStreamTracerNamespace::ParticleInformation& info, double point1[4], double delT);
 
  void AddParticleToMPISendList(vtkTemporalStreamTracerNamespace::ParticleInformation& info);
 
  bool ComputeDomainExitLocation(
    double pos[4], double p2[4], double intersection[4], vtkGenericCell* cell);
 
  //
 
  //
  // Track internally which round of RequestData it is--between 0 and 2
  int RequestIndex;
 
  // Track which process we are
  int UpdatePieceId;
  int UpdateNumPieces;
 
  // Important for Caching of Cells/Ids/Weights etc
  int AllFixedGeometry;
  vtkTypeBool StaticMesh;
  vtkTypeBool StaticSeeds;
 
  // Support 'pipeline' time or manual SetTimeStep
  unsigned int TimeStep;
  unsigned int ActualTimeStep;
  vtkTypeBool IgnorePipelineTime;
  unsigned int NumberOfInputTimeSteps;
 
  std::vector<double> InputTimeValues;
  std::vector<double> OutputTimeValues;
 
  // more time management
  double EarliestTime;
  double CurrentTimeSteps[2];
  double TimeStepResolution;
 
  // Particle termination after time
  double TerminationTime;
  int TerminationTimeUnit;
 
  // Particle injection+Reinjection
  int ForceReinjectionEveryNSteps;
  bool ReinjectionFlag;
  int ReinjectionCounter;
  vtkTimeStamp ParticleInjectionTime;
 
  // Particle writing to disk
  vtkAbstractParticleWriter* ParticleWriter;
  char* ParticleFileName;
  vtkTypeBool EnableParticleWriting;
 
  // The main lists which are held during operation- between time step updates
  unsigned int NumberOfParticles;
  vtkTemporalStreamTracerNamespace::ParticleDataList ParticleHistories;
  vtkTemporalStreamTracerNamespace::ParticleVector LocalSeeds;
 
  //
  // Scalar arrays that are generated as each particle is updated
  //
  vtkSmartPointer<vtkFloatArray> ParticleAge;
  vtkSmartPointer<vtkIntArray> ParticleIds;
  vtkSmartPointer<vtkSignedCharArray> ParticleSourceIds;
  vtkSmartPointer<vtkIntArray> InjectedPointIds;
  vtkSmartPointer<vtkIntArray> InjectedStepIds;
  vtkSmartPointer<vtkIntArray> ErrorCodeArray;
  vtkSmartPointer<vtkFloatArray> ParticleVorticity;
  vtkSmartPointer<vtkFloatArray> ParticleRotation;
  vtkSmartPointer<vtkFloatArray> ParticleAngularVel;
  vtkSmartPointer<vtkDoubleArray> cellVectors;
  vtkSmartPointer<vtkPointData> OutputPointData;
  int InterpolationCount;
 
  // The output geometry
  vtkSmartPointer<vtkCellArray> ParticleCells;
  vtkSmartPointer<vtkPoints> OutputCoordinates;
 
  // List used for transmitting between processors during parallel operation
  vtkTemporalStreamTracerNamespace::ParticleVector MPISendList;
 
  // The velocity interpolator
  vtkSmartPointer<vtkTemporalInterpolatedVelocityField> Interpolator;
 
  // The input datasets which are stored by time step 0 and 1
  vtkSmartPointer<vtkMultiBlockDataSet> InputDataT[2];
  vtkSmartPointer<vtkDataSet> DataReferenceT[2];
 
  // Cache bounds info for each dataset we will use repeatedly
  struct bounds_t
  {
    double b[6];
  };
  using bounds = struct bounds_t;
  std::vector<bounds> CachedBounds[2];
 
  // utility function we use to test if a point is inside any of our local datasets
  bool InsideBounds(double point[]);
 
  // global Id counter used to give particles a stamp
  vtkIdType UniqueIdCounter;
  vtkIdType UniqueIdCounterMPI;
  // for debugging only;
  int substeps;
 
private:
  void SetInterpolatorPrototype(vtkAbstractInterpolatedVelocityField*) {}
 
private:
  vtkTemporalStreamTracer(const vtkTemporalStreamTracer&) = delete;
  void operator=(const vtkTemporalStreamTracer&) = delete;
};
 
#endif