vtkEnSightWriter Class Reference

#include <vtkEnSightWriter.h>

Inheritance diagram for vtkEnSightWriter:

[legend]Collaboration diagram for vtkEnSightWriter:

[legend]List of all members.

---

Detailed Description

write vtk unstructured grid data as an EnSight file

vtkEnSightWriter is a source object that writes binary unstructured grid data files in EnSight format. See EnSight Manual for format details

Warning:

Binary files written on one system may not be readable on other systems. Be sure to specify the endian-ness of the file when reading it into EnSight

Definition at line 40 of file vtkEnSightWriter.h.

virtual void	SetProcessNumber (int)
virtual int	GetProcessNumber ()
*static vtkEnSightWriter *	New ()
Public Types
typedef vtkWriter	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetPath (const char *)
virtual char *	GetPath ()
virtual void	SetBaseName (const char *)
virtual char *	GetBaseName ()
virtual void	SetFileName (const char *)
virtual char *	GetFileName ()
virtual void	SetTimeStep (int)
virtual int	GetTimeStep ()
virtual void	SetGhostLevel (int)
virtual int	GetGhostLevel ()
virtual void	SetTransientGeometry (bool)
virtual bool	GetTransientGeometry ()
virtual void	SetNumberOfBlocks (int)
virtual int	GetNumberOfBlocks ()
virtual void	SetBlockIDs (int *val)
virtual int *	GetBlockIDs ()
virtual void	SetInput (vtkUnstructuredGrid *input)
virtual vtkUnstructuredGrid *	GetInput ()
virtual void	WriteCaseFile (int TotalTimeSteps)
virtual void	WriteSOSCaseFile (int NumProcs)
virtual void	SetModelMetadata (vtkModelMetadata *model)
virtual vtkModelMetadata *	GetModelMetadata ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkEnSightWriter *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkEnSightWriter ()
virtual	~vtkEnSightWriter ()
virtual int	FillInputPortInformation (int port, vtkInformation *info)
virtual void	WriteData ()
virtual void	WriteStringToFile (const char *string, FILE *file)
virtual void	WriteTerminatedStringToFile (const char *string, FILE *file)
virtual void	WriteIntToFile (const int i, FILE *file)
virtual void	WriteFloatToFile (const float f, FILE *file)
virtual void	WriteElementTypeToFile (int ElementType, FILE *fd)
virtual bool	ShouldWriteGeometry ()
virtual void	SanitizeFileName (char *name)
virtual FILE *	OpenFile (char *name)
void	ComputeNames ()
void	DefaultNames ()
int	GetExodusModelIndex (int *ElementArray, int NumberElements, int PartID)
	vtkEnSightWriter (const vtkEnSightWriter &)
void	operator= (const vtkEnSightWriter &)
Protected Attributes
char *	Path
char *	BaseName
char *	FileName
int	TimeStep
int	GhostLevelMultiplier
int	ProcessNumber
int	NumberOfProcesses
int	NumberOfBlocks
int *	BlockIDs
bool	TransientGeometry
int	GhostLevel
vtkUnstructuredGrid *	TmpInput
vtkModelMetadata *	ModelMetadata

---

Member Typedef Documentation

typedef vtkWriter vtkEnSightWriter::Superclass

Reimplemented from vtkWriter. Definition at line 44 of file vtkEnSightWriter.h.

---

Constructor & Destructor Documentation

vtkEnSightWriter::vtkEnSightWriter (   )  [protected]

virtual vtkEnSightWriter::~vtkEnSightWriter (   )  [protected, virtual]

vtkEnSightWriter::vtkEnSightWriter (  const vtkEnSightWriter &   )  [protected]

---

Member Function Documentation

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

Reimplemented from vtkWriter.

static int vtkEnSightWriter::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 vtkWriter.

virtual int vtkEnSightWriter::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 vtkWriter.

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

Reimplemented from vtkWriter.

virtual void vtkEnSightWriter::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 vtkWriter.

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

Specify which process this writer is Reimplemented from vtkAlgorithm.

virtual void vtkEnSightWriter::SetProcessNumber (  int   )  [virtual]

Specify which process this writer is

virtual int vtkEnSightWriter::GetProcessNumber (   )  [virtual]

Specify which process this writer is

virtual void vtkEnSightWriter::SetPath (  const char *   )  [virtual]

Specify path of EnSight data files to write.

virtual char* vtkEnSightWriter::GetPath (   )  [virtual]

Specify path of EnSight data files to write.

virtual void vtkEnSightWriter::SetBaseName (  const char *   )  [virtual]

Specify base name of EnSight data files to write.

virtual char* vtkEnSightWriter::GetBaseName (   )  [virtual]

Specify base name of EnSight data files to write.

virtual void vtkEnSightWriter::SetFileName (  const char *   )  [virtual]

Specify the path and base name of the output files.

virtual char* vtkEnSightWriter::GetFileName (   )  [virtual]

Specify the path and base name of the output files.

virtual void vtkEnSightWriter::SetTimeStep (  int   )  [virtual]

Specify the Timestep that this data is for

virtual int vtkEnSightWriter::GetTimeStep (   )  [virtual]

Specify the Timestep that this data is for

virtual void vtkEnSightWriter::SetGhostLevel (  int   )  [virtual]

Specify the number of ghost levels to include in output files

virtual int vtkEnSightWriter::GetGhostLevel (   )  [virtual]

Specify the number of ghost levels to include in output files

