ParaView
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
vtkSpyPlotUniReader Class Reference

Read SPCTH Spy Plot file format. More...

#include <vtkSpyPlotUniReader.h>

Inherits vtkObject.

Collaboration diagram for vtkSpyPlotUniReader:
Collaboration graph
[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)
 
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...
 
vtkSpyPlotBlockGetBlock (int i)
 
int GetNumberOfMaterials () const
 
int GetNumberOfDimensions () const
 
int GetCoordinateSystem () const
 
virtual void SetGenerateMarkers (int)
 
virtual int GetGenerateMarkers ()
 
virtual int GetMarkersOn ()
 
vtkSpyPlotBlockGetDataBlock (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...
 
int SetCurrentTimeStep (int timeStep)
 Set and get the current time step to process. More...
 
virtual double GetCurrentTime ()
 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...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkSpyPlotUniReaderSafeDownCast (vtkObject *o)
 
static vtkSpyPlotUniReaderNew ()
 

Public Attributes

MaterialMarkerMarkers
 
MarkerDumpMarkersDumps
 

Protected Member Functions

 vtkSpyPlotUniReader ()
 
 ~vtkSpyPlotUniReader ()
 

Protected Attributes

vtkSpyPlotBlockBlocks
 

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 47 of file vtkSpyPlotUniReader.h.

Member Typedef Documentation

§ Superclass

Definition at line 50 of file vtkSpyPlotUniReader.h.

Constructor & Destructor Documentation

§ vtkSpyPlotUniReader()

vtkSpyPlotUniReader::vtkSpyPlotUniReader ( )
protected

§ ~vtkSpyPlotUniReader()

vtkSpyPlotUniReader::~vtkSpyPlotUniReader ( )
protected

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

§ SafeDownCast()

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

§ New()

static vtkSpyPlotUniReader* vtkSpyPlotUniReader::New ( )
static

§ PrintSelf()

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

§ 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.

§ SetCurrentTimeStep()

int vtkSpyPlotUniReader::SetCurrentTimeStep ( int  timeStep)

Set and get the current time step to process.

§ GetCurrentTime()

virtual double vtkSpyPlotUniReader::GetCurrentTime ( )
virtual

Set and get the current time step to process.

§ GetCurrentTimeStep()

virtual int vtkSpyPlotUniReader::GetCurrentTimeStep ( )
virtual

Set and get the current time step to process.

§ GetTimeStepRange() [1/3]

virtual int* vtkSpyPlotUniReader::GetTimeStepRange ( )
virtual

Set and Get the time range for the simulation run.

§ GetTimeStepRange() [2/3]

virtual void vtkSpyPlotUniReader::GetTimeStepRange ( int &  ,
int &   
)
virtual

Set and Get the time range for the simulation run.

§ GetTimeStepRange() [3/3]

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

Set and Get the time range for the simulation run.

§ GetTimeRange() [1/3]

virtual double* vtkSpyPlotUniReader::GetTimeRange ( )
virtual

Set and Get the time range for the simulation run.

§ GetTimeRange() [2/3]

virtual void vtkSpyPlotUniReader::GetTimeRange ( double &  ,
double &   
)
virtual

Set and Get the time range for the simulation run.

§ GetTimeRange() [3/3]

virtual void vtkSpyPlotUniReader::GetTimeRange ( double  [2])
virtual

Set and Get the time range for the simulation run.

§ SetNeedToCheck()

virtual void vtkSpyPlotUniReader::SetNeedToCheck ( int  )
virtual

§ GetTimeStepFromTime()

int vtkSpyPlotUniReader::GetTimeStepFromTime ( double  time)

Functions that map from time to time step and vice versa.

§ GetTimeFromTimeStep()

double vtkSpyPlotUniReader::GetTimeFromTimeStep ( int  timeStep)

Functions that map from time to time step and vice versa.

§ GetNumberOfCellFields()

virtual int vtkSpyPlotUniReader::GetNumberOfCellFields ( )
virtual

§ GetTimeArray()

double * vtkSpyPlotUniReader::GetTimeArray ( )
inline

Definition at line 322 of file vtkSpyPlotUniReader.h.

§ IsAMR()

int vtkSpyPlotUniReader::IsAMR ( )
inline

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

Definition at line 327 of file vtkSpyPlotUniReader.h.

§ GetNumberOfDataBlocks()

int vtkSpyPlotUniReader::GetNumberOfDataBlocks ( )

Return the number of grids in the reader.

§ GetCellFieldName()

const char* vtkSpyPlotUniReader::GetCellFieldName ( int  field)

Return the name of the ith field.

§ GetCellFieldData()

vtkDataArray* vtkSpyPlotUniReader::GetCellFieldData ( int  block,
int  field,
int *  fixed 
)

Return the data array of the block's field.

The "fixed" arguement is set to 1 if the array has been corrected for bad ghost cells else it is set to 0

§ GetMaterialMassField()

vtkDataArray* vtkSpyPlotUniReader::GetMaterialMassField ( const int &  block,
const int &  materialIndex 
)

Return the mass data array for the material index passed in for the passed in block.

§ GetMaterialVolumeFractionField()

vtkDataArray* vtkSpyPlotUniReader::GetMaterialVolumeFractionField ( const int &  block,
const int &  materialIndex 
)

Return the volume fraction data array for the material index passed in for the passed in block.

§ MarkCellFieldDataFixed()

int vtkSpyPlotUniReader::MarkCellFieldDataFixed ( int  block,
int  field 
)

Mark the block's field to have been fixed w/r bad ghost cells.

§ GetTracers()

vtkFloatArray* vtkSpyPlotUniReader::GetTracers ( )

Return the data array for the tracer positions.

§ GetBlock()

vtkSpyPlotBlock* vtkSpyPlotUniReader::GetBlock ( int  i)

§ GetNumberOfMaterials()

int vtkSpyPlotUniReader::GetNumberOfMaterials ( ) const
inline

Definition at line 161 of file vtkSpyPlotUniReader.h.

§ GetNumberOfDimensions()

int vtkSpyPlotUniReader::GetNumberOfDimensions ( ) const
inline

Definition at line 164 of file vtkSpyPlotUniReader.h.

§ GetCoordinateSystem()

int vtkSpyPlotUniReader::GetCoordinateSystem ( ) const
inline

Definition at line 167 of file vtkSpyPlotUniReader.h.

§ SetGenerateMarkers()

virtual void vtkSpyPlotUniReader::SetGenerateMarkers ( int  )
virtual

§ GetGenerateMarkers()

virtual int vtkSpyPlotUniReader::GetGenerateMarkers ( )
virtual

§ GetMarkersOn()

virtual int vtkSpyPlotUniReader::GetMarkersOn ( )
virtual

§ GetDataBlock()

vtkSpyPlotBlock* vtkSpyPlotUniReader::GetDataBlock ( int  block)

§ SetDataTypeChanged()

virtual void vtkSpyPlotUniReader::SetDataTypeChanged ( int  )
virtual

§ SetDownConvertVolumeFraction()

void vtkSpyPlotUniReader::SetDownConvertVolumeFraction ( int  vf)

Member Data Documentation

§ Markers

MaterialMarker* vtkSpyPlotUniReader::Markers

Definition at line 222 of file vtkSpyPlotUniReader.h.

§ MarkersDumps

MarkerDump* vtkSpyPlotUniReader::MarkersDumps

Definition at line 223 of file vtkSpyPlotUniReader.h.

§ Blocks

vtkSpyPlotBlock* vtkSpyPlotUniReader::Blocks
protected

Definition at line 237 of file vtkSpyPlotUniReader.h.


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