VTK  9.3.20240329
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
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, 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. More...
 
vtkCGNSReaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int CanReadFile (VTK_FILEPATH const char *filename)
 Is the given file name a CGNS file? More...
 
vtkDataArraySelectionGetBaseSelection ()
 Returns access to the base selection object. More...
 
vtkDataArraySelectionGetFamilySelection ()
 Returns access to the family selection object. More...
 
virtual vtkDataArraySelectionGetCellDataArraySelection ()
 Return selection of cell arrays. More...
 
virtual vtkDataArraySelectionGetFaceDataArraySelection ()
 Return selection of face arrays. More...
 
virtual vtkDataArraySelectionGetPointDataArraySelection ()
 Return selection of point arrays. More...
 
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 SetDataLocation (int)
 Set/get the location of the data arrays to read. More...
 
virtual int GetDataLocation ()
 Set/get the location of the data arrays to read. More...
 
 vtkSetStdStringFromCharMacro (FileName)
 Specify file name of CGNS datafile to read. More...
 
 vtkGetCharFromStdStringMacro (FileName)
 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 particular arrays. More...
 
const char * GetPointArrayName (int index)
 API to get information of point arrays and enable/disable loading of particular arrays. More...
 
int GetPointArrayStatus (const char *name)
 API to get information of point arrays and enable/disable loading of particular arrays. More...
 
void SetPointArrayStatus (const char *name, int status)
 API to get information of point arrays and enable/disable loading of particular arrays. More...
 
void DisableAllPointArrays ()
 API to get information of point arrays and enable/disable loading of particular arrays. More...
 
void EnableAllPointArrays ()
 API to get information of point arrays and enable/disable loading of particular arrays. More...
 
int GetNumberOfCellArrays ()
 API to get information of cell arrays and enable/disable loading of particular arrays. More...
 
const char * GetCellArrayName (int index)
 API to get information of cell arrays and enable/disable loading of particular arrays. More...
 
int GetCellArrayStatus (const char *name)
 API to get information of cell arrays and enable/disable loading of particular arrays. More...
 
void SetCellArrayStatus (const char *name, int status)
 API to get information of cell arrays and enable/disable loading of particular arrays. More...
 
void DisableAllCellArrays ()
 API to get information of cell arrays and enable/disable loading of particular arrays. More...
 
void EnableAllCellArrays ()
 API to get information of cell arrays and enable/disable loading of particular arrays. More...
 
int GetNumberOfFaceArrays ()
 API to get information of face arrays and enable/disable loading of particular arrays. More...
 
const char * GetFaceArrayName (int index)
 API to get information of face arrays and enable/disable loading of particular arrays. More...
 
int GetFaceArrayStatus (const char *name)
 API to get information of face arrays and enable/disable loading of particular arrays. More...
 
void SetFaceArrayStatus (const char *name, int status)
 API to get information of face arrays and enable/disable loading of particular arrays. More...
 
void DisableAllFaceArrays ()
 API to get information of face arrays and enable/disable loading of particular arrays. More...
 
void EnableAllFaceArrays ()
 API to get information of face arrays and enable/disable loading of particular arrays. More...
 
virtual void SetDoublePrecisionMesh (int)
 Enable/disable double precision when reading the mesh. More...
 
virtual int GetDoublePrecisionMesh ()
 Enable/disable double precision when reading the mesh. More...
 
virtual void DoublePrecisionMeshOn ()
 Enable/disable double precision when reading the mesh. More...
 
virtual void DoublePrecisionMeshOff ()
 Enable/disable double precision when reading the mesh. 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...
 
virtual void SetUse3DVector (bool)
 Enable/disable adding an empty physical dimension to vectors in case of 2D solutions. More...
 
virtual bool GetUse3DVector ()
 Enable/disable adding an empty physical dimension to vectors in case of 2D solutions. More...
 
virtual void Use3DVectorOn ()
 Enable/disable adding an empty physical dimension to vectors in case of 2D solutions. More...
 
