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

write vtk unstructured grid data as an EnSight file More...

#include <vtkEnSightWriter.h>

Inheritance diagram for vtkEnSightWriter:
[legend]
Collaboration diagram for vtkEnSightWriter:
[legend]

List of all members.

Public Types

typedef vtkWriter Superclass
- Public Types inherited from vtkWriter
- Public Types inherited from vtkAlgorithm
- Public Types inherited from vtkObject

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetProcessNumber (int)
virtual int GetProcessNumber ()
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 vtkUnstructuredGridGetInput ()
virtual void WriteCaseFile (int TotalTimeSteps)
virtual void WriteSOSCaseFile (int NumProcs)
virtual void SetModelMetadata (vtkModelMetadata *model)
virtual vtkModelMetadataGetModelMetadata ()
- Public Member Functions inherited from vtkWriter
virtual int Write ()
void EncodeString (char *resname, const char *name, bool doublePercent)
void EncodeWriteString (ostream *out, const char *name, bool doublePercent)
void SetInput (vtkDataObject *input)
void SetInput (int index, vtkDataObject *input)
vtkDataObjectGetInput (int port)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void SetAbortExecute (int)
virtual int GetAbortExecute ()
virtual void AbortExecuteOn ()
virtual void AbortExecuteOff ()
virtual void SetProgress (double)
virtual double GetProgress ()
void SetProgressText (const char *ptext)
virtual char * GetProgressText ()
virtual unsigned long GetErrorCode ()
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObjectGetInputDataObject (int port, int connection)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkEnSightWriterSafeDownCast (vtkObject *o)
*static vtkEnSightWriterNew ()

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 Member Functions inherited from vtkWriter
 vtkWriter ()
 ~vtkWriter ()
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual void SetNumberOfInputPorts (int n)
virtual void SetNumberOfOutputPorts (int n)
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutiveCreateDefaultExecutive ()
virtual void ReportReferences (vtkGarbageCollector *)
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetErrorCode (unsigned long)
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

char * Path
char * BaseName
char * FileName
int TimeStep
int GhostLevelMultiplier
int ProcessNumber
int NumberOfProcesses
int NumberOfBlocks
int * BlockIDs
bool TransientGeometry
int GhostLevel
vtkUnstructuredGridTmpInput
vtkModelMetadataModelMetadata
- Protected Attributes inherited from vtkWriter
vtkTimeStamp WriteTime
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
double Progress
char * ProgressText
unsigned long ErrorCode
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

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.


Member Typedef Documentation

Reimplemented from vtkWriter.

Definition at line 44 of file vtkEnSightWriter.h.


Constructor & Destructor Documentation

vtkEnSightWriter::vtkEnSightWriter ( )
protected
virtual vtkEnSightWriter::~vtkEnSightWriter ( )
protectedvirtual
vtkEnSightWriter::vtkEnSightWriter ( const vtkEnSightWriter )
protected

Member Function Documentation

virtual const char* vtkEnSightWriter::GetClassName ( )
virtual

Reimplemented from vtkWriter.

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

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

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

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)
inlinevirtual

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 ( )
inlinevirtual

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 
)
protectedvirtual

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 ( )
protectedvirtual

Implements vtkWriter.

virtual void vtkEnSightWriter::WriteStringToFile ( const char *  string,
FILE *  file 
)
protectedvirtual
virtual void vtkEnSightWriter::WriteTerminatedStringToFile ( const char *  string,
FILE *  file 
)
protectedvirtual
virtual void vtkEnSightWriter::WriteIntToFile ( const int  i,
FILE *  file 
)
protectedvirtual
virtual void vtkEnSightWriter::WriteFloatToFile ( const float  f,
FILE *  file 
)
protectedvirtual
virtual void vtkEnSightWriter::WriteElementTypeToFile ( int  ElementType,
FILE *  fd 
)
protectedvirtual
virtual bool vtkEnSightWriter::ShouldWriteGeometry ( )
protectedvirtual
virtual void vtkEnSightWriter::SanitizeFileName ( char *  name)
protectedvirtual
virtual FILE* vtkEnSightWriter::OpenFile ( char *  name)
protectedvirtual
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: