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, cells or faces. More...

#include <vtkCGNSReader.h>

Inheritance diagram for vtkCGNSReader:

[legend]

Collaboration diagram for vtkCGNSReader:

[legend]

Public Types
enum	DataArrayLocation { CELL_DATA = 0 , FACE_DATA }

typedef vtkMultiBlockDataSetAlgorithm	Superclass

Public Types inherited from vtkMultiBlockDataSetAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
	Values used for setting the desired output precision for various algorithms. More...

typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkCGNSReader *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

int	CanReadFile (VTK_FILEPATH const char *filename)
	Is the given file name a CGNS file?

vtkDataArraySelection *	GetBaseSelection ()
	Returns access to the base selection object.

vtkDataArraySelection *	GetFamilySelection ()
	Returns access to the family selection object.

virtual vtkDataArraySelection *	GetCellDataArraySelection ()
	Return selection of cell arrays.

virtual vtkDataArraySelection *	GetFaceDataArraySelection ()
	Return selection of face arrays.

virtual vtkDataArraySelection *	GetPointDataArraySelection ()
	Return selection of point arrays.

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.


virtual void	SetDataLocation (int)
	Set/get the location of the data arrays to read.

virtual int	GetDataLocation ()
	Set/get the location of the data arrays to read.


	vtkSetStdStringFromCharMacro (FileName)
	Specify file name of CGNS datafile to read.

	vtkGetCharFromStdStringMacro (FileName)
	Specify file name of CGNS datafile to read.


int	GetBaseArrayStatus (const char *name)
	API to select bases to read.

void	SetBaseArrayStatus (const char *name, int status)
	API to select bases to read.

void	DisableAllBases ()
	API to select bases to read.

void	EnableAllBases ()
	API to select bases to read.

int	GetNumberOfBaseArrays ()
	API to select bases to read.

const char *	GetBaseArrayName (int index)
	API to select bases to read.


int	GetNumberOfFamilyArrays ()
	API to select families to read.

const char *	GetFamilyArrayName (int index)
	API to select families to read.

void	SetFamilyArrayStatus (const char *name, int status)
	API to select families to read.

int	GetFamilyArrayStatus (const char *name)
	API to select families to read.

void	EnableAllFamilies ()
	API to select families to read.

void	DisableAllFamilies ()
	API to select families to read.


int	GetNumberOfPointArrays ()
	API to get information of point arrays and enable/disable loading of particular arrays.

const char *	GetPointArrayName (int index)
	API to get information of point arrays and enable/disable loading of particular arrays.

int	GetPointArrayStatus (const char *name)
	API to get information of point arrays and enable/disable loading of particular arrays.

void	SetPointArrayStatus (const char *name, int status)
	API to get information of point arrays and enable/disable loading of particular arrays.

void	DisableAllPointArrays ()
	API to get information of point arrays and enable/disable loading of particular arrays.

void	EnableAllPointArrays ()
	API to get information of point arrays and enable/disable loading of particular arrays.


int	GetNumberOfCellArrays ()
	API to get information of cell arrays and enable/disable loading of particular arrays.

const char *	GetCellArrayName (int index)
	API to get information of cell arrays and enable/disable loading of particular arrays.

int	GetCellArrayStatus (const char *name)
	API to get information of cell arrays and enable/disable loading of particular arrays.

void	SetCellArrayStatus (const char *name, int status)
	API to get information of cell arrays and enable/disable loading of particular arrays.

void	DisableAllCellArrays ()
	API to get information of cell arrays and enable/disable loading of particular arrays.

void	EnableAllCellArrays ()
	API to get information of cell arrays and enable/disable loading of particular arrays.


int	GetNumberOfFaceArrays ()
	API to get information of face arrays and enable/disable loading of particular arrays.

const char *	GetFaceArrayName (int index)
	API to get information of face arrays and enable/disable loading of particular arrays.

int	GetFaceArrayStatus (const char *name)
	API to get information of face arrays and enable/disable loading of particular arrays.

void	SetFaceArrayStatus (const char *name, int status)
	API to get information of face arrays and enable/disable loading of particular arrays.

void	DisableAllFaceArrays ()
	API to get information of face arrays and enable/disable loading of particular arrays.

void	EnableAllFaceArrays ()
	API to get information of face arrays and enable/disable loading of particular arrays.


virtual void	SetDoublePrecisionMesh (int)
	Enable/disable double precision when reading the mesh.

virtual int	GetDoublePrecisionMesh ()
	Enable/disable double precision when reading the mesh.

virtual void	DoublePrecisionMeshOn ()
	Enable/disable double precision when reading the mesh.

virtual void	DoublePrecisionMeshOff ()
	Enable/disable double precision when reading the mesh.


virtual void	SetLoadBndPatch (bool)
	Enable/disable loading of boundary condition patches.

virtual bool	GetLoadBndPatch ()
	Enable/disable loading of boundary condition patches.

virtual void	LoadBndPatchOn ()
	Enable/disable loading of boundary condition patches.

virtual void	LoadBndPatchOff ()
	Enable/disable loading of boundary condition patches.


virtual void	SetLoadSurfacePatch (bool)
	Enable/disable loading of surface patches.

virtual bool	GetLoadSurfacePatch ()
	Enable/disable loading of surface patches.

virtual void	LoadSurfacePatchOn ()
	Enable/disable loading of surface patches.

virtual void	LoadSurfacePatchOff ()
	Enable/disable loading of surface patches.


virtual void	SetLoadMesh (bool)
	Enable/disable loading of zone mesh.

virtual bool	GetLoadMesh ()
	Enable/disable loading of zone mesh.

virtual void	LoadMeshOn ()
	Enable/disable loading of zone mesh.

virtual void	LoadMeshOff ()
	Enable/disable loading of zone mesh.


virtual void	SetUse3DVector (bool)
	Enable/disable adding an empty physical dimension to vectors in case of 2D solutions.

virtual bool	GetUse3DVector ()
	Enable/disable adding an empty physical dimension to vectors in case of 2D solutions.

virtual void	Use3DVectorOn ()
	Enable/disable adding an empty physical dimension to vectors in case of 2D solutions.

virtual void	Use3DVectorOff ()
	Enable/disable adding an empty physical dimension to vectors in case of 2D solutions.


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.

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

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

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


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.

virtual bool	GetIgnoreFlowSolutionPointers ()
	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.

virtual void	IgnoreFlowSolutionPointersOn ()
	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.

virtual void	IgnoreFlowSolutionPointersOff ()
	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.


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 pattern matching.

virtual bool	GetUseUnsteadyPattern ()
	When set to true (default is false), the reader will try to determine to determine FlowSolution_t nodes to read with pattern matching.

virtual void	UseUnsteadyPatternOn ()
	When set to true (default is false), the reader will try to determine to determine FlowSolution_t nodes to read with pattern matching.

virtual void	UseUnsteadyPatternOff ()
	When set to true (default is false), the reader will try to determine to determine FlowSolution_t nodes to read with pattern matching.


virtual void	SetUnsteadySolutionStartTimestep (int)
	Set/get the index of the first timestep when reading unsteady solutions.

virtual int	GetUnsteadySolutionStartTimestep ()
	Set/get the index of the first timestep when reading unsteady solutions.


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

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

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

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


void	SetCacheMesh (bool enable)
	This reader can cache the mesh points if they are time invariant.

virtual bool	GetCacheMesh ()
	This reader can cache the mesh points if they are time invariant.

virtual void	CacheMeshOn ()
	This reader can cache the mesh points if they are time invariant.

virtual void	CacheMeshOff ()
	This reader can cache the mesh points if they are time invariant.


void	SetCacheConnectivity (bool enable)
	This reader can cache the mesh connectivities if they are time invariant.

virtual bool	GetCacheConnectivity ()
	This reader can cache the mesh connectivities if they are time invariant.

virtual void	CacheConnectivityOn ()
	This reader can cache the mesh connectivities if they are time invariant.

virtual void	CacheConnectivityOff ()
	This reader can cache the mesh connectivities if they are time invariant.


void	SetController (vtkMultiProcessController *c)
	Set/get the communication object used to relay a list of files from the rank 0 process to all others.

virtual vtkMultiProcessController *	GetController ()
	Set/get the communication object used to relay a list of files from the rank 0 process to all others.

Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkMultiBlockDataSetAlgorithm *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override
	see vtkAlgorithm for details

vtkMultiBlockDataSet *	GetOutput ()
	Get the output data object for a port on this algorithm.

vtkMultiBlockDataSet *	GetOutput (int)
	Get the output data object for a port on this algorithm.

void	SetInputData (vtkDataObject *)
	Assign a data object as input.

void	SetInputData (int, vtkDataObject *)
	Assign a data object as input.

Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkAlgorithm *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

vtkTypeBool	HasExecutive ()
	Check whether this algorithm has an assigned executive.

vtkExecutive *	GetExecutive ()
	Get this algorithm's executive.

virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive.

virtual vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inInfo, vtkInformationVector outInfo)
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.

vtkTypeBool	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped.

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
	A special version of ProcessRequest meant specifically for the pipeline modified time request.

virtual int	ModifyRequest (vtkInformation *request, int when)
	This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.

vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port.

vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port.

int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm.

int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm.

void	SetAbortExecuteAndUpdateTime ()
	Set AbortExecute Flag and update LastAbortTime.

void	UpdateProgress (double amount)
	Update the progress of the process object.

bool	CheckAbort ()
	Checks to see if this filter should abort.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	String based versions of SetInputArrayToProcess().

vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.

void	RemoveAllInputs ()
	Remove all the input data.

vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.

vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection.

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index.

virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx.

virtual void	RemoveAllInputConnections (int port)
	Removes all input connections.

virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index.

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port.

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm.

vtkAlgorithmOutput *	GetOutputPort ()

int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port.

int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm.

vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair.

vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair.

vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0).

vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection.

vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0)

vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection.

vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0)

vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port.

virtual vtkTypeBool	Update (int port, vtkInformationVector *requests)
	This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).

virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port.

virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.

virtual VTK_UNBLOCKTHREADS int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.

virtual VTK_UNBLOCKTHREADS int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.

virtual VTK_UNBLOCKTHREADS void	UpdateInformation ()
	Bring the algorithm's information up-to-date.

virtual void	UpdateDataObject ()
	Create output object(s).

virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.

virtual VTK_UNBLOCKTHREADS void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date.

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair.

void	RemoveNoPriorTemporalAccessInformationKey ()
	Removes any information key `vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS()` to all output ports of this `vtkAlgorithm`.

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm.

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm.

bool	UsesGarbageCollector () const override
	Participate in garbage collection.

virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object.

virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object.

virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object.

virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object.

virtual double	GetProgress ()
	Get the execution progress of a process object.

void	SetContainerAlgorithm (vtkAlgorithm *containerAlg)
	Set/get a Container algorithm for this algorithm.

vtkAlgorithm *	GetContainerAlgorithm ()
	Set/get a Container algorithm for this algorithm.

virtual void	SetAbortOutput (bool)
	Set/Get an internal variable used to communicate between the algorithm and executive.

virtual bool	GetAbortOutput ()
	Set/Get an internal variable used to communicate between the algorithm and executive.

void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called.

virtual double	GetProgressShift ()
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called.

virtual double	GetProgressScale ()
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called.

void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state.

virtual char *	GetProgressText ()
	Set the current text message associated with the progress state.

virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index.

virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index.

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index.

virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index.

virtual VTK_UNBLOCKTHREADS void	Update (int port)
	Bring this algorithm's outputs up-to-date.

virtual VTK_UNBLOCKTHREADS void	Update ()
	Bring this algorithm's outputs up-to-date.

virtual void	SetReleaseDataFlag (vtkTypeBool)
	Turn release data flag on or off for all output ports.

virtual vtkTypeBool	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports.

void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports.

void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports.

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.

int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents.

int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents.

int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents.

void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.

virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.

void	SetNoPriorTemporalAccessInformationKey (int key)
	Set to all output ports of this algorithm the information key `vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS()`.

void	SetNoPriorTemporalAccessInformationKey ()
	Set to all output ports of this algorithm the information key `vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS()`.

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

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkCGNSReader *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkCGNSReader *	SafeDownCast (vtkObjectBase *o)

static vtkInformationStringKey *	FAMILY ()
	Key used to put a family name in the meta-data associated with a node.

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

static vtkTypeBool	IsTypeOf (const char *type)

static vtkMultiBlockDataSetAlgorithm *	SafeDownCast (vtkObjectBase *o)

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

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements.

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 ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request.

static vtkInformationIntegerKey *	ABORTED ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCGNSReader ()

	~vtkCGNSReader () override

