Read SPCTH Spy Plot file format. More...

#include <vtkSpyPlotReader.h>

Inheritance diagram for vtkSpyPlotReader:

Collaboration diagram for vtkSpyPlotReader:

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	PrintBlockList (vtkNonOverlappingAMR *hbds, int myProcId)
void	SetGlobalController (vtkMultiProcessController *controller)
virtual int	CanReadFile (const char *fname)

virtual void	SetFileName (const char *filename)
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 ()

virtual void	SetGenerateActiveBlockArray (int)
virtual int	GetGenerateActiveBlockArray ()
virtual void	GenerateActiveBlockArrayOn ()
virtual void	GenerateActiveBlockArrayOff ()

virtual void	SetGenerateTracerArray (int)
virtual int	GetGenerateTracerArray ()
virtual void	GenerateTracerArrayOn ()
virtual void	GenerateTracerArrayOff ()

void	SetDownConvertVolumeFraction (int vf)
virtual int	GetDownConvertVolumeFraction ()
virtual void	DownConvertVolumeFractionOn ()
virtual void	DownConvertVolumeFractionOff ()

virtual void	SetComputeDerivedVariables (int)
virtual int	GetComputeDerivedVariables ()
virtual void	ComputeDerivedVariablesOn ()
virtual void	ComputeDerivedVariablesOff ()

void	SetMergeXYZComponents (int merge)
virtual int	GetMergeXYZComponents ()
virtual void	MergeXYZComponentsOn ()
virtual void	MergeXYZComponentsOff ()

virtual int *	GetTimeStepRange ()
virtual void	GetTimeStepRange (int &, int &)
virtual void	GetTimeStepRange (int[2])

int	GetNumberOfCellArrays ()
const char *	GetCellArrayName (int idx)
int	GetCellArrayStatus (const char *name)
void	SetCellArrayStatus (const char *name, int status)
Static Public Member Functions
static vtkSpyPlotReader *	New ()
static int	IsTypeOf (const char *type)
static vtkSpyPlotReader *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkSpyPlotReader ()
	~vtkSpyPlotReader ()
void	GetLocalBounds (vtkSpyPlotBlockIterator *biter, int nBlocks, int progressInterval)
void	SetGlobalBounds (vtkSpyPlotBlockIterator biter, int total_num_of_block, int progressInterval, int rightHasBounds, int *leftHasBounds)
bool	GetLocalBoxSize (vtkSpyPlotBlockIterator biter, int localBoxSize) const
void	SetGlobalBoxSize (vtkSpyPlotBlockIterator *biter)
void	GetLocalMinLevelAndSpacing (vtkSpyPlotBlockIterator biter, int localMinLevel, double spacing[3]) const
void	SetGlobalMinLevelAndSpacing (vtkSpyPlotBlockIterator *biter)
int	PrepareAMRData (vtkNonOverlappingAMR hb, vtkSpyPlotBlock block, int level, int extents[6], int realExtents[6], int realDims[3], vtkCellData *cd)
int	PrepareData (vtkMultiBlockDataSet hb, vtkSpyPlotBlock block, vtkRectilinearGrid rg, int extents[6], int realExtents[6], int realDims[3], vtkCellData cd)
void	UpdateFieldData (int numFields, int dims[3], int level, int blockID, vtkSpyPlotUniReader uniReader, vtkCellData cd)
void	UpdateBadGhostFieldData (int numFields, int dims[3], int realDims[3], int realExtents[6], int level, int blockID, vtkSpyPlotUniReader uniReader, vtkCellData cd)
virtual int	RequestDataObject (vtkInformation req, vtkInformationVector inV, vtkInformationVector outV)
virtual int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
virtual int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
int	UpdateFile (vtkInformation request, vtkInformationVector outputVector)
void	AddGhostLevelArray (int numLevels)
int	AddBlockIdArray (vtkCompositeDataSet *cds)
int	AddAttributes (vtkNonOverlappingAMR *hbds)
int	AddActiveBlockArray (vtkCellData *cd, vtkIdType nCells, unsigned char status)
void	SetGlobalLevels (vtkCompositeDataSet *cds)
void	MergeVectors (vtkDataSetAttributes *da)
int	MergeVectors (vtkDataSetAttributes da, vtkDataArray a1, vtkDataArray *a2)
int	MergeVectors (vtkDataSetAttributes da, vtkDataArray a1, vtkDataArray a2, vtkDataArray a3)
int	ComputeDerivedVars (vtkCellData data, vtkSpyPlotBlock block, vtkSpyPlotUniReader *reader, const int &blockID)

int	UpdateMetaData (vtkInformation request, vtkInformationVector outputVector)

int	UpdateTimeStep (vtkInformation requestInfo, vtkInformationVector outputInfo, vtkCompositeDataSet *hb)

