Writes CGNS files. More...

#include <vtkCGNSWriter.h>

Inheritance diagram for vtkCGNSWriter:

[legend]

Collaboration diagram for vtkCGNSWriter:

[legend]

Public Types
typedef vtkWriter	Superclass

Public Types inherited from vtkWriter
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision

enum	DesiredOutputPrecision

typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override


virtual void	SetFileName (const char *)
	Set/Get Name for the output file. More...

virtual char *	GetFileName ()
	Set/Get Name for the output file. More...


void	SetUseHDF5 (bool)
	When UseHDF5 is turned ON, the CGNS file will use HDF5 as the underlying file format. More...

virtual bool	GetUseHDF5 ()
	When UseHDF5 is turned ON, the CGNS file will use HDF5 as the underlying file format. More...

virtual void	UseHDF5On ()
	When UseHDF5 is turned ON, the CGNS file will use HDF5 as the underlying file format. More...

virtual void	UseHDF5Off ()
	When UseHDF5 is turned ON, the CGNS file will use HDF5 as the underlying file format. More...


virtual void	SetWriteAllTimeSteps (bool)
	When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader. More...

virtual bool	GetWriteAllTimeSteps ()
	When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader. More...

virtual void	WriteAllTimeStepsOn ()
	When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader. More...

virtual void	WriteAllTimeStepsOff ()
	When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader. More...


virtual void	SetGhostLevel (int)
	Sets the GhostLevel. More...

virtual int	GetGhostLevel ()
	Sets the GhostLevel. More...


virtual char *	GetFileNameSuffix ()
	Provides an option to pad the time step when writing out time series data. More...

virtual void	SetFileNameSuffix (const char *)
	Provides an option to pad the time step when writing out time series data. More...

Public Member Functions inherited from vtkWriter
vtkWriter *	NewInstance () const

virtual int	Write ()

void	EncodeString (char resname, const char name, bool doublePercent)

void	EncodeWriteString (ostream out, const char name, bool doublePercent)

vtkDataObject *	GetInput ()

vtkDataObject *	GetInput (int port)

void	SetInputData (vtkDataObject *input)

void	SetInputData (int index, vtkDataObject *input)

void	SetInputData (vtkDataObject *input)

void	SetInputData (int index, vtkDataObject *input)

Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const

int	HasExecutive ()

vtkExecutive *	GetExecutive ()

virtual void	SetExecutive (vtkExecutive *executive)

virtual int	ModifyRequest (vtkInformation *request, int when)

vtkInformation *	GetInputPortInformation (int port)

vtkInformation *	GetOutputPortInformation (int port)

int	GetNumberOfInputPorts ()

int	GetNumberOfOutputPorts ()

void	UpdateProgress (double amount)

vtkInformation *	GetInputArrayInformation (int idx)

void	RemoveAllInputs ()

vtkDataObject *	GetOutputDataObject (int port)

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	RemoveInputConnection (int port, int idx)

virtual void	RemoveAllInputConnections (int port)

int	GetNumberOfInputConnections (int port)

int	GetTotalNumberOfInputConnections ()

vtkAlgorithmOutput *	GetInputConnection (int port, int index)

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)

vtkAlgorithm *	GetInputAlgorithm (int port, int index)

vtkExecutive *	GetInputExecutive (int port, int index)

vtkInformation *	GetInputInformation (int port, int index)

vtkInformation *	GetOutputInformation (int port)

virtual int	Update (int port, vtkInformationVector *requests)

virtual int	Update (vtkInformation *requests)

virtual int	UpdateExtent (const int extents[6])

virtual void	UpdateInformation ()

virtual void	UpdateDataObject ()

virtual void	PropagateUpdateExtent ()

virtual void	UpdateWholeExtent ()

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)

int	SetUpdateExtentToWholeExtent (int port)

int	SetUpdateExtentToWholeExtent ()

void	SetUpdateExtent (int port, int extent[6])

void	SetUpdateExtent (int extent[6])

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)

virtual vtkInformation *	GetInformation ()

virtual void	SetInformation (vtkInformation *)

void	Register (vtkObjectBase *o) VTK_OVERRIDE

void	UnRegister (vtkObjectBase *o) VTK_OVERRIDE

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)

vtkDataObject *	GetInputDataObject (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)