virtual void vtkEnSightWriter::SetTransientGeometry (  bool   )  [virtual]

Specify whether the geoemtry changes each timestep if false, geometry is only written at timestep 0

virtual bool vtkEnSightWriter::GetTransientGeometry (   )  [virtual]

Specify whether the geoemtry changes each timestep if false, geometry is only written at timestep 0

virtual void vtkEnSightWriter::SetNumberOfBlocks (  int   )  [virtual]

set the number of block ID's

virtual int vtkEnSightWriter::GetNumberOfBlocks (   )  [virtual]

set the number of block ID's

virtual void vtkEnSightWriter::SetBlockIDs (  int *  val  )  [inline, virtual]

set the array of Block ID's this class keeps a reference to the array and will not delete it Definition at line 102 of file vtkEnSightWriter.h.

virtual int* vtkEnSightWriter::GetBlockIDs (   )  [inline, virtual]

set the array of Block ID's this class keeps a reference to the array and will not delete it Definition at line 106 of file vtkEnSightWriter.h.

virtual void vtkEnSightWriter::SetInput (  vtkUnstructuredGrid *  input  )  [virtual]

Specify the input data or filter.

virtual vtkUnstructuredGrid* vtkEnSightWriter::GetInput (   )  [virtual]

Specify the input data or filter. Reimplemented from vtkWriter.

virtual void vtkEnSightWriter::WriteCaseFile (  int  TotalTimeSteps  )  [virtual]

Writes the case file that EnSight is capable of reading The other data files must be written before the case file and the input must be one of the time steps variables must be the same for all time steps or the case file will be missing variables

virtual void vtkEnSightWriter::WriteSOSCaseFile (  int  NumProcs  )  [virtual]

Writes the case file that EnSight is capable of reading The other data files must be written before the case file and the input must be one of the time steps variables must be the same for all time steps or the case file will be missing variables

virtual void vtkEnSightWriter::SetModelMetadata (  vtkModelMetadata *  model  )  [virtual]

sets and gets the metadata

virtual vtkModelMetadata* vtkEnSightWriter::GetModelMetadata (   )  [virtual]

sets and gets the metadata

virtual int vtkEnSightWriter::FillInputPortInformation (  int  port, vtkInformation *  info )  [protected, virtual]

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle. Reimplemented from vtkAlgorithm.

virtual void vtkEnSightWriter::WriteData (   )  [protected, virtual]

Implements vtkWriter.

virtual void vtkEnSightWriter::WriteStringToFile (  const char *  string, FILE *  file )  [protected, virtual]

virtual void vtkEnSightWriter::WriteTerminatedStringToFile (  const char *  string, FILE *  file )  [protected, virtual]

virtual void vtkEnSightWriter::WriteIntToFile (  const int  i, FILE *  file )  [protected, virtual]

virtual void vtkEnSightWriter::WriteFloatToFile (  const float  f, FILE *  file )  [protected, virtual]

virtual void vtkEnSightWriter::WriteElementTypeToFile (  int  ElementType, FILE *  fd )  [protected, virtual]

virtual bool vtkEnSightWriter::ShouldWriteGeometry (   )  [protected, virtual]

virtual void vtkEnSightWriter::SanitizeFileName (  char *  name  )  [protected, virtual]

virtual FILE* vtkEnSightWriter::OpenFile (  char *  name  )  [protected, virtual]

void vtkEnSightWriter::ComputeNames (   )  [protected]

void vtkEnSightWriter::DefaultNames (   )  [protected]

int vtkEnSightWriter::GetExodusModelIndex (  int *  ElementArray, int  NumberElements, int  PartID )  [protected]

void vtkEnSightWriter::operator= (  const vtkEnSightWriter &   )  [protected]

---

Member Data Documentation

char* vtkEnSightWriter::Path [protected]

Definition at line 156 of file vtkEnSightWriter.h.

char* vtkEnSightWriter::BaseName [protected]

Definition at line 157 of file vtkEnSightWriter.h.

char* vtkEnSightWriter::FileName [protected]

Definition at line 158 of file vtkEnSightWriter.h.

int vtkEnSightWriter::TimeStep [protected]

Definition at line 159 of file vtkEnSightWriter.h.

int vtkEnSightWriter::GhostLevelMultiplier [protected]

Definition at line 160 of file vtkEnSightWriter.h.

int vtkEnSightWriter::ProcessNumber [protected]

Definition at line 161 of file vtkEnSightWriter.h.

int vtkEnSightWriter::NumberOfProcesses [protected]

Definition at line 162 of file vtkEnSightWriter.h.

int vtkEnSightWriter::NumberOfBlocks [protected]

Definition at line 163 of file vtkEnSightWriter.h.

int* vtkEnSightWriter::BlockIDs [protected]

Definition at line 164 of file vtkEnSightWriter.h.

bool vtkEnSightWriter::TransientGeometry [protected]

Definition at line 165 of file vtkEnSightWriter.h.

int vtkEnSightWriter::GhostLevel [protected]

Definition at line 166 of file vtkEnSightWriter.h.

vtkUnstructuredGrid* vtkEnSightWriter::TmpInput [protected]

Definition at line 167 of file vtkEnSightWriter.h.

vtkModelMetadata* vtkEnSightWriter::ModelMetadata [protected]

Definition at line 168 of file vtkEnSightWriter.h.

---

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

• dox/Parallel/vtkEnSightWriter.h

---