virtual vtkDataArraySelection *	GetCellDataArraySelection ()
Protected Attributes
vtkDataArraySelection *	CellDataArraySelection
char *	FileName
int	TimeStep
int	TimeStepRange [2]
int	CurrentTimeStep
int	IsAMR
vtkMultiProcessController *	GlobalController
int	ComputeDerivedVariables
vtkSpyPlotReaderMap *	Map
int	DistributeFiles
vtkBoundingBox *	Bounds
int	BoxSize [3]
int	MinLevel
double	MinLevelSpacing [3]
int	GenerateLevelArray
int	GenerateBlockIdArray
int	GenerateActiveBlockArray
int	GenerateTracerArray
int	DownConvertVolumeFraction
bool	TimeRequestedFromPipeline
int	MergeXYZComponents
bool	FileNameChanged
Friends
class	vtkSpyPlotReaderMap

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 72 of file vtkSpyPlotReader.h.

Constructor & Destructor Documentation

vtkSpyPlotReader::vtkSpyPlotReader ( ) [protected]

vtkSpyPlotReader::~vtkSpyPlotReader ( ) [protected]

Member Function Documentation

static vtkSpyPlotReader* vtkSpyPlotReader::New ( ) [static]

Reimplemented from vtkCompositeDataSetAlgorithm.

virtual const char* vtkSpyPlotReader::GetClassName ( ) [virtual]

Reimplemented from vtkCompositeDataSetAlgorithm.

static int vtkSpyPlotReader::IsTypeOf ( const char * type ) [static]

Reimplemented from vtkCompositeDataSetAlgorithm.

virtual int vtkSpyPlotReader::IsA ( const char * type ) [virtual]

Reimplemented from vtkCompositeDataSetAlgorithm.

static vtkSpyPlotReader* vtkSpyPlotReader::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkCompositeDataSetAlgorithm.

void vtkSpyPlotReader::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

Reimplemented from vtkCompositeDataSetAlgorithm.

void vtkSpyPlotReader::PrintBlockList	(	vtkNonOverlappingAMR *	hbds,
		int	myProcId
	)

