dox/IO/AMR/vtkAMRBaseReader.h

Go to the documentation of this file.

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

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

#include "vtkIOAMRModule.h" // For export macro
#include "vtkOverlappingAMRAlgorithm.h"
#include <vector>    // STL vector header
#include <map>       // STL map header
#include <utility>   // for STL pair

// Forward Declarations
class vtkOverlappingAMR;
class vtkMultiProcessController;
class vtkDataArraySelection;
class vtkCallbackCommand;
class vtkIndent;
class vtkAMRDataSetCache;
class vtkUniformGrid;
class vtkDataArray;

class VTKIOAMR_EXPORT vtkAMRBaseReader :
  public vtkOverlappingAMRAlgorithm
{
public:
  vtkTypeMacro( vtkAMRBaseReader, vtkOverlappingAMRAlgorithm );
  void PrintSelf(ostream &os, vtkIndent indent);

  void Initialize();


  vtkSetMacro( EnableCaching, int );
  vtkGetMacro( EnableCaching, int );
  vtkBooleanMacro( EnableCaching, int );
  bool IsCachingEnabled() const
     {
     return( (this->EnableCaching)?true:false);
     };


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


  vtkSetMacro( MaxLevel,int);


  vtkGetObjectMacro(CellDataArraySelection, vtkDataArraySelection);
  vtkGetObjectMacro(PointDataArraySelection, vtkDataArraySelection);


  int GetNumberOfPointArrays();
  int GetNumberOfCellArrays();


  const char* GetPointArrayName(int index);
  const char* GetCellArrayName(int index);


  int GetPointArrayStatus(const char* name);
  int GetCellArrayStatus(const char* name);
  void SetPointArrayStatus(const char* name, int status);
  void SetCellArrayStatus(const char* name, int status);


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

  virtual int GetNumberOfBlocks() = 0;

  virtual int GetNumberOfLevels() = 0;

protected:
  vtkAMRBaseReader();
  virtual ~vtkAMRBaseReader();

  // Desscription:
  // Checks if this reader instance is attached to a communicator
  // with more than one MPI processes.
  bool IsParallel();

  bool IsBlockMine( const int blockIdx );

  vtkUniformGrid* GetAMRBlock( const int blockIdx );

  void AssignAndLoadBlocks( vtkOverlappingAMR *amrds );

  void LoadRequestedBlocks( vtkOverlappingAMR *amrds );


  void GetAMRData(
    const int blockIdx, vtkUniformGrid *block, const char *fieldName );

  void LoadPointData( const int blockIdx, vtkUniformGrid *block );

  void LoadCellData( const int blockIdx, vtkUniformGrid *block );

  int GetBlockProcessId( const int blockIdx );

  void SetupBlockRequest( vtkInformation *outputInfo );

  virtual void ReadMetaData() = 0;

  virtual int GetBlockLevel( const int blockIdx ) = 0;

  virtual int FillMetaData( ) = 0;

  virtual vtkUniformGrid* GetAMRGrid( const int blockIdx ) = 0;


  virtual void GetAMRGridData(
      const int blockIdx, vtkUniformGrid *block, const char *field ) = 0;


 virtual int RequestData(
      vtkInformation* vtkNotUsed(request),
      vtkInformationVector** vtkNotUsed(inputVector),
      vtkInformationVector* outputVector );
  virtual int RequestInformation(
      vtkInformation* rqst,
      vtkInformationVector** inputVector,
      vtkInformationVector* outputVector );
  int FillOutputPortInformation(int port,vtkInformation *info);

  // Array selection member variables and methods
  vtkDataArraySelection *PointDataArraySelection;
  vtkDataArraySelection *CellDataArraySelection;
  vtkCallbackCommand    *SelectionObserver;

  void InitializeArraySelections();

  virtual void SetUpDataArraySelections() = 0;


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

  bool InitialRequest;
  int MaxLevel;
  char *FileName;
  vtkMultiProcessController *Controller;

  int EnableCaching;
  vtkAMRDataSetCache *Cache;
  int NumBlocksFromFile;
  int NumBlocksFromCache;

  vtkOverlappingAMR *Metadata;
  bool LoadedMetaData;


  //BTX
    std::vector<int> BlockMap;
  //ETX

private:
  vtkAMRBaseReader( const vtkAMRBaseReader& ); // Not implemented
  void operator=( const vtkAMRBaseReader& ); // Not implemented
};

#endif /* VTKAMRBASEREADER_H_ */