vtkCGNSReader Class Reference

vtkCGNSReader creates a multi-block dataset and reads unstructured grids, and structured meshes from binary files stored in CGNS file format, with data stored at the nodes or at the cells. More...

#include <vtkCGNSReader.h>

Inheritance diagram for vtkCGNSReader:

Collaboration diagram for vtkCGNSReader:

Public Types
typedef vtkMultiBlockDataSetAlgorithm	Superclass
Public Types inherited from vtkMultiBlockDataSetAlgorithm
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
int	CanReadFile (const char *filename)
	Is the given file name a CGNS file? More...
vtkDataArraySelection *	GetBaseSelection ()
	Returns access to the base selection object. More...
vtkDataArraySelection *	GetFamilySelection ()
	Returns access to the family selection object. More...
virtual void	SetDoublePrecisionMesh (int)
virtual int	GetDoublePrecisionMesh ()
virtual void	DoublePrecisionMeshOn ()
virtual void	DoublePrecisionMeshOff ()
virtual void	SetCreateEachSolutionAsBlock (int)
	This option is provided for debugging and should not be used for production runs as the output data produced may not be correct. More...
virtual int	GetCreateEachSolutionAsBlock ()
virtual void	CreateEachSolutionAsBlockOn ()
virtual void	CreateEachSolutionAsBlockOff ()
virtual void	SetIgnoreFlowSolutionPointers (bool)
	When set to true (default is false), the reader will simply ignore FlowSolutionPointers since they are either incomplete or invalid and instead will rely on FlowSolution_t nodes being labelled as "...AtStep<tsindex>" to locate solution nodes for a specific timestep. More...
virtual bool	GetIgnoreFlowSolutionPointers ()
virtual void	IgnoreFlowSolutionPointersOn ()
virtual void	IgnoreFlowSolutionPointersOff ()
virtual void	SetUseUnsteadyPattern (bool)
	When set to true (default is false), the reader will try to determine to determine FlowSolution_t nodes to read with a pattern matching This can be useful for unsteady solutions when FlowSolutionPointers are not reliable. More...
virtual bool	GetUseUnsteadyPattern ()
virtual void	UseUnsteadyPatternOn ()
virtual void	UseUnsteadyPatternOff ()
virtual void	SetDistributeBlocks (bool)
	This reader can support piece requests by distributing each block in each zone across ranks (default). More...
virtual bool	GetDistributeBlocks ()
virtual void	DistributeBlocksOn ()
virtual void	DistributeBlocksOff ()
void	Broadcast (vtkMultiProcessController *ctrl)
	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. More...
virtual void	SetFileName (const char *)
	Specify file name of CGNS datafile to read. More...
virtual char *	GetFileName ()
	Specify file name of CGNS datafile to read. More...
int	GetBaseArrayStatus (const char *name)
	API to select bases to read. More...
void	SetBaseArrayStatus (const char *name, int status)
	API to select bases to read. More...
void	DisableAllBases ()
	API to select bases to read. More...
void	EnableAllBases ()
	API to select bases to read. More...
int	GetNumberOfBaseArrays ()
	API to select bases to read. More...
const char *	GetBaseArrayName (int index)
	API to select bases to read. More...
int	GetNumberOfFamilyArrays ()
	API to select families to read. More...
const char *	GetFamilyArrayName (int index)
	API to select families to read. More...
void	SetFamilyArrayStatus (const char *name, int status)
	API to select families to read. More...
int	GetFamilyArrayStatus (const char *name)
	API to select families to read. More...
void	EnableAllFamilies ()
	API to select families to read. More...
void	DisableAllFamilies ()
	API to select families to read. More...
int	GetNumberOfPointArrays ()
	API to get information of point arrays and enable/disable loading of a particular arrays. More...
const char *	GetPointArrayName (int index)
	API to get information of point arrays and enable/disable loading of a particular arrays. More...
int	GetPointArrayStatus (const char *name)
	API to get information of point arrays and enable/disable loading of a particular arrays. More...
void	SetPointArrayStatus (const char *name, int status)
	API to get information of point arrays and enable/disable loading of a particular arrays. More...
void	DisableAllPointArrays ()
	API to get information of point arrays and enable/disable loading of a particular arrays. More...
void	EnableAllPointArrays ()
	API to get information of point arrays and enable/disable loading of a particular arrays. More...
int	GetNumberOfCellArrays ()
	API to get information of cell arrays and enable/disable loading of a particular arrays. More...