int	FillOutputPortInformation (int port, vtkInformation *info) override
	Fill the output port information objects for this algorithm.

int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	This is called by the superclass.

int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	This is called by the superclass.

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)

int	ReadUserDefinedData (int zone, vtkMultiBlockDataSet *mbase)
	Read "UserDefinedData_t" nodes in the given zone.

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

	vtkMultiBlockDataSetAlgorithm ()

	~vtkMultiBlockDataSetAlgorithm () override=default

virtual int	RequestDataObject (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called by the superclass.

virtual int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called by the superclass.

virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called by the superclass.

virtual int	RequestUpdateTime (vtkInformation , vtkInformationVector , vtkInformationVector )

vtkExecutive *	CreateDefaultExecutive () override
	Create a default executive.

int	FillOutputPortInformation (int port, vtkInformation *info) override
	Fill the output port information objects for this algorithm.

int	FillInputPortInformation (int port, vtkInformation *info) override
	Fill the input port information objects for this algorithm.

vtkDataObject *	GetInput (int port)

virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called by the superclass.

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

	vtkAlgorithm ()

	~vtkAlgorithm () override

bool	CheckUpstreamAbort ()
	Checks to see if an upstream filter has been aborted.

virtual int	FillInputPortInformation (int port, vtkInformation *info)
	Fill the input port information objects for this algorithm.

virtual int	FillOutputPortInformation (int port, vtkInformation *info)
	Fill the output port information objects for this algorithm.

virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm.

virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm.

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
	Get the association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.

virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive.

void	ReportReferences (vtkGarbageCollector *) override

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port.

virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port.

void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input.

void	AddInputDataInternal (int port, vtkDataObject *input)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.

virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file.

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkMultiProcessController *	Controller = nullptr

vtkIdType	ProcRank = 0

vtkIdType	ProcSize = 1

vtkNew< vtkDataArraySelection >	BaseSelection

vtkNew< vtkDataArraySelection >	FamilySelection

vtkNew< vtkDataArraySelection >	CellDataArraySelection

vtkNew< vtkDataArraySelection >	FaceDataArraySelection

vtkNew< vtkDataArraySelection >	PointDataArraySelection

Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp	LastAbortCheckTime

vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode
	The error code contains a possible error that occurred while reading or writing the file.

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkPrivate

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBool >	AbortExecute

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

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp	LastAbortTime

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, cells or faces.

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

Tests:: vtkCGNSReader (Tests)

Definition at line 40 of file vtkCGNSReader.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMultiBlockDataSetAlgorithm vtkCGNSReader::Superclass

Definition at line 44 of file vtkCGNSReader.h.

Member Enumeration Documentation

◆ DataArrayLocation

enum vtkCGNSReader::DataArrayLocation

Enumerator
CELL_DATA
FACE_DATA

Definition at line 47 of file vtkCGNSReader.h.

Constructor & Destructor Documentation

◆ vtkCGNSReader()

vtkCGNSReader::vtkCGNSReader ( )

protected

◆ ~vtkCGNSReader()

vtkCGNSReader::~vtkCGNSReader ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkCGNSReader * vtkCGNSReader::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkCGNSReader::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 vtkMultiBlockDataSetAlgorithm.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkCGNSReader::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkMultiBlockDataSetAlgorithm.

◆ NewInstance()

vtkCGNSReader * vtkCGNSReader::NewInstance ( ) const

◆ PrintSelf()

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

overridevirtual

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 vtkAlgorithm.

◆ SetDataLocation()

virtual void vtkCGNSReader::SetDataLocation ( int )

virtual

Set/get the location of the data arrays to read.

Possible values for the data location are:

CELL_DATA - Read CellCenter data arrays from the CGNS file. Construct 3D meshes with 3D cells (e.g. a cube is defined as 1 cell).
FACE_DATA - Read FaceCenter data arrays from the CGNS file. Construct 3D meshes with 2D cells/faces (e.g. a cube is defined as 6 quad cells). Element connectivity must be defined with element type NGON_n.

Default is CELL_DATA.

◆ GetDataLocation()

virtual int vtkCGNSReader::GetDataLocation ( )

virtual

Set/get the location of the data arrays to read.

Possible values for the data location are:

CELL_DATA - Read CellCenter data arrays from the CGNS file. Construct 3D meshes with 3D cells (e.g. a cube is defined as 1 cell).
FACE_DATA - Read FaceCenter data arrays from the CGNS file. Construct 3D meshes with 2D cells/faces (e.g. a cube is defined as 6 quad cells). Element connectivity must be defined with element type NGON_n.

Default is CELL_DATA.

◆ vtkSetStdStringFromCharMacro()

vtkCGNSReader::vtkSetStdStringFromCharMacro ( FileName )

Specify file name of CGNS datafile to read.

◆ vtkGetCharFromStdStringMacro()

vtkCGNSReader::vtkGetCharFromStdStringMacro ( FileName )

Specify file name of CGNS datafile to read.

◆ CanReadFile()

int vtkCGNSReader::CanReadFile ( VTK_FILEPATH 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.

◆ GetCellDataArraySelection()

virtual vtkDataArraySelection * vtkCGNSReader::GetCellDataArraySelection ( )

virtual

Return selection of cell arrays.

◆ GetFaceDataArraySelection()

virtual vtkDataArraySelection * vtkCGNSReader::GetFaceDataArraySelection ( )

virtual

Return selection of face arrays.

◆ GetPointDataArraySelection()

virtual vtkDataArraySelection * vtkCGNSReader::GetPointDataArraySelection ( )

virtual

Return selection of point arrays.

◆ 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 particular arrays.

◆ GetPointArrayName()

const char * vtkCGNSReader::GetPointArrayName ( int index )

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

◆ GetPointArrayStatus()

int vtkCGNSReader::GetPointArrayStatus ( const char * name )

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

◆ SetPointArrayStatus()

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

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

◆ DisableAllPointArrays()

void vtkCGNSReader::DisableAllPointArrays ( )

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

◆ EnableAllPointArrays()

void vtkCGNSReader::EnableAllPointArrays ( )

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

◆ GetNumberOfCellArrays()

int vtkCGNSReader::GetNumberOfCellArrays ( )

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

◆ GetCellArrayName()

const char * vtkCGNSReader::GetCellArrayName ( int index )

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

◆ GetCellArrayStatus()

int vtkCGNSReader::GetCellArrayStatus ( const char * name )

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

◆ SetCellArrayStatus()

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

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

◆ DisableAllCellArrays()

void vtkCGNSReader::DisableAllCellArrays ( )

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

◆ EnableAllCellArrays()

void vtkCGNSReader::EnableAllCellArrays ( )

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

◆ GetNumberOfFaceArrays()

int vtkCGNSReader::GetNumberOfFaceArrays ( )

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

◆ GetFaceArrayName()

const char * vtkCGNSReader::GetFaceArrayName ( int index )

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

◆ GetFaceArrayStatus()

int vtkCGNSReader::GetFaceArrayStatus ( const char * name )

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

◆ SetFaceArrayStatus()

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

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

◆ DisableAllFaceArrays()

void vtkCGNSReader::DisableAllFaceArrays ( )

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

◆ EnableAllFaceArrays()

void vtkCGNSReader::EnableAllFaceArrays ( )

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

◆ SetDoublePrecisionMesh()

virtual void vtkCGNSReader::SetDoublePrecisionMesh ( int )

virtual

Enable/disable double precision when reading the mesh.

Defaults to 1 (true).

◆ GetDoublePrecisionMesh()

virtual int vtkCGNSReader::GetDoublePrecisionMesh ( )

virtual

Enable/disable double precision when reading the mesh.

Defaults to 1 (true).

◆ DoublePrecisionMeshOn()

virtual void vtkCGNSReader::DoublePrecisionMeshOn ( )

virtual

Enable/disable double precision when reading the mesh.

Defaults to 1 (true).

◆ DoublePrecisionMeshOff()

virtual void vtkCGNSReader::DoublePrecisionMeshOff ( )

virtual

Enable/disable double precision when reading the mesh.

Defaults to 1 (true).

◆ 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.

◆ SetLoadSurfacePatch()

virtual void vtkCGNSReader::SetLoadSurfacePatch ( bool )

virtual

Enable/disable loading of surface patches.

In constrast to LoadBndPatch this loads elements of +++ that do not have an associated boundary condition patch. Defaults to false.

◆ GetLoadSurfacePatch()

virtual bool vtkCGNSReader::GetLoadSurfacePatch ( )

virtual

Enable/disable loading of surface patches.

In constrast to LoadBndPatch this loads elements of +++ that do not have an associated boundary condition patch. Defaults to false.

◆ LoadSurfacePatchOn()

virtual void vtkCGNSReader::LoadSurfacePatchOn ( )

virtual

Enable/disable loading of surface patches.

In constrast to LoadBndPatch this loads elements of +++ that do not have an associated boundary condition patch. Defaults to false.

◆ LoadSurfacePatchOff()

virtual void vtkCGNSReader::LoadSurfacePatchOff ( )

virtual

Enable/disable loading of surface patches.

In constrast to LoadBndPatch this loads elements of +++ that do not have an associated boundary condition patch. 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.

◆ SetUse3DVector()

virtual void vtkCGNSReader::SetUse3DVector ( bool )

virtual

Enable/disable adding an empty physical dimension to vectors in case of 2D solutions.

Default is true.

◆ GetUse3DVector()

virtual bool vtkCGNSReader::GetUse3DVector ( )

virtual

Enable/disable adding an empty physical dimension to vectors in case of 2D solutions.

Default is true.

◆ Use3DVectorOn()

virtual void vtkCGNSReader::Use3DVectorOn ( )

virtual

Enable/disable adding an empty physical dimension to vectors in case of 2D solutions.

Default is true.

◆ Use3DVectorOff()

virtual void vtkCGNSReader::Use3DVectorOff ( )

virtual

Enable/disable adding an empty physical dimension to vectors in case of 2D solutions.

Default is true.

◆ 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 reader 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. Default is 0 (false).

◆ GetCreateEachSolutionAsBlock()

virtual int vtkCGNSReader::GetCreateEachSolutionAsBlock ( )

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 reader 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. Default is 0 (false).

◆ CreateEachSolutionAsBlockOn()

virtual void vtkCGNSReader::CreateEachSolutionAsBlockOn ( )

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 reader 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. Default is 0 (false).

◆ CreateEachSolutionAsBlockOff()

virtual void vtkCGNSReader::CreateEachSolutionAsBlockOff ( )

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 reader 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. Default is 0 (false).

◆ 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

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.

◆ IgnoreFlowSolutionPointersOn()

virtual void vtkCGNSReader::IgnoreFlowSolutionPointersOn ( )

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.

◆ IgnoreFlowSolutionPointersOff()

virtual void vtkCGNSReader::IgnoreFlowSolutionPointersOff ( )

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.

◆ 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 pattern matching.

This can be useful for unsteady solutions when FlowSolutionPointers are not reliable.

◆ GetUseUnsteadyPattern()

virtual bool vtkCGNSReader::GetUseUnsteadyPattern ( )

virtual

When set to true (default is false), the reader will try to determine to determine FlowSolution_t nodes to read with pattern matching.

This can be useful for unsteady solutions when FlowSolutionPointers are not reliable.

◆ UseUnsteadyPatternOn()

virtual void vtkCGNSReader::UseUnsteadyPatternOn ( )

virtual

When set to true (default is false), the reader will try to determine to determine FlowSolution_t nodes to read with pattern matching.

This can be useful for unsteady solutions when FlowSolutionPointers are not reliable.

◆ UseUnsteadyPatternOff()

virtual void vtkCGNSReader::UseUnsteadyPatternOff ( )

virtual

When set to true (default is false), the reader will try to determine to determine FlowSolution_t nodes to read with pattern matching.

This can be useful for unsteady solutions when FlowSolutionPointers are not reliable.

◆ SetUnsteadySolutionStartTimestep()

virtual void vtkCGNSReader::SetUnsteadySolutionStartTimestep ( int )

virtual

Set/get the index of the first timestep when reading unsteady solutions.

Only used when "UseUnsteadyPattern" is true. Default is 0.

◆ GetUnsteadySolutionStartTimestep()

virtual int vtkCGNSReader::GetUnsteadySolutionStartTimestep ( )

virtual

Set/get the index of the first timestep when reading unsteady solutions.

Only used when "UseUnsteadyPattern" is true. Default is 0.

◆ 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

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

◆ DistributeBlocksOn()

virtual void vtkCGNSReader::DistributeBlocksOn ( )

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

◆ DistributeBlocksOff()

virtual void vtkCGNSReader::DistributeBlocksOff ( )

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