dox/Filters/ParallelFlowPaths/vtkPParticleTracerBase.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkParticleTracerBase.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 __vtkPParticleTracerBase_h
#define __vtkPParticleTracerBase_h

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

//BTX
#include <vector> // STL Header
#include <list>   // STL Header
//ETX

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

class VTKFILTERSPARALLELFLOWPATHS_EXPORT vtkPParticleTracerBase : public vtkParticleTracerBase
{
public:

    vtkTypeMacro(vtkPParticleTracerBase,vtkParticleTracerBase);
    void PrintSelf(ostream& os, vtkIndent indent);



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

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

    typedef std::vector<RemoteParticleInfo>  RemoteParticleVector;


     vtkPParticleTracerBase();
    ~vtkPParticleTracerBase();

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

    //
    // Generate output
    //
    virtual int RequestData(vtkInformation* request,
                            vtkInformationVector** inputVector,
                            vtkInformationVector* outputVector);

//
//BTX

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


    virtual void AssignSeedsToProcessors(double time,
      vtkDataSet *source, int sourceID, int ptId,
      vtkParticleTracerBaseNamespace::ParticleVector &LocalSeedPoints,
      int &LocalAssignedCount);


    virtual void AssignUniqueIds(
      vtkParticleTracerBaseNamespace::ParticleVector &LocalSeedPoints);

    virtual void SendReceiveParticles(RemoteParticleVector &outofdomain, RemoteParticleVector &received);

    void UpdateParticleListFromOtherProcesses();

  virtual bool IsPointDataValid(vtkDataObject* input);


//
//ETX
//

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

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

  int Rank;
  int NumProcs;
  RemoteParticleVector Tail; //this is to receive the "tails" of traces from other processes
private:
  vtkPParticleTracerBase(const vtkPParticleTracerBase&);  // Not implemented.
  void operator=(const vtkPParticleTracerBase&);  // Not implemented.

};

#endif