vtkSpyPlotReader Class Reference

Read SPCTH Spy Plot file format. More...

#include <vtkSpyPlotReader.h>

List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkSpyPlotReader, vtkHierarchicalDataSetAlgorithm)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetController (vtkMultiProcessController *controller)
virtual vtkMultiProcessController *	GetController ()
virtual int	CanReadFile (const char *fname)
virtual void	SetFileName (const char *)
virtual char *	GetFileName ()
virtual void	SetTimeStep (int)
virtual int	GetTimeStep ()
virtual void	SetDistributeFiles (int)
virtual int	GetDistributeFiles ()
virtual void	DistributeFilesOn ()
virtual void	DistributeFilesOff ()
virtual void	SetGenerateLevelArray (int)
virtual int	GetGenerateLevelArray ()
virtual void	GenerateLevelArrayOn ()
virtual void	GenerateLevelArrayOff ()
virtual void	SetGenerateBlockIdArray (int)
virtual int	GetGenerateBlockIdArray ()
virtual void	GenerateBlockIdArrayOn ()
virtual void	GenerateBlockIdArrayOff ()
void	SetDownConvertVolumeFraction (int vf)
virtual int	GetDownConvertVolumeFraction ()
virtual void	DownConvertVolumeFractionOn ()
virtual void	DownConvertVolumeFractionOff ()
virtual int *	GetTimeStepRange ()
virtual void	GetTimeStepRange (int &, int &)
virtual void	GetTimeStepRange (int[2])
virtual vtkDataArraySelection *	GetCellDataArraySelection ()
int	GetNumberOfCellArrays ()
const char *	GetCellArrayName (int idx)
int	GetCellArrayStatus (const char *name)
void	SetCellArrayStatus (const char *name, int status)
Static Public Member Functions
vtkSpyPlotReader *	New ()
Protected Member Functions
	vtkSpyPlotReader ()
	~vtkSpyPlotReader ()
virtual int	RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
void	AddGhostLevelArray (int numLevels)
void	MergeVectors (vtkDataSetAttributes *da)
int	MergeVectors (vtkDataSetAttributes *da, vtkDataArray *a1, vtkDataArray *a2)
int	MergeVectors (vtkDataSetAttributes *da, vtkDataArray *a1, vtkDataArray *a2, vtkDataArray *a3)
int	UpdateMetaData (vtkInformation *request, vtkInformationVector *outputVector)
int	UpdateCaseFile (const char *fname, vtkInformation *request, vtkInformationVector *outputVector)
int	UpdateNoCaseFile (const char *ext, vtkInformation *request, vtkInformationVector *outputVector)
virtual void	SetCurrentFileName (const char *)
virtual char *	GetCurrentFileName ()
int	GetParentProcessor (int proc)
int	GetLeftChildProcessor (int proc)
Static Protected Member Functions
void	SelectionModifiedCallback (vtkObject *caller, unsigned long eid, void *clientdata, void *calldata)
Protected Attributes
vtkDataArraySelection *	CellDataArraySelection
vtkCallbackCommand *	SelectionObserver
char *	FileName
char *	CurrentFileName
int	TimeStep
int	TimeStepRange [2]
int	CurrentTimeStep
int	IsAMR
vtkMultiProcessController *	Controller
vtkSpyPlotReaderMap *	Map
int	DistributeFiles
double	Bounds [6]
int	GenerateLevelArray
int	GenerateBlockIdArray
int	DownConvertVolumeFraction

---

Detailed Description

Read SPCTH Spy Plot file format.

vtkSpyPlotReader is a reader that reads SPCTH Spy Plot file format through an ascii meta file called the "case" file (extension .spcth). This case file lists all the actual binary files that describe a dataset. Each binary file describes a part of the dataset. However, if only a single binary file describes the whole dataset, it is possible to load it directly without using a case file.

The reader supports both Spy dataset types: flat mesh and AMR (Adaptive Mesh Refinement).

It has parallel capabilities. Each processor is supposed to have access to the case file and to all the binary files. All the binary files have to be coherent: they describe the same fields of data. Each binary file may content multiple time stamp. The time stamp to read is specified with SetTimestamp().

In parallel mode, there are two ways to distribute data over processors (controlled by SetDistributeFiles() ):

• either by distributing blocks: all processors read all the files, but only some number of blocks per files. Hence, load balancing is good even if there is only one file.
• or by distributing files: a file is read entirely by one processor. If there is only one file, all the other processors are not used at all.

Implementation Details:

• All processors read the first binary file listed in the case file to get informations about the fields.
• Each block of data is already surrounded by ghost cells in the file, even on part of the block that don't have actual neighbor cells. The reader removes those wrong ghost cells.
• Each time step contains all the cell array name variables

Definition at line 63 of file vtkSpyPlotReader.h.

---

Constructor & Destructor Documentation

vtkSpyPlotReader::vtkSpyPlotReader (   )  [protected]

vtkSpyPlotReader::~vtkSpyPlotReader (   )  [protected]

---

Member Function Documentation

vtkSpyPlotReader* vtkSpyPlotReader::New (   )  [static]