virtual void vtkSpyPlotReader::SetFileName ( const char * filename ) [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.

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

If true, the reader generate a cell array in each block that corresponds to the Active field in the file. False by default.

virtual int vtkSpyPlotReader::GetGenerateActiveBlockArray ( ) [virtual]

If true, the reader generate a cell array in each block that corresponds to the Active field in the file. False by default.

virtual void vtkSpyPlotReader::GenerateActiveBlockArrayOn ( ) [virtual]

If true, the reader generate a cell array in each block that corresponds to the Active field in the file. False by default.

virtual void vtkSpyPlotReader::GenerateActiveBlockArrayOff ( ) [virtual]

If true, the reader generate a cell array in each block that corresponds to the Active field in the file. False by default.

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

If true, the reader will extract tracer data at each time step and include a field data array for the tracers at that time.

virtual int vtkSpyPlotReader::GetGenerateTracerArray ( ) [virtual]

If true, the reader will extract tracer data at each time step and include a field data array for the tracers at that time.

virtual void vtkSpyPlotReader::GenerateTracerArrayOn ( ) [virtual]

If true, the reader will extract tracer data at each time step and include a field data array for the tracers at that time.

virtual void vtkSpyPlotReader::GenerateTracerArrayOff ( ) [virtual]

If true, the reader will extract tracer data at each time step and include a field data array for the tracers at that time.

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 void vtkSpyPlotReader::SetComputeDerivedVariables ( int ) [virtual]

If true, the reader will calculate all derived variables it can given which properties the user has selected True by default.

virtual int vtkSpyPlotReader::GetComputeDerivedVariables ( ) [virtual]

If true, the reader will calculate all derived variables it can given which properties the user has selected True by default.

virtual void vtkSpyPlotReader::ComputeDerivedVariablesOn ( ) [virtual]

If true, the reader will calculate all derived variables it can given which properties the user has selected True by default.

virtual void vtkSpyPlotReader::ComputeDerivedVariablesOff ( ) [virtual]

If true, the reader will calculate all derived variables it can given which properties the user has selected True by default.

void vtkSpyPlotReader::SetMergeXYZComponents ( int merge )

If true, the reader will merge scalar arrays named, for example, "X velocity" "Y velocity" and "Z velocity" into a vector array named "velocity" with scalar components X, Y and Z. It will also merge X and Y scalar arrays (with no Z component) into a vector with scalar components X, Y and 0. True by default.

virtual int vtkSpyPlotReader::GetMergeXYZComponents ( ) [virtual]

If true, the reader will merge scalar arrays named, for example, "X velocity" "Y velocity" and "Z velocity" into a vector array named "velocity" with scalar components X, Y and Z. It will also merge X and Y scalar arrays (with no Z component) into a vector with scalar components X, Y and 0. True by default.

virtual void vtkSpyPlotReader::MergeXYZComponentsOn ( ) [virtual]

If true, the reader will merge scalar arrays named, for example, "X velocity" "Y velocity" and "Z velocity" into a vector array named "velocity" with scalar components X, Y and Z. It will also merge X and Y scalar arrays (with no Z component) into a vector with scalar components X, Y and 0. True by default.

virtual void vtkSpyPlotReader::MergeXYZComponentsOff ( ) [virtual]

If true, the reader will merge scalar arrays named, for example, "X velocity" "Y velocity" and "Z velocity" into a vector array named "velocity" with scalar components X, Y and Z. It will also merge X and Y scalar arrays (with no Z component) into a vector with scalar components X, Y and 0. 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.

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::SetGlobalController ( vtkMultiProcessController * controller )

Set the controller used to coordinate parallel reading. The "global controller" has all processes while the "controller" has only those who have blocks.

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

Determine if the file can be readed with this reader.

void vtkSpyPlotReader::GetLocalBounds	(	vtkSpyPlotBlockIterator *	biter,
		int	nBlocks,
		int	progressInterval
	)		`[protected]`

void vtkSpyPlotReader::SetGlobalBounds	(	vtkSpyPlotBlockIterator *	biter,
		int	total_num_of_block,
		int	progressInterval,
		int *	rightHasBounds,
		int *	leftHasBounds
	)		`[protected]`

bool vtkSpyPlotReader::GetLocalBoxSize	(	vtkSpyPlotBlockIterator *	biter,
		int *	localBoxSize
	)		const `[protected]`

void vtkSpyPlotReader::SetGlobalBoxSize ( vtkSpyPlotBlockIterator * biter ) [protected]

void vtkSpyPlotReader::GetLocalMinLevelAndSpacing	(	vtkSpyPlotBlockIterator *	biter,
		int *	localMinLevel,
		double	spacing[3]
	)		const `[protected]`

void vtkSpyPlotReader::SetGlobalMinLevelAndSpacing ( vtkSpyPlotBlockIterator * biter ) [protected]

int vtkSpyPlotReader::PrepareAMRData	(	vtkNonOverlappingAMR *	hb,
		vtkSpyPlotBlock *	block,
		int *	level,
		int	extents[6],
		int	realExtents[6],
		int	realDims[3],
		vtkCellData **	cd
	)		`[protected]`

int vtkSpyPlotReader::PrepareData	(	vtkMultiBlockDataSet *	hb,
		vtkSpyPlotBlock *	block,
		vtkRectilinearGrid **	rg,
		int	extents[6],
		int	realExtents[6],
		int	realDims[3],
		vtkCellData **	cd
	)		`[protected]`

void vtkSpyPlotReader::UpdateFieldData	(	int	numFields,
		int	dims[3],
		int	level,
		int	blockID,
		vtkSpyPlotUniReader *	uniReader,
		vtkCellData *	cd
	)		`[protected]`

void vtkSpyPlotReader::UpdateBadGhostFieldData	(	int	numFields,
		int	dims[3],
		int	realDims[3],
		int	realExtents[6],
		int	level,
		int	blockID,
		vtkSpyPlotUniReader *	uniReader,
		vtkCellData *	cd
	)		`[protected]`

virtual int vtkSpyPlotReader::RequestDataObject	(	vtkInformation *	req,
		vtkInformationVector **	inV,
		vtkInformationVector *	outV
	)		`[protected, virtual]`

Reimplemented from vtkCompositeDataSetAlgorithm.

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

Reimplemented from vtkCompositeDataSetAlgorithm.

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

Reimplemented from vtkCompositeDataSetAlgorithm.

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::UpdateFile	(	vtkInformation *	request,
		vtkInformationVector *	outputVector
	)		`[protected]`

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

int vtkSpyPlotReader::AddBlockIdArray ( vtkCompositeDataSet * cds ) [protected]

int vtkSpyPlotReader::AddAttributes ( vtkNonOverlappingAMR * hbds ) [protected]

int vtkSpyPlotReader::AddActiveBlockArray	(	vtkCellData *	cd,
		vtkIdType	nCells,
		unsigned char	status
	)		`[protected]`

void vtkSpyPlotReader::SetGlobalLevels ( vtkCompositeDataSet * cds ) [protected]

int vtkSpyPlotReader::UpdateTimeStep	(	vtkInformation *	requestInfo,
		vtkInformationVector *	outputInfo,
		vtkCompositeDataSet *	hb
	)		`[protected]`

Set the current time step.

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::ComputeDerivedVars	(	vtkCellData *	data,
		vtkSpyPlotBlock *	block,
		vtkSpyPlotUniReader *	reader,
		const int &	blockID
	)		`[protected]`