vtkPExodusReader Class Reference

#include <vtkPExodusReader.h>

Inheritance diagram for vtkPExodusReader:

[legend]Collaboration diagram for vtkPExodusReader:

[legend]List of all members.

---

Detailed Description

Read exodus 2 files .ex2.

vtkPExodusReader is a unstructured grid source object that reads PExodusReaderII files. Most of the meta data associated with the file is loaded when UpdateInformation is called. This includes information like Title, number of blocks, number and names of arrays. This data can be retrieved from methods in this reader. Separate arrays that are meant to be a single vector, are combined internally for convenience. To be combined, the array names have to be identical except for a trailing X,Y and Z (or x,y,z). By default all cell and point arrays are loaded. However, the user can flag arrays not to load with the methods "SetPointDataArrayLoadFlag" and "SetCellDataArrayLoadFlag". The reader responds to piece requests by loading only a range of the possible blocks. Unused points are filtered out internally.

Definition at line 47 of file vtkPExodusReader.h.

void	GetDSPOutputArrays (int exoid, vtkUnstructuredGrid *output)
int	DeterminePattern (const char *file)
static int	DetermineFileId (const char *file)
Public Types
typedef vtkExodusReader	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	SetFileNames (int nfiles, const char **names)
virtual void	SetFileName (const char *name)
char **	GetFileNames ()
void	SetGenerateFileIdArray (int flag)
virtual int	GetGenerateFileIdArray ()
virtual void	GenerateFileIdArrayOn ()
virtual void	GenerateFileIdArrayOff ()
int	GetNumberOfVariableArrays ()
const char *	GetVariableArrayName (int a_which)
void	EnableDSPFiltering ()
void	AddFilter (vtkDSPFilterDefinition *a_filter)
void	StartAddingFilter ()
void	AddFilterInputVar (char *name)
void	AddFilterOutputVar (char *name)
void	AddFilterNumeratorWeight (double weight)
void	AddFilterForwardNumeratorWeight (double weight)
void	AddFilterDenominatorWeight (double weight)
void	FinishAddingFilter ()
void	RemoveFilter (char *a_outputVariableName)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetFilePattern (const char *)
virtual char *	GetFilePattern ()
virtual void	SetFilePrefix (const char *)
virtual char *	GetFilePrefix ()
void	SetFileRange (int, int)
void	SetFileRange (int *r)
virtual int *	GetFileRange ()
virtual void	GetFileRange (int &, int &)
virtual void	GetFileRange (int[2])
int	GetNumberOfFileNames ()
virtual int	GetNumberOfFiles ()
Static Public Member Functions
static vtkPExodusReader *	New ()
static int	IsTypeOf (const char *type)
static vtkPExodusReader *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkPExodusReader ()
	~vtkPExodusReader ()
void	SetUpEmptyGrid ()
int	RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
Protected Attributes
char *	FilePattern
char *	CurrentFilePattern
char *	FilePrefix
char *	CurrentFilePrefix
char *	MultiFileName
int	FileRange [2]
int	CurrentFileRange [2]
int	NumberOfFiles
char **	FileNames
int	NumberOfFileNames
int	GenerateFileIdArray
vtkstd::vector< vtkExodusReader * >	readerList
int	Timing
vtkTimerLog *	TimerLog

---

Member Typedef Documentation

typedef vtkExodusReader vtkPExodusReader::Superclass

Reimplemented from vtkExodusReader. Definition at line 51 of file vtkPExodusReader.h.

---

Constructor & Destructor Documentation

vtkPExodusReader::vtkPExodusReader (   )  [protected]

vtkPExodusReader::~vtkPExodusReader (   )  [protected]

---

Member Function Documentation

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

Create an object with Debug turned off, modified time initialized to zero, and reference counting on. Reimplemented from vtkExodusReader.

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

Reimplemented from vtkExodusReader.

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

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkExodusReader.

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

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkExodusReader.

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

Reimplemented from vtkExodusReader.

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

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes. Reimplemented from vtkExodusReader.

virtual void vtkPExodusReader::SetFilePattern (  const char *   )  [virtual]

