vtkEnSightGoldReader Class Reference

#include <vtkEnSightGoldReader.h>

Inheritance diagram for vtkEnSightGoldReader:

[legend]

Collaboration diagram for vtkEnSightGoldReader:

[legend]

List of all members.

---

Detailed Description

class to read EnSight Gold files

vtkEnSightGoldReader is a class to read EnSight Gold files into vtk. Because the different parts of the EnSight data can be of various data types, this reader produces multiple outputs, one per part in the input file. All variable information is being stored in field data. The descriptions listed in the case file are used as the array names in the field data. For complex vector variables, the description is appended with _r (for the array of real values) and _i (for the array if imaginary values). Complex scalar variables are stored as a single array with 2 components, real and imaginary, listed in that order.

Warning:

You must manually call Update on this reader and then connect the rest of the pipeline because (due to the nature of the file format) it is not possible to know ahead of time how many outputs you will have or what types they will be. This reader can only handle static EnSight datasets (both static geometry and variables).

Thanks:

Thanks to Yvan Fournier for providing the code to support nfaced elements.

Definition at line 50 of file vtkEnSightGoldReader.h.

Public Types
typedef vtkEnSightReader	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
virtual void	PrintSelf (ostream &os, vtkIndent indent)
Static Public Member Functions
static vtkEnSightGoldReader *	New ()
static int	IsTypeOf (const char *type)
static vtkEnSightGoldReader *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkEnSightGoldReader ()
	~vtkEnSightGoldReader ()
int	CheckForUndefOrPartial (const char *line)
virtual int	ReadGeometryFile (const char *fileName, int timeStep, vtkMultiBlockDataSet *output)
virtual int	ReadMeasuredGeometryFile (const char *fileName, int timeStep, vtkMultiBlockDataSet *output)
virtual int	ReadScalarsPerNode (const char *fileName, const char *description, int timeStep, vtkMultiBlockDataSet *output, int measured=0, int numberOfComponents=1, int component=0)
virtual int	ReadVectorsPerNode (const char *fileName, const char *description, int timeStep, vtkMultiBlockDataSet *output, int measured=0)
virtual int	ReadTensorsPerNode (const char *fileName, const char *description, int timeStep, vtkMultiBlockDataSet *output)
virtual int	ReadScalarsPerElement (const char *fileName, const char *description, int timeStep, vtkMultiBlockDataSet *output, int numberOfComponents=1, int component=0)
virtual int	ReadVectorsPerElement (const char *fileName, const char *description, int timeStep, vtkMultiBlockDataSet *output)
virtual int	ReadTensorsPerElement (const char *fileName, const char *description, int timeStep, vtkMultiBlockDataSet *output)
virtual int	CreateUnstructuredGridOutput (int partId, char line[256], const char *name, vtkMultiBlockDataSet *output)
virtual int	CreateStructuredGridOutput (int partId, char line[256], const char *name, vtkMultiBlockDataSet *output)
int	CreateRectilinearGridOutput (int partId, char line[256], const char *name, vtkMultiBlockDataSet *output)
int	CreateImageDataOutput (int partId, char line[256], const char *name, vtkMultiBlockDataSet *output)
virtual void	SetGeometryFileName (const char *)
virtual char *	GetGeometryFileName ()
virtual void	SetMeasuredFileName (const char *)
virtual char *	GetMeasuredFileName ()
virtual void	SetMatchFileName (const char *)
virtual char *	GetMatchFileName ()
Protected Attributes
UndefPartialInternal *	UndefPartial
int	NodeIdsListed
int	ElementIdsListed

---

Member Typedef Documentation

typedef vtkEnSightReader vtkEnSightGoldReader::Superclass

Reimplemented from vtkEnSightReader.

Definition at line 54 of file vtkEnSightGoldReader.h.

---

Constructor & Destructor Documentation

vtkEnSightGoldReader::vtkEnSightGoldReader

(

)

[protected]

vtkEnSightGoldReader::~vtkEnSightGoldReader

(

)

[protected]

---

Member Function Documentation

static vtkEnSightGoldReader* vtkEnSightGoldReader::New

(

)

[static]

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

Reimplemented from vtkGenericEnSightReader.

virtual const char* vtkEnSightGoldReader::GetClassName

(

)

[virtual]

Reimplemented from vtkEnSightReader.

static int vtkEnSightGoldReader::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkEnSightReader.

virtual int vtkEnSightGoldReader::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkEnSightReader.

static vtkEnSightGoldReader* vtkEnSightGoldReader::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkEnSightReader.

virtual void vtkEnSightGoldReader::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 vtkEnSightReader.

virtual int vtkEnSightGoldReader::ReadGeometryFile	(	const char *	fileName,
		int	timeStep,
		vtkMultiBlockDataSet *	output
	)			[protected, virtual]

Read the geometry file. If an error occurred, 0 is returned; otherwise 1.

Implements vtkEnSightReader.

virtual int vtkEnSightGoldReader::ReadMeasuredGeometryFile	(	const char *	fileName,
		int	timeStep,
		vtkMultiBlockDataSet *	output
	)			[protected, virtual]

Read the measured geometry file. If an error occurred, 0 is returned; otherwise 1.

Implements vtkEnSightReader.

