Read SPCTH Spy Plot file format. More...

#include <vtkSpyPlotUniReader.h>

Inheritance diagram for vtkSpyPlotUniReader:

Collaboration diagram for vtkSpyPlotUniReader:

[legend]

Classes
struct	CellMaterialField

struct	DataDump

struct	MarkerDump

struct	MarkerMaterialField

struct	MaterialMarker

struct	Variable

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

virtual int	ReadInformation ()
	Reads the basic information from the file such as the header, number of fields, etc. More...

int	MakeCurrent ()
	Make sure that actual data (including grid blocks) is current else it will read in the required data from file. More...

void	PrintInformation ()

void	PrintMemoryUsage ()

virtual int	GetNumberOfCellFields ()

double *	GetTimeArray ()

int	IsAMR ()
	Returns 1 if the grid information contained in the file has Adaptive Mesh Refinement (AMR) else it returns 0. More...

int	GetNumberOfDataBlocks ()
	Return the number of grids in the reader. More...

const char *	GetCellFieldName (int field)
	Return the name of the ith field. More...

vtkDataArray *	GetCellFieldData (int block, int field, int *fixed)
	Return the data array of the block's field. More...

vtkDataArray *	GetMaterialMassField (const int &block, const int &materialIndex)
	Return the mass data array for the material index passed in for the passed in block. More...

vtkDataArray *	GetMaterialVolumeFractionField (const int &block, const int &materialIndex)
	Return the volume fraction data array for the material index passed in for the passed in block. More...

int	MarkCellFieldDataFixed (int block, int field)
	Mark the block's field to have been fixed w/r bad ghost cells. More...

vtkFloatArray *	GetTracers ()
	Return the data array for the tracer positions. More...

vtkSpyPlotBlock *	GetBlock (int i)

int	GetNumberOfMaterials () const

int	GetNumberOfDimensions () const

int	GetCoordinateSystem () const

virtual void	SetGenerateMarkers (int)

virtual int	GetGenerateMarkers ()

virtual int	GetMarkersOn ()

vtkSpyPlotBlock *	GetDataBlock (int block)

virtual void	SetDataTypeChanged (int)

void	SetDownConvertVolumeFraction (int vf)


virtual void	SetFileName (const char *)
	Set and get the Binary SpyPlot File name the reader will process. More...

virtual char *	GetFileName ()
	Set and get the Binary SpyPlot File name the reader will process. More...

virtual void	SetCellArraySelection (vtkDataArraySelection *da)
	Set and get the Binary SpyPlot File name the reader will process. More...


int	SetCurrentTime (double time)
	Set and get the current time step to process. More...

virtual double	GetCurrentTime ()
	Set and get the current time step to process. More...

int	SetCurrentTimeStep (int timeStep)
	Set and get the current time step to process. More...

virtual int	GetCurrentTimeStep ()
	Set and get the current time step to process. More...


virtual int *	GetTimeStepRange ()
	Set and Get the time range for the simulation run. More...

virtual void	GetTimeStepRange (int &, int &)
	Set and Get the time range for the simulation run. More...

virtual void	GetTimeStepRange (int [2])
	Set and Get the time range for the simulation run. More...

virtual double *	GetTimeRange ()
	Set and Get the time range for the simulation run. More...

virtual void	GetTimeRange (double &, double &)
	Set and Get the time range for the simulation run. More...

virtual void	GetTimeRange (double [2])
	Set and Get the time range for the simulation run. More...


virtual void	SetNeedToCheck (int)


int	GetTimeStepFromTime (double time)
	Functions that map from time to time step and vice versa. More...

double	GetTimeFromTimeStep (int timeStep)
	Functions that map from time to time step and vice versa. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual vtkMTimeType	GetMTime ()

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkSpyPlotUniReader *	SafeDownCast (vtkObject *o)

static vtkSpyPlotUniReader *	New ()

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Public Attributes
MaterialMarker *	Markers

MarkerDump *	MarkersDumps

Protected Member Functions
	vtkSpyPlotUniReader ()

	~vtkSpyPlotUniReader () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkSpyPlotBlock *	Blocks

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Read SPCTH Spy Plot file format.

vtkSpyPlotUniReader is a reader that reads SPCTH Spy Plot file binary format that describes part of a dataset (in the case that the simulation consists of more than 1 file) or the entire simulation. The reader supports both Spy dataset types: flat mesh and AMR (Adaptive Mesh Refinement).

Implementation Details:: Class was extracted from vtkSpyPlotReader.cxx and is a helper to that class. Note the grids in the reader may have bad ghost cells that will need to be taken into consideration in terms of both geometry and
cell data

=============================================================================

Definition at line 36 of file vtkSpyPlotUniReader.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkSpyPlotUniReader::Superclass

Definition at line 39 of file vtkSpyPlotUniReader.h.

Constructor & Destructor Documentation

◆ vtkSpyPlotUniReader()

vtkSpyPlotUniReader::vtkSpyPlotUniReader ( )

protected

◆ ~vtkSpyPlotUniReader()

vtkSpyPlotUniReader::~vtkSpyPlotUniReader ( )

overrideprotected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkSpyPlotUniReader::GetClassName ( )

virtual

◆ IsTypeOf()

static int vtkSpyPlotUniReader::IsTypeOf ( const char * type )

static

◆ IsA()

virtual int vtkSpyPlotUniReader::IsA ( const char * type )

virtual

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkSpyPlotUniReader* vtkSpyPlotUniReader::SafeDownCast ( vtkObject * o )

static

◆ New()

static vtkSpyPlotUniReader* vtkSpyPlotUniReader::New ( )

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

◆ SetFileName()

virtual void vtkSpyPlotUniReader::SetFileName ( const char * )

virtual

Set and get the Binary SpyPlot File name the reader will process.

◆ GetFileName()

virtual char* vtkSpyPlotUniReader::GetFileName ( )

virtual

Set and get the Binary SpyPlot File name the reader will process.

◆ SetCellArraySelection()

virtual void vtkSpyPlotUniReader::SetCellArraySelection ( vtkDataArraySelection * da )

virtual

Set and get the Binary SpyPlot File name the reader will process.

◆ ReadInformation()

virtual int vtkSpyPlotUniReader::ReadInformation ( )

virtual

Reads the basic information from the file such as the header, number of fields, etc.

◆ MakeCurrent()

int vtkSpyPlotUniReader::MakeCurrent ( )

Make sure that actual data (including grid blocks) is current else it will read in the required data from file.

◆ PrintInformation()

void vtkSpyPlotUniReader::PrintInformation ( )

◆ PrintMemoryUsage()

void vtkSpyPlotUniReader::PrintMemoryUsage ( )

◆ SetCurrentTime()

int vtkSpyPlotUniReader::SetCurrentTime ( double time )

Set and get the current time step to process.

◆ GetCurrentTime()

virtual double vtkSpyPlotUniReader::GetCurrentTime ( )

virtual

Set and get the current time step to process.

◆ SetCurrentTimeStep()

int vtkSpyPlotUniReader::SetCurrentTimeStep ( int timeStep )

Set and get the current time step to process.

◆ GetCurrentTimeStep()

virtual int vtkSpyPlotUniReader::GetCurrentTimeStep ( )

virtual

Set and get the current time step to process.