VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkPExodusIIReader Class Reference

Read Exodus II files (.exii) More...

#include <vtkPExodusIIReader.h>

Inheritance diagram for vtkPExodusIIReader:
Inheritance graph
[legend]
Collaboration diagram for vtkPExodusIIReader:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkExodusIIReader Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkPExodusIIReaderNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
void SetFileNames (int nfiles, const char **names)
virtual void SetFileName (const char *name)
char ** GetFileNames ()
int GetNumberOfFileNames ()
virtual vtkIdType GetTotalNumberOfElements ()
virtual vtkIdType GetTotalNumberOfNodes ()
virtual void UpdateTimeInformation ()
virtual void Broadcast (vtkMultiProcessController *ctrl)
void SetController (vtkMultiProcessController *c)
virtual vtkMultiProcessControllerGetController ()
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 intGetFileRange ()
virtual void GetFileRange (int &, int &)
virtual void GetFileRange (int[2])
virtual int GetNumberOfFiles ()
virtual double GetVariableCacheSize ()
virtual void SetVariableCacheSize (double)

Static Public Member Functions

static vtkPExodusIIReaderNew ()
static int IsTypeOf (const char *type)
static vtkPExodusIIReaderSafeDownCast (vtkObjectBase *o)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkPExodusIIReader ()
 ~vtkPExodusIIReader ()
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Protected Attributes

double VariableCacheSize
vtkMultiProcessControllerController
vtkIdType ProcRank
vtkIdType ProcSize
char * FilePattern
char * CurrentFilePattern
char * FilePrefix
char * CurrentFilePrefix
char * MultiFileName
int FileRange [2]
int CurrentFileRange [2]
int NumberOfFiles
char ** FileNames
int NumberOfFileNames
std::vector< vtkExodusIIReader * > ReaderList
std::vector< intNumberOfPointsPerFile
std::vector< intNumberOfCellsPerFile
int LastCommonTimeStep
int Timing
vtkTimerLogTimerLog
int DeterminePattern (const char *file)
static int DetermineFileId (const char *file)

Detailed Description

Read Exodus II files (.exii)

vtkPExodusIIReader is a unstructured grid source object that reads ExodusII 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 49 of file vtkPExodusIIReader.h.


Member Typedef Documentation

Reimplemented from vtkExodusIIReader.

Definition at line 53 of file vtkPExodusIIReader.h.


Constructor & Destructor Documentation


Member Function Documentation

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

Reimplemented from vtkExodusIIReader.

static int vtkPExodusIIReader::IsTypeOf ( const char *  name) [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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkExodusIIReader.

virtual int vtkPExodusIIReader::IsA ( const char *  name) [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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkExodusIIReader.

Reimplemented from vtkExodusIIReader.

virtual vtkObjectBase* vtkPExodusIIReader::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkExodusIIReader.

Reimplemented from vtkExodusIIReader.

void vtkPExodusIIReader::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 vtkExodusIIReader.

Set/get the communication object used to relay a list of files from the rank 0 process to all others. This is the only interprocess communication required by vtkPExodusIIReader.

Set/get the communication object used to relay a list of files from the rank 0 process to all others. This is the only interprocess communication required by vtkPExodusIIReader.

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

These methods tell the reader that the data is distributed 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* vtkPExodusIIReader::GetFilePattern ( ) [virtual]

These methods tell the reader that the data is distributed 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 void vtkPExodusIIReader::SetFilePrefix ( const char *  ) [virtual]

These methods tell the reader that the data is distributed 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* vtkPExodusIIReader::GetFilePrefix ( ) [virtual]

These methods tell the reader that the data is distributed 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.

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

void vtkPExodusIIReader::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 82 of file vtkPExodusIIReader.h.

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

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

virtual void vtkPExodusIIReader::GetFileRange ( int ,
int  
) [virtual]

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

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

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

void vtkPExodusIIReader::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. vtkPExodusIIReader makes it's own copy of your file names.

virtual void vtkPExodusIIReader::SetFileName ( const char *  fname) [virtual]

Specify file name of the Exodus file.

Reimplemented from vtkExodusIIReader.

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

Return pointer to list of file names set in SetFileNames

Definition at line 95 of file vtkPExodusIIReader.h.

Return number of file names set in SetFileNames

Definition at line 98 of file vtkPExodusIIReader.h.

Return the number of files to be read.

Reimplemented from vtkExodusIIReader.

Reimplemented from vtkExodusIIReader.

virtual void vtkPExodusIIReader::UpdateTimeInformation ( ) [virtual]

Calls UpdateTimeInformation() on all serial readers so they'll re-read their time info from the file. The last time step that they all have in common is stored in LastCommonTimeStep, which is used in RequestInformation() to override the output time-specific information keys with the range of times that ALL readers can actually read.

Reimplemented from vtkExodusIIReader.

virtual void vtkPExodusIIReader::Broadcast ( vtkMultiProcessController ctrl) [virtual]

Sends metadata (that read from the input file, not settings modified through this API) from the rank 0 node to all other processes in a job.

The size of the variable cache in MegaByes. This represents the maximum size of cache that a single partition reader can have while reading. When a reader is finished its cache size will be set to a fraction of this based on the number of partitions. The Default for this is 100MiB. Note that because each reader still holds a fraction of the cache size after reading the total amount of data cached can be at most twice this size.

virtual void vtkPExodusIIReader::SetVariableCacheSize ( double  ) [virtual]

The size of the variable cache in MegaByes. This represents the maximum size of cache that a single partition reader can have while reading. When a reader is finished its cache size will be set to a fraction of this based on the number of partitions. The Default for this is 100MiB. Note that because each reader still holds a fraction of the cache size after reading the total amount of data cached can be at most twice this size.

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

Try to "guess" the pattern of files.

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

Try to "guess" the pattern of files.

This is called by the superclass. This is the method you should override.

Reimplemented from vtkExodusIIReader.

This is called by the superclass. This is the method you should override.

Reimplemented from vtkExodusIIReader.


Member Data Documentation

Definition at line 143 of file vtkPExodusIIReader.h.

Definition at line 148 of file vtkPExodusIIReader.h.

Definition at line 149 of file vtkPExodusIIReader.h.

Definition at line 150 of file vtkPExodusIIReader.h.

Definition at line 151 of file vtkPExodusIIReader.h.

Definition at line 152 of file vtkPExodusIIReader.h.

char* vtkPExodusIIReader::FilePrefix [protected]

Definition at line 153 of file vtkPExodusIIReader.h.

Definition at line 154 of file vtkPExodusIIReader.h.

Definition at line 155 of file vtkPExodusIIReader.h.

Definition at line 156 of file vtkPExodusIIReader.h.

Definition at line 157 of file vtkPExodusIIReader.h.

Definition at line 158 of file vtkPExodusIIReader.h.

char** vtkPExodusIIReader::FileNames [protected]

Definition at line 159 of file vtkPExodusIIReader.h.

Definition at line 160 of file vtkPExodusIIReader.h.

Definition at line 162 of file vtkPExodusIIReader.h.

Definition at line 163 of file vtkPExodusIIReader.h.

Definition at line 164 of file vtkPExodusIIReader.h.

Definition at line 167 of file vtkPExodusIIReader.h.

Definition at line 169 of file vtkPExodusIIReader.h.

Definition at line 170 of file vtkPExodusIIReader.h.


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