vtkLegacyPParticleTracerBase.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkLegacyPParticleTracerBase_h
#define vtkLegacyPParticleTracerBase_h

#include "vtkLegacyParticleTracerBase.h"
#include "vtkSmartPointer.h" // For protected ivars.

#include <vector> // STL Header

#include "vtkPVVTKExtensionsFiltersGeneralMPIModule.h" // For export macro

class VTKPVVTKEXTENSIONSFILTERSGENERALMPI_EXPORT vtkLegacyPParticleTracerBase
  : public vtkLegacyParticleTracerBase
{
public:
  vtkTypeMacro(vtkLegacyPParticleTracerBase, vtkLegacyParticleTracerBase);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  virtual void SetController(vtkMultiProcessController* controller);
  vtkGetObjectMacro(Controller, vtkMultiProcessController);

protected:
  struct RemoteParticleInfo
  {
    vtkLegacyParticleTracerBaseNamespace::ParticleInformation Current;
    vtkLegacyParticleTracerBaseNamespace::ParticleInformation Previous;
    vtkSmartPointer<vtkPointData> PreviousPD;
  };

  typedef std::vector<RemoteParticleInfo> RemoteParticleVector;

  vtkLegacyPParticleTracerBase();
  ~vtkLegacyPParticleTracerBase() override;

  int RequestUpdateExtent(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;

  //

  vtkPolyData* Execute(vtkInformationVector** inputVector) override;
  bool SendParticleToAnotherProcess(vtkLegacyParticleTracerBaseNamespace::ParticleInformation& info,
    vtkLegacyParticleTracerBaseNamespace::ParticleInformation& previous, vtkPointData*) override;

  void AssignSeedsToProcessors(double time, vtkDataSet* source, int sourceID, int ptId,
    vtkLegacyParticleTracerBaseNamespace::ParticleVector& localSeedPoints,
    int& localAssignedCount) override;

  void AssignUniqueIds(
    vtkLegacyParticleTracerBaseNamespace::ParticleVector& localSeedPoints) override;

  bool SendReceiveParticles(RemoteParticleVector& outofdomain, RemoteParticleVector& received);

  bool UpdateParticleListFromOtherProcesses() override;

  bool IsPointDataValid(vtkDataObject* input) override;

  //

  //

  // MPI controller needed when running in parallel
  vtkMultiProcessController* Controller;

  // List used for transmitting between processors during parallel operation
  RemoteParticleVector MPISendList;

  RemoteParticleVector Tail; // this is to receive the "tails" of traces from other processes
private:
  vtkLegacyPParticleTracerBase(const vtkLegacyPParticleTracerBase&) = delete;
  void operator=(const vtkLegacyPParticleTracerBase&) = delete;
};
#endif