virtual void	SetInputDataObject (int port, vtkDataObject *data)

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)

vtkAlgorithmOutput *	GetOutputPort ()

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive ()

vtkInformation *	GetInputInformation ()

virtual void	Update (int port)

virtual void	Update ()

virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=0)

virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=0)

virtual void	SetReleaseDataFlag (int)

virtual int	GetReleaseDataFlag ()

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)

void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)

int *	GetUpdateExtent ()

int *	GetUpdateExtent (int port)

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int extent[6])

void	GetUpdateExtent (int port, int extent[6])

int	GetUpdatePiece ()

int	GetUpdatePiece (int port)

int	GetUpdateNumberOfPieces ()

int	GetUpdateNumberOfPieces (int port)

int	GetUpdateGhostLevel ()

int	GetUpdateGhostLevel (int port)

void	SetProgressObserver (vtkProgressObserver *)

virtual vtkProgressObserver *	GetProgressObserver ()

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)

virtual vtkInformation *	GetInformation ()

virtual void	SetInformation (vtkInformation *)

void	Register (vtkObjectBase *o) VTK_OVERRIDE

void	UnRegister (vtkObjectBase *o) VTK_OVERRIDE

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)

vtkDataObject *	GetInputDataObject (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)

virtual void	SetInputDataObject (int port, vtkDataObject *data)

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)

vtkAlgorithmOutput *	GetOutputPort ()

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive ()

vtkInformation *	GetInputInformation ()

virtual void	Update (int port)

virtual void	Update ()

virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=0)

virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=0)

virtual void	SetReleaseDataFlag (int)

virtual int	GetReleaseDataFlag ()

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)

void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)

int *	GetUpdateExtent ()

int *	GetUpdateExtent (int port)

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int extent[6])

void	GetUpdateExtent (int port, int extent[6])

int	GetUpdatePiece ()

int	GetUpdatePiece (int port)

int	GetUpdateNumberOfPieces ()

int	GetUpdateNumberOfPieces (int port)

int	GetUpdateGhostLevel ()

int	GetUpdateGhostLevel (int port)

void	SetProgressObserver (vtkProgressObserver *)

virtual vtkProgressObserver *	GetProgressObserver ()

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual vtkMTimeType	GetMTime ()

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (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 )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (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 )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

void	SetReferenceCount (int)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkCGNSWriter *	New ()

static int	IsTypeOf (const char *type)

static vtkCGNSWriter *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkWriter
static int	IsTypeOf (const char *type)

static vtkWriter *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkCGNSWriter ()

	~vtkCGNSWriter () override

int	ProcessRequest (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override

virtual int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual int	RequestUpdateExtent (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

int	FillInputPortInformation (int port, vtkInformation *info) override

int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override

void	WriteData () override

Protected Member Functions inherited from vtkWriter
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkWriter ()

	~vtkWriter ()

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 vtkExecutive *	CreateDefaultExecutive ()

void	ReportReferences (vtkGarbageCollector *) VTK_OVERRIDE

virtual void	SetNumberOfInputConnections (int port, int n)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)

int	GetInputArrayAssociation (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)

void	SetInputDataInternal (int port, vtkDataObject *input)

void	AddInputDataInternal (int port, vtkDataObject *input)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)

int	GetInputArrayAssociation (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)

virtual void	SetErrorCode (unsigned long)

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)

void	SetInputDataInternal (int port, vtkDataObject *input)

void	AddInputDataInternal (int port, vtkDataObject *input)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
char *	FileName = nullptr

bool	UseHDF5 = true

bool	WriteAllTimeSteps = false

char *	FileNameSuffix = nullptr

int	GhostLevel = 0

int	NumberOfTimeSteps = 0

int	CurrentTimeIndex = 0

vtkDoubleArray *	TimeValues = nullptr

vtkDataObject *	OriginalInput = nullptr

bool	WasWritingSuccessful = false

Protected Attributes inherited from vtkWriter
vtkTimeStamp	WriteTime

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkPrivate

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
	SINGLE_PRECISION

	DOUBLE_PRECISION

	DEFAULT_PRECISION

int	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

Writes CGNS files.

This writer writes (composite) datasets that may consist of

Definition at line 27 of file vtkCGNSWriter.h.

Member Typedef Documentation

◆ Superclass