vtkSpyPlotReader::vtkTypeRevisionMacro (  vtkSpyPlotReader  , vtkHierarchicalDataSetAlgorithm  )

void vtkSpyPlotReader::PrintSelf (  ostream &  os, vtkIndent  indent )

virtual void vtkSpyPlotReader::SetFileName (  const char *   )  [virtual]

Get and set the file name. It is either the name of the case file or the name of the single binary file.

virtual char* vtkSpyPlotReader::GetFileName (   )  [virtual]

Get and set the file name. It is either the name of the case file or the name of the single binary file.

virtual void vtkSpyPlotReader::SetTimeStep (  int   )  [virtual]

Set and get the time step. The time step is an index, NOT a time given in seconds.

virtual int vtkSpyPlotReader::GetTimeStep (   )  [virtual]

Set and get the time step. The time step is an index, NOT a time given in seconds.

virtual void vtkSpyPlotReader::SetDistributeFiles (  int   )  [virtual]

If true, the reader distributes files over processors. If false, the reader distributes blocks over processors. Default is false. Distributing blocks should provide a better load balancing: if there is only one file and several processors, only the first processor is used in the case of the file-distributed method.

virtual int vtkSpyPlotReader::GetDistributeFiles (   )  [virtual]

If true, the reader distributes files over processors. If false, the reader distributes blocks over processors. Default is false. Distributing blocks should provide a better load balancing: if there is only one file and several processors, only the first processor is used in the case of the file-distributed method.

virtual void vtkSpyPlotReader::DistributeFilesOn (   )  [virtual]

If true, the reader distributes files over processors. If false, the reader distributes blocks over processors. Default is false. Distributing blocks should provide a better load balancing: if there is only one file and several processors, only the first processor is used in the case of the file-distributed method.

virtual void vtkSpyPlotReader::DistributeFilesOff (   )  [virtual]

If true, the reader distributes files over processors. If false, the reader distributes blocks over processors. Default is false. Distributing blocks should provide a better load balancing: if there is only one file and several processors, only the first processor is used in the case of the file-distributed method.

virtual void vtkSpyPlotReader::SetGenerateLevelArray (  int   )  [virtual]

If true, the reader generate a cell array in each block that stores the level in the hierarchy, starting from 0. False by default.

virtual int vtkSpyPlotReader::GetGenerateLevelArray (   )  [virtual]

If true, the reader generate a cell array in each block that stores the level in the hierarchy, starting from 0. False by default.

virtual void vtkSpyPlotReader::GenerateLevelArrayOn (   )  [virtual]

If true, the reader generate a cell array in each block that stores the level in the hierarchy, starting from 0. False by default.

virtual void vtkSpyPlotReader::GenerateLevelArrayOff (   )  [virtual]

If true, the reader generate a cell array in each block that stores the level in the hierarchy, starting from 0. False by default.

virtual void vtkSpyPlotReader::SetGenerateBlockIdArray (  int   )  [virtual]

If true, the reader generate a cell array in each block that stores a unique but not necessarily contiguous id. False by default.

virtual int vtkSpyPlotReader::GetGenerateBlockIdArray (   )  [virtual]

If true, the reader generate a cell array in each block that stores a unique but not necessarily contiguous id. False by default.

virtual void vtkSpyPlotReader::GenerateBlockIdArrayOn (   )  [virtual]

If true, the reader generate a cell array in each block that stores a unique but not necessarily contiguous id. False by default.

virtual void vtkSpyPlotReader::GenerateBlockIdArrayOff (   )  [virtual]

If true, the reader generate a cell array in each block that stores a unique but not necessarily contiguous id. False by default.

void vtkSpyPlotReader::SetDownConvertVolumeFraction (  int  vf  )

If true, the reader will convert volume fraction arrays to unsigned char. True by default.

virtual int vtkSpyPlotReader::GetDownConvertVolumeFraction (   )  [virtual]

If true, the reader will convert volume fraction arrays to unsigned char. True by default.

virtual void vtkSpyPlotReader::DownConvertVolumeFractionOn (   )  [virtual]

If true, the reader will convert volume fraction arrays to unsigned char. True by default.

virtual void vtkSpyPlotReader::DownConvertVolumeFractionOff (   )  [virtual]

If true, the reader will convert volume fraction arrays to unsigned char. True by default.

virtual int* vtkSpyPlotReader::GetTimeStepRange (   )  [virtual]

Get the time step range.

virtual void vtkSpyPlotReader::GetTimeStepRange (  int &  , int &  )  [virtual]

Get the time step range.

virtual void vtkSpyPlotReader::GetTimeStepRange (  int  [2]  )  [virtual]

Get the time step range.

virtual vtkDataArraySelection* vtkSpyPlotReader::GetCellDataArraySelection (   )  [virtual]

Get the data array selection tables used to configure which data arrays are loaded by the reader.

int vtkSpyPlotReader::GetNumberOfCellArrays (   )

Cell array selection

const char* vtkSpyPlotReader::GetCellArrayName (  int  idx  )

Cell array selection

