vtkAMRBaseParticlesReader.h

Go to the documentation of this file.

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

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

#include "vtkIOAMRModule.h" // For export macro
#include "vtkMultiBlockDataSetAlgorithm.h"

class vtkInformation;
class vtkInformationVector;
class vtkIndent;
class vtkMultiProcessController;
class vtkPolyData;
class vtkDataArraySelection;
class vtkCallbackCommand;

class VTKIOAMR_EXPORT vtkAMRBaseParticlesReader :
  public vtkMultiBlockDataSetAlgorithm
{
public:
  vtkTypeMacro( vtkAMRBaseParticlesReader, vtkMultiBlockDataSetAlgorithm );
  void PrintSelf(ostream &os, vtkIndent indent ) override;


  vtkGetMacro(Frequency,int);
  vtkSetMacro(Frequency,int);


  vtkGetMacro(Controller, vtkMultiProcessController* );
  vtkSetMacro(Controller, vtkMultiProcessController* );


  vtkSetMacro(FilterLocation,vtkTypeBool);
  vtkGetMacro(FilterLocation,vtkTypeBool);
  vtkBooleanMacro(FilterLocation,vtkTypeBool);



  vtkGetObjectMacro(ParticleDataArraySelection,vtkDataArraySelection);

  int GetNumberOfParticleArrays();

  const char* GetParticleArrayName( int index );


  int GetParticleArrayStatus( const char* name );
  void SetParticleArrayStatus( const char* name, int status );


  virtual void SetFileName( const char *fileName );
  vtkGetStringMacro(FileName);


  inline void SetMinLocation(
      const double minx, const double miny, const double minz )
  {
    this->MinLocation[ 0 ] = minx;
    this->MinLocation[ 1 ] = miny;
    this->MinLocation[ 2 ] = minz;
  }


  inline void SetMaxLocation(
      const double maxx, const double maxy, const double maxz )
  {
    this->MaxLocation[ 0 ] = maxx;
    this->MaxLocation[ 1 ] = maxy;
    this->MaxLocation[ 2 ] = maxz;
  }

  virtual int GetTotalNumberOfParticles() = 0;

protected:
  vtkAMRBaseParticlesReader();
  ~vtkAMRBaseParticlesReader() override;

  virtual void ReadMetaData() = 0;

  virtual vtkPolyData* ReadParticles( const int blkIdx ) = 0;

  bool CheckLocation( const double x, const double y, const double z );

  bool IsParallel( );

  bool IsBlockMine( const int blkIdx );

  int GetBlockProcessId( const int blkIdx );

  void Initialize();


  vtkDataArraySelection *ParticleDataArraySelection;
  vtkCallbackCommand *SelectionObserver;

  void InitializeParticleDataSelections();

  virtual void SetupParticleDataSelections() = 0;

  static void SelectionModifiedCallback(
   vtkObject *caller,unsigned long eid,void *clientdata,void *calldata );


  int RequestData( vtkInformation *request,
      vtkInformationVector **inputVector,
      vtkInformationVector *outputVector ) override;
  int FillOutputPortInformation( int port, vtkInformation *info ) override;

  int NumberOfBlocks;

  vtkTypeBool FilterLocation;
  double MinLocation[3];
  double MaxLocation[3];

  int Frequency;
  vtkMultiProcessController *Controller;

  bool  InitialRequest;
  bool  Initialized;
  char *FileName;

private:
  vtkAMRBaseParticlesReader( const vtkAMRBaseParticlesReader& ) = delete;
  void operator=(const vtkAMRBaseParticlesReader& ) = delete;
};

#endif /* vtkAMRBaseParticlesReader_h */