virtual void Use3DVectorOff ()
 Enable/disable adding an empty physical dimension to vectors in case of 2D solutions. More...
 
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 ()
 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 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. More...
 
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. More...
 
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 ()
 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 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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual void SetUnsteadySolutionStartTimestep (int)
 Set/get the index of the first timestep when reading unsteady solutions. More...
 
virtual int GetUnsteadySolutionStartTimestep ()
 Set/get the index of the first timestep when reading unsteady solutions. More...
 
virtual void SetDistributeBlocks (bool)
 This reader can support piece requests by distributing each block in each zone across ranks (default). More...
 
virtual bool GetDistributeBlocks ()
 This reader can support piece requests by distributing each block in each zone across ranks (default). More...
 
virtual void DistributeBlocksOn ()
 This reader can support piece requests by distributing each block in each zone across ranks (default). More...
 
virtual void DistributeBlocksOff ()
 This reader can support piece requests by distributing each block in each zone across ranks (default). 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 mesh connectivities if they are time invariant. More...
 
virtual bool GetCacheConnectivity ()
 This reader can cache the mesh connectivities if they are time invariant. More...
 
virtual void CacheConnectivityOn ()
 This reader can cache the mesh connectivities if they are time invariant. More...
 
virtual void CacheConnectivityOff ()
 This reader can cache the mesh connectivities 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 vtkMultiProcessControllerGetController ()
 Set/get the communication object used to relay a list of files from the rank 0 process to all others. More...
 
- Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm
vtkMultiBlockDataSetAlgorithmNewInstance () const
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 see vtkAlgorithm for details More...
 
vtkMultiBlockDataSetGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkMultiBlockDataSetGetOutput (int)
 Get the output data object for a port on this algorithm. More...
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
vtkTypeBool HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
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. More...
 
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. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void SetAbortExecuteAndUpdateTime ()
 Set AbortExecute Flag and update LastAbortTime. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
bool CheckAbort ()
 Checks to see if this filter should abort. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
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). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
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. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual 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. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
void RemoveNoPriorTemporalAccessInformationKey ()
 Removes any information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() to all output ports of this vtkAlgorithm. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm. More...
 
bool UsesGarbageCollector () const override
 Participate in garbage collection. More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetContainerAlgorithm (vtkAlgorithm *containerAlg)
 Set/get a Container algorithm for this algorithm. More...
 
vtkAlgorithmGetContainerAlgorithm ()
 Set/get a Container algorithm for this algorithm. More...
 
virtual void SetAbortOutput (bool)
 Set/Get an internal variable used to communicate between the algorithm and executive. More...
 
virtual bool GetAbortOutput ()
 Set/Get an internal variable used to communicate between the algorithm and executive. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state. More...
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date. More...
 
virtual void SetReleaseDataFlag (vtkTypeBool)
 Turn release data flag on or off for all output ports. More...
 
virtual vtkTypeBool GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports. More...
 
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. More...
 
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. More...
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
int * GetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents. More...
 
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. More...
 
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. More...
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
void SetNoPriorTemporalAccessInformationKey (int key)
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS(). More...
 
void SetNoPriorTemporalAccessInformationKey ()
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS(). More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
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. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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. More...
 
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. More...
 
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. More...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
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). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkCGNSReaderNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCGNSReaderSafeDownCast (vtkObjectBase *o)
 
static vtkInformationStringKeyFAMILY ()
 Key used to put a family name in the meta-data associated with a node. More...
 
- Static Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm
static vtkMultiBlockDataSetAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkMultiBlockDataSetAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static vtkInformationIntegerKeyABORTED ()
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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. More...
 
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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkCGNSReader ()
 
 ~vtkCGNSReader () override
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
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. More...
 
- Protected Member Functions inherited from vtkMultiBlockDataSetAlgorithm
 vtkMultiBlockDataSetAlgorithm ()
 
 ~vtkMultiBlockDataSetAlgorithm () override=default
 