typedef vtkWriter vtkCGNSWriter::Superclass

Definition at line 31 of file vtkCGNSWriter.h.

Constructor & Destructor Documentation

◆ vtkCGNSWriter()

vtkCGNSWriter::vtkCGNSWriter ( )

protected

◆ ~vtkCGNSWriter()

vtkCGNSWriter::~vtkCGNSWriter ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkCGNSWriter* vtkCGNSWriter::New ( )

static

◆ GetClassName()

virtual const char* vtkCGNSWriter::GetClassName ( )

virtual

Reimplemented in vtkPCGNSWriter.

◆ IsTypeOf()

static int vtkCGNSWriter::IsTypeOf ( const char * type )

static

◆ IsA()

virtual int vtkCGNSWriter::IsA ( const char * type )

virtual

Reimplemented from vtkWriter.

Reimplemented in vtkPCGNSWriter.

◆ SafeDownCast()

static vtkCGNSWriter* vtkCGNSWriter::SafeDownCast ( vtkObject * o )

static

◆ PrintSelf()

void vtkCGNSWriter::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Reimplemented from vtkWriter.

Reimplemented in vtkPCGNSWriter.

◆ SetFileName()

virtual void vtkCGNSWriter::SetFileName ( const char * )

virtual

Set/Get Name for the output file.

◆ GetFileName()

virtual char* vtkCGNSWriter::GetFileName ( )

virtual

Set/Get Name for the output file.

◆ SetUseHDF5()

void vtkCGNSWriter::SetUseHDF5 ( bool )

When UseHDF5 is turned ON, the CGNS file will use HDF5 as the underlying file format.

When turned OFF, the file will use ADF as the underlying file format.

The Default is ON.

◆ GetUseHDF5()

virtual bool vtkCGNSWriter::GetUseHDF5 ( )

virtual

When UseHDF5 is turned ON, the CGNS file will use HDF5 as the underlying file format.

When turned OFF, the file will use ADF as the underlying file format.

The Default is ON.

◆ UseHDF5On()

virtual void vtkCGNSWriter::UseHDF5On ( )

virtual

When UseHDF5 is turned ON, the CGNS file will use HDF5 as the underlying file format.

When turned OFF, the file will use ADF as the underlying file format.

The Default is ON.

◆ UseHDF5Off()

virtual void vtkCGNSWriter::UseHDF5Off ( )

virtual

When UseHDF5 is turned ON, the CGNS file will use HDF5 as the underlying file format.

When turned OFF, the file will use ADF as the underlying file format.

The Default is ON.

◆ SetWriteAllTimeSteps()

virtual void vtkCGNSWriter::SetWriteAllTimeSteps ( bool )

virtual

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

The Default is OFF.

◆ GetWriteAllTimeSteps()

virtual bool vtkCGNSWriter::GetWriteAllTimeSteps ( )

virtual

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

The Default is OFF.

◆ WriteAllTimeStepsOn()

virtual void vtkCGNSWriter::WriteAllTimeStepsOn ( )

virtual

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

The Default is OFF.

◆ WriteAllTimeStepsOff()

virtual void vtkCGNSWriter::WriteAllTimeStepsOff ( )

virtual

When WriteAllTimeSteps is turned ON, the writer is executed once for each timestep available from the reader.

The Default is OFF.

◆ SetGhostLevel()

virtual void vtkCGNSWriter::SetGhostLevel ( int )

virtual

Sets the GhostLevel.

Currently, this does nothing, but this property is present to ensure compatibility with ParaView.

The Default is 0.

◆ GetGhostLevel()

virtual int vtkCGNSWriter::GetGhostLevel ( )

virtual

Sets the GhostLevel.

Currently, this does nothing, but this property is present to ensure compatibility with ParaView.

The Default is 0.

◆ GetFileNameSuffix()

virtual char* vtkCGNSWriter::GetFileNameSuffix ( )

virtual

Provides an option to pad the time step when writing out time series data.

Only allow this format: ABC%.Xd where ABC is an arbitrary string which may or may not exist and d must exist and d must be the last character '.' and X may or may not exist, X must be an integer if it exists. Default is nullptr.

◆ SetFileNameSuffix()

virtual void vtkCGNSWriter::SetFileNameSuffix ( const char * )

virtual

Provides an option to pad the time step when writing out time series data.