int vtkSpyPlotReader::GetCellArrayStatus (  const char *  name  )

Cell array selection

void vtkSpyPlotReader::SetCellArrayStatus (  const char *  name, int  status )

Cell array selection

void vtkSpyPlotReader::SetController (  vtkMultiProcessController *  controller  )

Set the controller used to coordinate parallel reading.

virtual vtkMultiProcessController* vtkSpyPlotReader::GetController (   )  [virtual]

virtual int vtkSpyPlotReader::CanReadFile (  const char *  fname  )  [virtual]

Determine if the file can be readed with this reader.

virtual int vtkSpyPlotReader::RequestInformation (  vtkInformation *  request, vtkInformationVector **  inputVector, vtkInformationVector *  outputVector )  [protected, virtual]

virtual int vtkSpyPlotReader::RequestData (  vtkInformation *  request, vtkInformationVector **  inputVector, vtkInformationVector *  outputVector )  [protected, virtual]

void vtkSpyPlotReader::SelectionModifiedCallback (  vtkObject *  caller, unsigned long  eid, void *  clientdata, void *  calldata )  [static, protected]

int vtkSpyPlotReader::UpdateMetaData (  vtkInformation *  request, vtkInformationVector *  outputVector )  [protected]

This does the updating of meta data of the dataset from the first binary file registered in the map: - number of time steps - number of fields - name of fields

int vtkSpyPlotReader::UpdateCaseFile (  const char *  fname, vtkInformation *  request, vtkInformationVector *  outputVector )  [protected]

This does the updating of the meta data of the case file

int vtkSpyPlotReader::UpdateNoCaseFile (  const char *  ext, vtkInformation *  request, vtkInformationVector *  outputVector )  [protected]

This does the updating of the meta data for a series, when no case file provided

void vtkSpyPlotReader::AddGhostLevelArray (  int  numLevels  )  [protected]

virtual void vtkSpyPlotReader::SetCurrentFileName (  const char *   )  [protected, virtual]

Get and set the current file name. Protected because this method should only be used internally

virtual char* vtkSpyPlotReader::GetCurrentFileName (   )  [protected, virtual]

Get and set the current file name. Protected because this method should only be used internally

void vtkSpyPlotReader::MergeVectors (  vtkDataSetAttributes *  da  )  [protected]

int vtkSpyPlotReader::MergeVectors (  vtkDataSetAttributes *  da, vtkDataArray *  a1, vtkDataArray *  a2 )  [protected]

int vtkSpyPlotReader::MergeVectors (  vtkDataSetAttributes *  da, vtkDataArray *  a1, vtkDataArray *  a2, vtkDataArray *  a3 )  [protected]

int vtkSpyPlotReader::GetParentProcessor (  int  proc  )  [protected]

The processors are views as a heap tree. The root is the processor of id 0.

int vtkSpyPlotReader::GetLeftChildProcessor (  int  proc  )  [protected]

The processors are views as a heap tree. The root is the processor of id 0.

---

Member Data Documentation

vtkDataArraySelection* vtkSpyPlotReader::CellDataArraySelection [protected]

Definition at line 153 of file vtkSpyPlotReader.h.

vtkCallbackCommand* vtkSpyPlotReader::SelectionObserver [protected]

Definition at line 205 of file vtkSpyPlotReader.h.

char* vtkSpyPlotReader::FileName [protected]

Definition at line 206 of file vtkSpyPlotReader.h.

char* vtkSpyPlotReader::CurrentFileName [protected]

Definition at line 207 of file vtkSpyPlotReader.h.

int vtkSpyPlotReader::TimeStep [protected]

Definition at line 208 of file vtkSpyPlotReader.h.

int vtkSpyPlotReader::TimeStepRange[2] [protected]

Definition at line 209 of file vtkSpyPlotReader.h.

int vtkSpyPlotReader::CurrentTimeStep [protected]

Definition at line 210 of file vtkSpyPlotReader.h.

int vtkSpyPlotReader::IsAMR [protected]

Definition at line 212 of file vtkSpyPlotReader.h.

vtkMultiProcessController* vtkSpyPlotReader::Controller [protected]

Definition at line 215 of file vtkSpyPlotReader.h.

vtkSpyPlotReaderMap* vtkSpyPlotReader::Map [protected]

Definition at line 229 of file vtkSpyPlotReader.h.

int vtkSpyPlotReader::DistributeFiles [protected]

Definition at line 238 of file vtkSpyPlotReader.h.

double vtkSpyPlotReader::Bounds[6] [protected]

Definition at line 240 of file vtkSpyPlotReader.h.

int vtkSpyPlotReader::GenerateLevelArray [protected]

Definition at line 242 of file vtkSpyPlotReader.h.

int vtkSpyPlotReader::GenerateBlockIdArray [protected]

Definition at line 243 of file vtkSpyPlotReader.h.

int vtkSpyPlotReader::DownConvertVolumeFraction [protected]

Definition at line 245 of file vtkSpyPlotReader.h.

---

The documentation for this class was generated from the following file:

• Servers/Filters/vtkSpyPlotReader.h

---