const char *	GetCellArrayName (int index)
	API to get information of cell arrays and enable/disable loading of a particular arrays. More...
int	GetCellArrayStatus (const char *name)
	API to get information of cell arrays and enable/disable loading of a particular arrays. More...
void	SetCellArrayStatus (const char *name, int status)
	API to get information of cell arrays and enable/disable loading of a particular arrays. More...
void	DisableAllCellArrays ()
	API to get information of cell arrays and enable/disable loading of a particular arrays. More...
void	EnableAllCellArrays ()
	API to get information of cell arrays and enable/disable loading of a particular arrays. More...
virtual void	SetLoadBndPatch (bool)
	Enable/disable loading of boundary condition patches. More...
virtual bool	GetLoadBndPatch ()
	Enable/disable loading of boundary condition patches. More...
virtual void	LoadBndPatchOn ()
	Enable/disable loading of boundary condition patches. More...
virtual void	LoadBndPatchOff ()
	Enable/disable loading of boundary condition patches. More...
virtual void	SetLoadMesh (bool)
	Enable/disable loading of zone mesh. More...
virtual bool	GetLoadMesh ()
	Enable/disable loading of zone mesh. More...
virtual void	LoadMeshOn ()
	Enable/disable loading of zone mesh. More...
virtual void	LoadMeshOff ()
	Enable/disable loading of zone mesh. More...
void	SetCacheMesh (bool enable)
	This reader can cache the mesh points if they are time invariant. More...
virtual bool	GetCacheMesh ()
	This reader can cache the mesh points if they are time invariant. More...
virtual void	CacheMeshOn ()
	This reader can cache the mesh points if they are time invariant. More...
virtual void	CacheMeshOff ()
	This reader can cache the mesh points if they are time invariant. More...
void	SetCacheConnectivity (bool enable)
	This reader can cache the meshconnectivities if they are time invariant. More...
virtual bool	GetCacheConnectivity ()
	This reader can cache the mesh points if they are time invariant. More...
virtual void	CacheConnectivityOn ()
	This reader can cache the mesh points if they are time invariant. More...
virtual void	CacheConnectivityOff ()
	This reader can cache the mesh points if they are time invariant. More...
void	SetController (vtkMultiProcessController *c)
	Set/get the communication object used to relay a list of files from the rank 0 process to all others. More...
virtual vtkMultiProcessController *	GetController ()
	This reader can cache the mesh points if they are time invariant. More...
Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm
vtkMultiBlockDataSetAlgorithm *	NewInstance () const
vtkMultiBlockDataSet *	GetOutput ()
vtkMultiBlockDataSet *	GetOutput (int)
void	SetInputData (vtkDataObject *)
void	SetInputData (int, vtkDataObject *)
virtual int	ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
vtkMultiBlockDataSet *	GetOutput ()
vtkMultiBlockDataSet *	GetOutput (int)
void	SetInputData (vtkDataObject *)
void	SetInputData (int, vtkDataObject *)
virtual int	ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
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 vtkCGNSReader *	New ()
static int	IsTypeOf (const char *type)
static vtkCGNSReader *	SafeDownCast (vtkObject *o)
static vtkInformationStringKey *	FAMILY ()
	Key used to put a family name in the meta-data associated with a node. More...
Static Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm
static vtkMultiBlockDataSetAlgorithm *	New ()
static int	IsTypeOf (const char *type)
static vtkMultiBlockDataSetAlgorithm *	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
	vtkCGNSReader ()
	~vtkCGNSReader () override
int	FillOutputPortInformation (int port, vtkInformation *info) override
int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
int	RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
int	GetCurvilinearZone (int base, int zone, int cell_dim, int phys_dim, void *zsize, vtkMultiBlockDataSet *mbase)
int	GetUnstructuredZone (int base, int zone, int cell_dim, int phys_dim, void *zsize, vtkMultiBlockDataSet *mbase)
Protected Member Functions inherited from vtkMultiBlockDataSetAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkMultiBlockDataSetAlgorithm ()
	~vtkMultiBlockDataSetAlgorithm ()