Only allow this format: ABC%.Xd where ABC is an arbitrary string which may or may not exist and d must exist and d must be the last character '.' and X may or may not exist, X must be an integer if it exists. Default is nullptr.

◆ ProcessRequest()

int vtkCGNSWriter::ProcessRequest	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)

overrideprotectedvirtual

Reimplemented from vtkWriter.

Reimplemented in vtkPCGNSWriter.

◆ RequestInformation()

virtual int vtkCGNSWriter::RequestInformation	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)

protectedvirtual

Reimplemented in vtkPCGNSWriter.

◆ RequestUpdateExtent()

virtual int vtkCGNSWriter::RequestUpdateExtent	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)

protectedvirtual

Reimplemented in vtkPCGNSWriter.

◆ FillInputPortInformation()

int vtkCGNSWriter::FillInputPortInformation	(	int	port,
		vtkInformation *	info
	)

overrideprotectedvirtual

Reimplemented from vtkAlgorithm.

◆ RequestData()

int vtkCGNSWriter::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)

overrideprotectedvirtual

Reimplemented from vtkWriter.

◆ WriteData()

void vtkCGNSWriter::WriteData ( )

overrideprotectedvirtual

Implements vtkWriter.

Reimplemented in vtkPCGNSWriter.

Friends And Related Function Documentation

◆ vtkPrivate

friend class vtkPrivate

friend

Definition at line 128 of file vtkCGNSWriter.h.

Member Data Documentation

◆ FileName

char* vtkCGNSWriter::FileName = nullptr

protected

Definition at line 111 of file vtkCGNSWriter.h.

◆ UseHDF5

bool vtkCGNSWriter::UseHDF5 = true

protected

Definition at line 112 of file vtkCGNSWriter.h.

◆ WriteAllTimeSteps

bool vtkCGNSWriter::WriteAllTimeSteps = false

protected

Definition at line 113 of file vtkCGNSWriter.h.

◆ FileNameSuffix

char* vtkCGNSWriter::FileNameSuffix = nullptr

protected

Definition at line 114 of file vtkCGNSWriter.h.

◆ GhostLevel

int vtkCGNSWriter::GhostLevel = 0

protected

Definition at line 116 of file vtkCGNSWriter.h.

◆ NumberOfTimeSteps

int vtkCGNSWriter::NumberOfTimeSteps = 0

protected

Definition at line 117 of file vtkCGNSWriter.h.

◆ CurrentTimeIndex

int vtkCGNSWriter::CurrentTimeIndex = 0

protected

Definition at line 118 of file vtkCGNSWriter.h.

◆ TimeValues

vtkDoubleArray* vtkCGNSWriter::TimeValues = nullptr

protected

Definition at line 119 of file vtkCGNSWriter.h.

◆ OriginalInput

vtkDataObject* vtkCGNSWriter::OriginalInput = nullptr

protected

Definition at line 121 of file vtkCGNSWriter.h.

◆ WasWritingSuccessful

bool vtkCGNSWriter::WasWritingSuccessful = false

protected

Definition at line 122 of file vtkCGNSWriter.h.

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

/builds/gitlab-kitware-sciviz-ci/VTKExtensions/IOCGNS/vtkCGNSWriter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkCGNSWriter()

◆ ~vtkCGNSWriter()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetFileName()

◆ GetFileName()

◆ SetUseHDF5()

◆ GetUseHDF5()

◆ UseHDF5On()

◆ UseHDF5Off()

◆ SetWriteAllTimeSteps()

◆ GetWriteAllTimeSteps()

◆ WriteAllTimeStepsOn()

◆ WriteAllTimeStepsOff()

◆ SetGhostLevel()

◆ GetGhostLevel()

◆ GetFileNameSuffix()

◆ SetFileNameSuffix()

◆ ProcessRequest()

◆ RequestInformation()

◆ RequestUpdateExtent()

◆ FillInputPortInformation()

◆ RequestData()

◆ WriteData()

Friends And Related Function Documentation

◆ vtkPrivate

Member Data Documentation

◆ FileName

◆ UseHDF5

◆ WriteAllTimeSteps

◆ FileNameSuffix

◆ GhostLevel

◆ NumberOfTimeSteps

◆ CurrentTimeIndex

◆ TimeValues

◆ OriginalInput

◆ WasWritingSuccessful