virtual int RequestDataObject (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
virtual int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
vtkExecutiveCreateDefaultExecutive () override
 Create a default executive. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
vtkDataObjectGetInput (int port)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
bool CheckUpstreamAbort ()
 Checks to see if an upstream filter has been aborted. More...
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
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. More...
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
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. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (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. More...
 
vtkDataArrayGetInputArrayToProcess (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. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- 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. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkMultiProcessControllerController = nullptr
 
vtkIdType ProcRank = 0
 
vtkIdType ProcSize = 1
 
vtkNew< vtkDataArraySelectionBaseSelection
 
vtkNew< vtkDataArraySelectionFamilySelection
 
vtkNew< vtkDataArraySelectionCellDataArraySelection
 
vtkNew< vtkDataArraySelectionFaceDataArraySelection
 
vtkNew< vtkDataArraySelectionPointDataArraySelection
 
- Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp LastAbortCheckTime
 
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- 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< vtkTypeBoolAbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_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 vtkExecutiveDefaultExecutivePrototype
 

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

Definition at line 44 of file vtkCGNSReader.h.

Member Enumeration Documentation

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

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

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

◆ 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. Default is false.

◆ 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. Default is false.

◆ 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. Default is false.

◆ 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. Default is false.

◆ SetCacheConnectivity()

void vtkCGNSReader::SetCacheConnectivity ( bool  enable)

This reader can cache the mesh connectivities 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. Default is false.

◆ GetCacheConnectivity()

virtual bool vtkCGNSReader::GetCacheConnectivity ( )
virtual

This reader can cache the mesh connectivities 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. Default is false.

◆ CacheConnectivityOn()

virtual void vtkCGNSReader::CacheConnectivityOn ( )
virtual

This reader can cache the mesh connectivities 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. Default is false.

◆ CacheConnectivityOff()

virtual void vtkCGNSReader::CacheConnectivityOff ( )
virtual

This reader can cache the mesh connectivities 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. Default is false.

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

◆ GetController()

virtual vtkMultiProcessController* vtkCGNSReader::GetController ( )
virtual

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

◆ 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

Fill the output port information objects for this algorithm.

This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkMultiBlockDataSetAlgorithm.

◆ RequestData()

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

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkMultiBlockDataSetAlgorithm.

◆ RequestInformation()

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

This is called by the superclass.

This is the method you should override.

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

◆ ReadUserDefinedData()

int vtkCGNSReader::ReadUserDefinedData ( int  zone,
vtkMultiBlockDataSet mbase 
)
protected

Read "UserDefinedData_t" nodes in the given zone.

"DataArray_t" nodes found inside are added as field data arrays.

Friends And Related Function Documentation

◆ vtkPrivate

friend class vtkPrivate
friend

Definition at line 383 of file vtkCGNSReader.h.

Member Data Documentation

◆ Controller

vtkMultiProcessController* vtkCGNSReader::Controller = nullptr
protected

Definition at line 344 of file vtkCGNSReader.h.

◆ ProcRank

vtkIdType vtkCGNSReader::ProcRank = 0
protected

Definition at line 345 of file vtkCGNSReader.h.

◆ ProcSize

vtkIdType vtkCGNSReader::ProcSize = 1
protected

Definition at line 346 of file vtkCGNSReader.h.

◆ BaseSelection

vtkNew<vtkDataArraySelection> vtkCGNSReader::BaseSelection
protected

Definition at line 348 of file vtkCGNSReader.h.

◆ FamilySelection

vtkNew<vtkDataArraySelection> vtkCGNSReader::FamilySelection
protected

Definition at line 349 of file vtkCGNSReader.h.

◆ CellDataArraySelection

vtkNew<vtkDataArraySelection> vtkCGNSReader::CellDataArraySelection
protected

Definition at line 351 of file vtkCGNSReader.h.

◆ FaceDataArraySelection

vtkNew<vtkDataArraySelection> vtkCGNSReader::FaceDataArraySelection
protected

Definition at line 352 of file vtkCGNSReader.h.

◆ PointDataArraySelection

vtkNew<vtkDataArraySelection> vtkCGNSReader::PointDataArraySelection
protected

Definition at line 353 of file vtkCGNSReader.h.


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