virtual vtkExecutive *	CreateDefaultExecutive ()
virtual int	FillInputPortInformation (int port, vtkInformation *info)
vtkDataObject *	GetInput (int port)
virtual int	RequestDataObject (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int	RequestDataObject (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()
	~vtkAlgorithm ()
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)
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
vtkNew< vtkDataArraySelection >	BaseSelection
vtkNew< vtkDataArraySelection >	FamilySelection
vtkNew< vtkDataArraySelection >	CellDataArraySelection
vtkNew< vtkDataArraySelection >	PointDataArraySelection
vtkMultiProcessController *	Controller
vtkIdType	ProcRank
vtkIdType	ProcSize
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

vtkCGNSReader creates a multi-block dataset and reads unstructured grids, and structured meshes from binary files stored in CGNS file format, with data stored at the nodes or at the cells.

vtkCGNSReader is inspired by the VisIt CGNS reader originally written by B. Whitlock. vtkCGNSReader relies on the low level CGNS API to load DataSet and reduce memory footprint.

Warning

...

Thanks:

Thanks to .

Definition at line 56 of file vtkCGNSReader.h.

Member Typedef Documentation

Superclass

typedef vtkMultiBlockDataSetAlgorithm vtkCGNSReader::Superclass

Definition at line 60 of file vtkCGNSReader.h.

Constructor & Destructor Documentation

vtkCGNSReader()

vtkCGNSReader::vtkCGNSReader ( )

protected

~vtkCGNSReader()

vtkCGNSReader::~vtkCGNSReader ( )

overrideprotected

Member Function Documentation

New()

static vtkCGNSReader* vtkCGNSReader::New ( )

static

GetClassName()

virtual const char* vtkCGNSReader::GetClassName ( )

virtual

IsTypeOf()

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

static

IsA()

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

virtual

Reimplemented from vtkMultiBlockDataSetAlgorithm.

SafeDownCast()

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

static

PrintSelf()

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

overridevirtual

Reimplemented from vtkMultiBlockDataSetAlgorithm.

SetFileName()

virtual void vtkCGNSReader::SetFileName ( const char *  )

virtual

Specify file name of CGNS datafile to read.

GetFileName()

virtual char* vtkCGNSReader::GetFileName ( )

virtual

Specify file name of CGNS datafile to read.

CanReadFile()

int vtkCGNSReader::CanReadFile

(

const char *

filename

)

Is the given file name a CGNS file?

GetBaseSelection()

vtkDataArraySelection* vtkCGNSReader::GetBaseSelection

(

)

Returns access to the base selection object.

GetFamilySelection()

vtkDataArraySelection* vtkCGNSReader::GetFamilySelection

(

)

Returns access to the family selection object.

GetBaseArrayStatus()

int vtkCGNSReader::GetBaseArrayStatus

(

const char *

name

)

API to select bases to read.

These calls simply forward to the vtkDataArraySelection instance obtained from GetBaseSelection().

By default, 0-th base is enabled and all others are disabled.

SetBaseArrayStatus()

void vtkCGNSReader::SetBaseArrayStatus	(	const char *	name,
		int	status
	)

API to select bases to read.

These calls simply forward to the vtkDataArraySelection instance obtained from GetBaseSelection().

By default, 0-th base is enabled and all others are disabled.

DisableAllBases()

void vtkCGNSReader::DisableAllBases

(

)

API to select bases to read.

These calls simply forward to the vtkDataArraySelection instance obtained from GetBaseSelection().

By default, 0-th base is enabled and all others are disabled.

EnableAllBases()

void vtkCGNSReader::EnableAllBases

(

)

API to select bases to read.

These calls simply forward to the vtkDataArraySelection instance obtained from GetBaseSelection().

By default, 0-th base is enabled and all others are disabled.

GetNumberOfBaseArrays()

int vtkCGNSReader::GetNumberOfBaseArrays

(

)

API to select bases to read.

These calls simply forward to the vtkDataArraySelection instance obtained from GetBaseSelection().

By default, 0-th base is enabled and all others are disabled.

GetBaseArrayName()

const char* vtkCGNSReader::GetBaseArrayName

(

int

index

)

API to select bases to read.

These calls simply forward to the vtkDataArraySelection instance obtained from GetBaseSelection().

By default, 0-th base is enabled and all others are disabled.

GetNumberOfFamilyArrays()

int vtkCGNSReader::GetNumberOfFamilyArrays

(

)

API to select families to read.

These calls simply forward to the vtkDataArraySelection instance obtained from GetFamilySelection().

GetFamilyArrayName()

const char* vtkCGNSReader::GetFamilyArrayName

(

int

index

)

API to select families to read.

These calls simply forward to the vtkDataArraySelection instance obtained from GetFamilySelection().

SetFamilyArrayStatus()

void vtkCGNSReader::SetFamilyArrayStatus	(	const char *	name,
		int	status
	)

API to select families to read.

These calls simply forward to the vtkDataArraySelection instance obtained from GetFamilySelection().

GetFamilyArrayStatus()

int vtkCGNSReader::GetFamilyArrayStatus

(

const char *

name

)

API to select families to read.

These calls simply forward to the vtkDataArraySelection instance obtained from GetFamilySelection().

EnableAllFamilies()

void vtkCGNSReader::EnableAllFamilies

(

)

API to select families to read.

These calls simply forward to the vtkDataArraySelection instance obtained from GetFamilySelection().

DisableAllFamilies()

void vtkCGNSReader::DisableAllFamilies

(

)

API to select families to read.

These calls simply forward to the vtkDataArraySelection instance obtained from GetFamilySelection().

GetNumberOfPointArrays()

int vtkCGNSReader::GetNumberOfPointArrays

(

)

API to get information of point arrays and enable/disable loading of a particular arrays.

GetPointArrayName()

const char* vtkCGNSReader::GetPointArrayName

(

int

index

)

API to get information of point arrays and enable/disable loading of a particular arrays.

GetPointArrayStatus()

int vtkCGNSReader::GetPointArrayStatus

(

const char *

name

)

API to get information of point arrays and enable/disable loading of a particular arrays.

SetPointArrayStatus()

void vtkCGNSReader::SetPointArrayStatus	(	const char *	name,
		int	status
	)

API to get information of point arrays and enable/disable loading of a particular arrays.

DisableAllPointArrays()

void vtkCGNSReader::DisableAllPointArrays

(

)

API to get information of point arrays and enable/disable loading of a particular arrays.

EnableAllPointArrays()

void vtkCGNSReader::EnableAllPointArrays

(

)

API to get information of point arrays and enable/disable loading of a particular arrays.

GetNumberOfCellArrays()

int vtkCGNSReader::GetNumberOfCellArrays

(

)

API to get information of cell arrays and enable/disable loading of a particular arrays.

GetCellArrayName()

const char* vtkCGNSReader::GetCellArrayName

(

int

index

)

API to get information of cell arrays and enable/disable loading of a particular arrays.

GetCellArrayStatus()

int vtkCGNSReader::GetCellArrayStatus

(

const char *

name

)

API to get information of cell arrays and enable/disable loading of a particular arrays.

SetCellArrayStatus()

void vtkCGNSReader::SetCellArrayStatus	(	const char *	name,
		int	status
	)

API to get information of cell arrays and enable/disable loading of a particular arrays.

DisableAllCellArrays()

void vtkCGNSReader::DisableAllCellArrays

(

)

API to get information of cell arrays and enable/disable loading of a particular arrays.

EnableAllCellArrays()

void vtkCGNSReader::EnableAllCellArrays

(

)

API to get information of cell arrays and enable/disable loading of a particular arrays.

SetDoublePrecisionMesh()

virtual void vtkCGNSReader::SetDoublePrecisionMesh ( int  )

virtual

GetDoublePrecisionMesh()

virtual int vtkCGNSReader::GetDoublePrecisionMesh ( )

virtual

DoublePrecisionMeshOn()

virtual void vtkCGNSReader::DoublePrecisionMeshOn ( )

virtual

DoublePrecisionMeshOff()

virtual void vtkCGNSReader::DoublePrecisionMeshOff ( )

virtual

SetLoadBndPatch()

virtual void vtkCGNSReader::SetLoadBndPatch ( bool  )

virtual

Enable/disable loading of boundary condition patches.

Defaults to false.

GetLoadBndPatch()

virtual bool vtkCGNSReader::GetLoadBndPatch ( )

virtual

Enable/disable loading of boundary condition patches.

Defaults to false.

LoadBndPatchOn()

virtual void vtkCGNSReader::LoadBndPatchOn ( )

virtual

Enable/disable loading of boundary condition patches.

Defaults to false.

LoadBndPatchOff()

virtual void vtkCGNSReader::LoadBndPatchOff ( )

virtual

Enable/disable loading of boundary condition patches.

Defaults to false.

SetLoadMesh()

virtual void vtkCGNSReader::SetLoadMesh ( bool  )

virtual

Enable/disable loading of zone mesh.

Defaults to true. It may be turned off to load only boundary patches (when LoadBndPatch if ON), for example.

GetLoadMesh()

virtual bool vtkCGNSReader::GetLoadMesh ( )

virtual

Enable/disable loading of zone mesh.

Defaults to true. It may be turned off to load only boundary patches (when LoadBndPatch if ON), for example.

LoadMeshOn()

virtual void vtkCGNSReader::LoadMeshOn ( )

virtual

Enable/disable loading of zone mesh.

Defaults to true. It may be turned off to load only boundary patches (when LoadBndPatch if ON), for example.

LoadMeshOff()

virtual void vtkCGNSReader::LoadMeshOff ( )

virtual

Enable/disable loading of zone mesh.

Defaults to true. It may be turned off to load only boundary patches (when LoadBndPatch if ON), for example.

SetCreateEachSolutionAsBlock()

virtual void vtkCGNSReader::SetCreateEachSolutionAsBlock ( int  )

virtual

This option is provided for debugging and should not be used for production runs as the output data produced may not be correct.

When set to true, the read will simply read each solution (FlowSolution_t) node encountered in a zone and create a separate block under the block corresponding to the zone in the output.

GetCreateEachSolutionAsBlock()

virtual int vtkCGNSReader::GetCreateEachSolutionAsBlock ( )

virtual

CreateEachSolutionAsBlockOn()

virtual void vtkCGNSReader::CreateEachSolutionAsBlockOn ( )

virtual

CreateEachSolutionAsBlockOff()

virtual void vtkCGNSReader::CreateEachSolutionAsBlockOff ( )

virtual

SetIgnoreFlowSolutionPointers()

virtual void vtkCGNSReader::SetIgnoreFlowSolutionPointers ( bool  )

virtual

When set to true (default is false), the reader will simply ignore FlowSolutionPointers since they are either incomplete or invalid and instead will rely on FlowSolution_t nodes being labelled as "...AtStep<tsindex>" to locate solution nodes for a specific timestep.

Note, tsindex starts with 1 (not zero).

When set to false, the reader will still try to confirm that at least one valid FlowSolution_t node is referred to in FlowSolutionPointers nodes for the current timestep. If none is found, then the reader will print out a warning and act as if IgnoreFlowSolutionPointers was set to true. To avoid this warning, one should set IgnoreFlowSolutionPointers to true.

GetIgnoreFlowSolutionPointers()

virtual bool vtkCGNSReader::GetIgnoreFlowSolutionPointers ( )

virtual

IgnoreFlowSolutionPointersOn()

virtual void vtkCGNSReader::IgnoreFlowSolutionPointersOn ( )

virtual

IgnoreFlowSolutionPointersOff()

virtual void vtkCGNSReader::IgnoreFlowSolutionPointersOff ( )

virtual

SetUseUnsteadyPattern()

virtual void vtkCGNSReader::SetUseUnsteadyPattern ( bool  )

virtual

When set to true (default is false), the reader will try to determine to determine FlowSolution_t nodes to read with a pattern matching This can be useful for unsteady solutions when FlowSolutionPointers are not reliable.

GetUseUnsteadyPattern()

virtual bool vtkCGNSReader::GetUseUnsteadyPattern ( )

virtual

UseUnsteadyPatternOn()

virtual void vtkCGNSReader::UseUnsteadyPatternOn ( )

virtual

UseUnsteadyPatternOff()

virtual void vtkCGNSReader::UseUnsteadyPatternOff ( )

virtual

SetDistributeBlocks()

virtual void vtkCGNSReader::SetDistributeBlocks ( bool  )

virtual

This reader can support piece requests by distributing each block in each zone across ranks (default).

To make the reader disregard piece request and read all blocks in the zone, set this to false (default is true).

GetDistributeBlocks()

virtual bool vtkCGNSReader::GetDistributeBlocks ( )

virtual

DistributeBlocksOn()

virtual void vtkCGNSReader::DistributeBlocksOn ( )

virtual

DistributeBlocksOff()

virtual void vtkCGNSReader::DistributeBlocksOff ( )

virtual

SetCacheMesh()

void vtkCGNSReader::SetCacheMesh

(

bool

enable

)

This reader can cache the mesh points if they are time invariant.

They will be stored with a unique reference to their /base/zonename and not be read in the file when doing unsteady analysis.

GetCacheMesh()

virtual bool vtkCGNSReader::GetCacheMesh ( )

virtual

This reader can cache the mesh points if they are time invariant.

They will be stored with a unique reference to their /base/zonename and not be read in the file when doing unsteady analysis.

CacheMeshOn()

virtual void vtkCGNSReader::CacheMeshOn ( )

virtual

This reader can cache the mesh points if they are time invariant.

They will be stored with a unique reference to their /base/zonename and not be read in the file when doing unsteady analysis.

CacheMeshOff()

virtual void vtkCGNSReader::CacheMeshOff ( )

virtual

This reader can cache the mesh points if they are time invariant.

They will be stored with a unique reference to their /base/zonename and not be read in the file when doing unsteady analysis.

SetCacheConnectivity()

void vtkCGNSReader::SetCacheConnectivity

(

bool

enable

)

This reader can cache the meshconnectivities if they are time invariant.

They will be stored with a unique reference to their /base/zonename and not be read in the file when doing unsteady analysis.

GetCacheConnectivity()

virtual bool vtkCGNSReader::GetCacheConnectivity ( )

virtual

This reader can cache the mesh points if they are time invariant.

They will be stored with a unique reference to their /base/zonename and not be read in the file when doing unsteady analysis.

CacheConnectivityOn()

virtual void vtkCGNSReader::CacheConnectivityOn ( )

virtual

This reader can cache the mesh points if they are time invariant.

They will be stored with a unique reference to their /base/zonename and not be read in the file when doing unsteady analysis.

CacheConnectivityOff()

virtual void vtkCGNSReader::CacheConnectivityOff ( )

virtual

This reader can cache the mesh points if they are time invariant.

They will be stored with a unique reference to their /base/zonename and not be read in the file when doing unsteady analysis.

SetController()

void vtkCGNSReader::SetController

(

vtkMultiProcessController *

c

)

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.

GetController()

virtual vtkMultiProcessController* vtkCGNSReader::GetController ( )

virtual

This reader can cache the mesh points if they are time invariant.

They will be stored with a unique reference to their /base/zonename and not be read in the file when doing unsteady analysis.

Broadcast()

void vtkCGNSReader::Broadcast

(

vtkMultiProcessController *

ctrl

)

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.

FAMILY()

static vtkInformationStringKey* vtkCGNSReader::FAMILY ( )

static

Key used to put a family name in the meta-data associated with a node.

FillOutputPortInformation()

int vtkCGNSReader::FillOutputPortInformation ( int  port, vtkInformation *  info  )

overrideprotectedvirtual

Reimplemented from vtkMultiBlockDataSetAlgorithm.

RequestData()

int vtkCGNSReader::RequestData ( vtkInformation *  , vtkInformationVector **  , vtkInformationVector *    )

overrideprotectedvirtual

Reimplemented from vtkMultiBlockDataSetAlgorithm.

RequestInformation()

int vtkCGNSReader::RequestInformation ( vtkInformation *  , vtkInformationVector **  , vtkInformationVector *    )

overrideprotectedvirtual

Reimplemented from vtkMultiBlockDataSetAlgorithm.

GetCurvilinearZone()

int vtkCGNSReader::GetCurvilinearZone ( int  base, int  zone, int  cell_dim, int  phys_dim, void *  zsize, vtkMultiBlockDataSet *  mbase  )

protected

GetUnstructuredZone()

int vtkCGNSReader::GetUnstructuredZone ( int  base, int  zone, int  cell_dim, int  phys_dim, void *  zsize, vtkMultiBlockDataSet *  mbase  )

protected

Friends And Related Function Documentation

vtkPrivate

friend class vtkPrivate

friend

Definition at line 303 of file vtkCGNSReader.h.

Member Data Documentation

BaseSelection

vtkNew<vtkDataArraySelection> vtkCGNSReader::BaseSelection

protected

Definition at line 260 of file vtkCGNSReader.h.

FamilySelection

vtkNew<vtkDataArraySelection> vtkCGNSReader::FamilySelection

protected

Definition at line 261 of file vtkCGNSReader.h.

CellDataArraySelection

vtkNew<vtkDataArraySelection> vtkCGNSReader::CellDataArraySelection

protected

Definition at line 263 of file vtkCGNSReader.h.

PointDataArraySelection

vtkNew<vtkDataArraySelection> vtkCGNSReader::PointDataArraySelection

protected

Definition at line 264 of file vtkCGNSReader.h.

Controller

vtkMultiProcessController* vtkCGNSReader::Controller

protected

Definition at line 271 of file vtkCGNSReader.h.

ProcRank

vtkIdType vtkCGNSReader::ProcRank

protected

Definition at line 272 of file vtkCGNSReader.h.

ProcSize

vtkIdType vtkCGNSReader::ProcSize

protected

Definition at line 273 of file vtkCGNSReader.h.

---

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

• /builds/gitlab-kitware-sciviz-ci/VTKExtensions/CGNSReader/vtkCGNSReader.h