virtual int vtkEnSightGoldReader::ReadScalarsPerNode	(	const char *	fileName,
		const char *	description,
		int	timeStep,
		vtkMultiBlockDataSet *	output,
		int	measured = 0,
		int	numberOfComponents = 1,
		int	component = 0
	)			[protected, virtual]

Read scalars per node for this dataset. If an error occurred, 0 is returned; otherwise 1. If there will be more than one component in the data array, it is assumed that 0 is the first component added.

Implements vtkEnSightReader.

virtual int vtkEnSightGoldReader::ReadVectorsPerNode	(	const char *	fileName,
		const char *	description,
		int	timeStep,
		vtkMultiBlockDataSet *	output,
		int	measured = 0
	)			[protected, virtual]

Read vectors per node for this dataset. If an error occurred, 0 is returned; otherwise 1.

Implements vtkEnSightReader.

virtual int vtkEnSightGoldReader::ReadTensorsPerNode	(	const char *	fileName,
		const char *	description,
		int	timeStep,
		vtkMultiBlockDataSet *	output
	)			[protected, virtual]

Read tensors per node for this dataset. If an error occurred, 0 is returned; otherwise 1.

Implements vtkEnSightReader.

virtual int vtkEnSightGoldReader::ReadScalarsPerElement	(	const char *	fileName,
		const char *	description,
		int	timeStep,
		vtkMultiBlockDataSet *	output,
		int	numberOfComponents = 1,
		int	component = 0
	)			[protected, virtual]

Read scalars per element for this dataset. If an error occurred, 0 is returned; otherwise 1. If there will be more than one componenet in the data array, it is assumed that 0 is the first component added.

Implements vtkEnSightReader.

virtual int vtkEnSightGoldReader::ReadVectorsPerElement	(	const char *	fileName,
		const char *	description,
		int	timeStep,
		vtkMultiBlockDataSet *	output
	)			[protected, virtual]

Read vectors per element for this dataset. If an error occurred, 0 is returned; otherwise 1.

Implements vtkEnSightReader.

virtual int vtkEnSightGoldReader::ReadTensorsPerElement	(	const char *	fileName,
		const char *	description,
		int	timeStep,
		vtkMultiBlockDataSet *	output
	)			[protected, virtual]

Read tensors per element for this dataset. If an error occurred, 0 is returned; otherwise 1.

Implements vtkEnSightReader.

virtual int vtkEnSightGoldReader::CreateUnstructuredGridOutput	(	int	partId,
		char	line[256],
		const char *	name,
		vtkMultiBlockDataSet *	output
	)			[protected, virtual]

Read an unstructured part (partId) from the geometry file and create a vtkUnstructuredGrid output. Return 0 if EOF reached. Return -1 if an error occurred.

virtual int vtkEnSightGoldReader::CreateStructuredGridOutput	(	int	partId,
		char	line[256],
		const char *	name,
		vtkMultiBlockDataSet *	output
	)			[protected, virtual]

Read a structured part from the geometry file and create a vtkStructuredGrid output. Return 0 if EOF reached.

int vtkEnSightGoldReader::CreateRectilinearGridOutput	(	int	partId,
		char	line[256],
		const char *	name,
		vtkMultiBlockDataSet *	output
	)			[protected]

Read a structured part from the geometry file and create a vtkRectilinearGrid output. Return 0 if EOF reached.

int vtkEnSightGoldReader::CreateImageDataOutput	(	int	partId,
		char	line[256],
		const char *	name,
		vtkMultiBlockDataSet *	output
	)			[protected]

Read a structured part from the geometry file and create a vtkImageData output. Return 0 if EOF reached.

virtual void vtkEnSightGoldReader::SetGeometryFileName

(

const char *

)

[protected, virtual]

Set/Get the Model file name.

Reimplemented from vtkGenericEnSightReader.

virtual char* vtkEnSightGoldReader::GetGeometryFileName

(

)

[protected, virtual]

Set/Get the Model file name.

Reimplemented from vtkGenericEnSightReader.

virtual void vtkEnSightGoldReader::SetMeasuredFileName

(

const char *

)

[protected, virtual]

Set/Get the Measured file name.

Reimplemented from vtkEnSightReader.

virtual char* vtkEnSightGoldReader::GetMeasuredFileName

(

)

[protected, virtual]

Set/Get the Measured file name.

Reimplemented from vtkEnSightReader.

virtual void vtkEnSightGoldReader::SetMatchFileName

(

const char *

)

[protected, virtual]

Set/Get the Match file name.

Reimplemented from vtkEnSightReader.

virtual char* vtkEnSightGoldReader::GetMatchFileName

(

)

[protected, virtual]

Set/Get the Match file name.

Reimplemented from vtkEnSightReader.

int vtkEnSightGoldReader::CheckForUndefOrPartial

(

const char *

line

)

[protected]

Skip next line in file if the 'undef' or 'partial' keyword was specified after a sectional keyword

---

Member Data Documentation

UndefPartialInternal* vtkEnSightGoldReader::UndefPartial [protected]

Handle the undef / partial support for EnSight gold

Definition at line 181 of file vtkEnSightGoldReader.h.

int vtkEnSightGoldReader::NodeIdsListed [protected]

Definition at line 183 of file vtkEnSightGoldReader.h.

int vtkEnSightGoldReader::ElementIdsListed [protected]

Definition at line 184 of file vtkEnSightGoldReader.h.

---

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

• dox/IO/vtkEnSightGoldReader.h