These methods tell the reader that the data is ditributed across multiple files. This is for distributed execution. It this case, pieces are mapped to files. The pattern should have one d to format the file number. FileNumberRange is used to generate file numbers. I was thinking of having an arbitrary list of file numbers. This may happen in the future. (That is why there is no GetFileNumberRange method.

virtual char* vtkPExodusReader::GetFilePattern (   )  [virtual]

virtual void vtkPExodusReader::SetFilePrefix (  const char *   )  [virtual]

virtual char* vtkPExodusReader::GetFilePrefix (   )  [virtual]

void vtkPExodusReader::SetFileRange (  int  , int  )

Set the range of files that are being loaded. The range for single file should add to 0.

void vtkPExodusReader::SetFileRange (  int *  r  )  [inline]

Set the range of files that are being loaded. The range for single file should add to 0. Definition at line 72 of file vtkPExodusReader.h.

virtual int* vtkPExodusReader::GetFileRange (   )  [virtual]

Set the range of files that are being loaded. The range for single file should add to 0.

virtual void vtkPExodusReader::GetFileRange (  int &  , int &  )  [virtual]

Set the range of files that are being loaded. The range for single file should add to 0.

virtual void vtkPExodusReader::GetFileRange (  int  [2]  )  [virtual]

Set the range of files that are being loaded. The range for single file should add to 0.

void vtkPExodusReader::SetFileNames (  int  nfiles, const char **  names )

Provide an arbitrary list of file names instead of a prefix, pattern and range. Overrides any prefix, pattern and range that is specified. vtkPExodusReader makes it's own copy of your file names.

virtual void vtkPExodusReader::SetFileName (  const char *  name  )  [virtual]

Specify file name of the Exodus file. Reimplemented from vtkExodusReader.

char** vtkPExodusReader::GetFileNames (   )  [inline]

Return pointer to list of file names set in SetFileNames Definition at line 84 of file vtkPExodusReader.h.

int vtkPExodusReader::GetNumberOfFileNames (   )  [inline]

Return number of file names set in SetFileNames Definition at line 87 of file vtkPExodusReader.h.

virtual int vtkPExodusReader::GetNumberOfFiles (   )  [virtual]

Return the number of files to be read.

void vtkPExodusReader::SetGenerateFileIdArray (  int  flag  )

Extra cell data array that can be generated. By default, this array is OFF. The value of the array is the integer id which is part of the name of the file from which the cell was read. The name of the array is "vtkFileId".

virtual int vtkPExodusReader::GetGenerateFileIdArray (   )  [virtual]

virtual void vtkPExodusReader::GenerateFileIdArrayOn (   )  [virtual]

virtual void vtkPExodusReader::GenerateFileIdArrayOff (   )  [virtual]

int vtkPExodusReader::GetNumberOfVariableArrays (   )

Reimplemented from vtkExodusReader.

const char* vtkPExodusReader::GetVariableArrayName (  int  a_which  )

Reimplemented from vtkExodusReader.

void vtkPExodusReader::EnableDSPFiltering (   )

Reimplemented from vtkExodusReader.

void vtkPExodusReader::AddFilter (  vtkDSPFilterDefinition *  a_filter  )

Reimplemented from vtkExodusReader.

void vtkPExodusReader::StartAddingFilter (   )

Reimplemented from vtkExodusReader.

void vtkPExodusReader::AddFilterInputVar (  char *  name  )

Reimplemented from vtkExodusReader.

void vtkPExodusReader::AddFilterOutputVar (  char *  name  )

Reimplemented from vtkExodusReader.

void vtkPExodusReader::AddFilterNumeratorWeight (  double  weight  )

Reimplemented from vtkExodusReader.

void vtkPExodusReader::AddFilterForwardNumeratorWeight (  double  weight  )

Reimplemented from vtkExodusReader.

void vtkPExodusReader::AddFilterDenominatorWeight (  double  weight  )

Reimplemented from vtkExodusReader.

void vtkPExodusReader::FinishAddingFilter (   )

Reimplemented from vtkExodusReader.

void vtkPExodusReader::RemoveFilter (  char *  a_outputVariableName  )

Reimplemented from vtkExodusReader.

void vtkPExodusReader::GetDSPOutputArrays (  int  exoid, vtkUnstructuredGrid *  output )  [protected]

Reimplemented from vtkExodusReader.

int vtkPExodusReader::DeterminePattern (  const char *  file  )  [protected]

Try to "guess" the pattern of files.

static int vtkPExodusReader::DetermineFileId (  const char *  file  )  [static, protected]

void vtkPExodusReader::SetUpEmptyGrid (   )  [protected]

int vtkPExodusReader::RequestInformation (  vtkInformation *  , vtkInformationVector **  , vtkInformationVector *  )  [protected, virtual]

Reimplemented from vtkExodusReader.

int vtkPExodusReader::RequestData (  vtkInformation *  , vtkInformationVector **  , vtkInformationVector *  )  [protected, virtual]

This is called by the superclass. This is the method you should override. Reimplemented from vtkExodusReader.

---

Member Data Documentation

char* vtkPExodusReader::FilePattern [protected]

Definition at line 141 of file vtkPExodusReader.h.

char* vtkPExodusReader::CurrentFilePattern [protected]

Definition at line 142 of file vtkPExodusReader.h.

char* vtkPExodusReader::FilePrefix [protected]

Definition at line 143 of file vtkPExodusReader.h.

char* vtkPExodusReader::CurrentFilePrefix [protected]

Definition at line 144 of file vtkPExodusReader.h.

char* vtkPExodusReader::MultiFileName [protected]

Definition at line 145 of file vtkPExodusReader.h.

int vtkPExodusReader::FileRange[2] [protected]

Definition at line 146 of file vtkPExodusReader.h.

int vtkPExodusReader::CurrentFileRange[2] [protected]

Definition at line 147 of file vtkPExodusReader.h.

int vtkPExodusReader::NumberOfFiles [protected]

Definition at line 148 of file vtkPExodusReader.h.

char** vtkPExodusReader::FileNames [protected]

Definition at line 149 of file vtkPExodusReader.h.

int vtkPExodusReader::NumberOfFileNames [protected]

Definition at line 150 of file vtkPExodusReader.h.

int vtkPExodusReader::GenerateFileIdArray [protected]

Definition at line 151 of file vtkPExodusReader.h.

vtkstd::vector<vtkExodusReader*> vtkPExodusReader::readerList [protected]

Definition at line 153 of file vtkPExodusReader.h.

int vtkPExodusReader::Timing [protected]

Definition at line 156 of file vtkPExodusReader.h.

vtkTimerLog* vtkPExodusReader::TimerLog [protected]

Definition at line 157 of file vtkPExodusReader.h.

---

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

• dox/Hybrid/vtkPExodusReader.h

---