VTK  9.0.20201126
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
vtkAMRBaseReader Class Referenceabstract

An abstract class that encapsulates common functionality for all AMR readers. More...

#include <vtkAMRBaseReader.h>

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

Public Types

typedef vtkOverlappingAMRAlgorithm Superclass
 
- Public Types inherited from vtkOverlappingAMRAlgorithm
typedef vtkUniformGridAMRAlgorithm Superclass
 
- Public Types inherited from vtkUniformGridAMRAlgorithm
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...
 
vtkAMRBaseReaderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Initialize ()
 Initializes the AMR reader. More...
 
virtual void SetEnableCaching (vtkTypeBool)
 Set/Get Reader caching property. More...
 
virtual vtkTypeBool GetEnableCaching ()
 
virtual void EnableCachingOn ()
 
virtual void EnableCachingOff ()
 
bool IsCachingEnabled () const
 
virtual void SetController (vtkMultiProcessController *)
 Set/Get a multiprocess-controller for reading in parallel. More...
 
virtual vtkMultiProcessControllerGetController ()
 
virtual void SetMaxLevel (int)
 Set the level, up to which the blocks are loaded. More...
 
virtual vtkDataArraySelectionGetCellDataArraySelection ()
 Get the data array selection tables used to configure which data arrays are loaded by the reader. More...
 
virtual vtkDataArraySelectionGetPointDataArraySelection ()
 
int GetNumberOfPointArrays ()
 Get the number of point or cell arrays available in the input. More...
 
int GetNumberOfCellArrays ()
 
const char * GetPointArrayName (int index)
 Get the name of the point or cell array with the given index in the input. More...
 
const char * GetCellArrayName (int index)
 
int GetPointArrayStatus (const char *name)
 Get/Set whether the point or cell array with the given name is to be read. More...
 
int GetCellArrayStatus (const char *name)
 
void SetPointArrayStatus (const char *name, int status)
 
void SetCellArrayStatus (const char *name, int status)
 
virtual char * GetFileName ()
 Set/Get the filename. More...
 
virtual void SetFileName (const char *fileName)=0
 
virtual int GetNumberOfBlocks ()=0
 Returns the total number of blocks. More...
 
virtual int GetNumberOfLevels ()=0
 Returns the total number of levels. More...
 
- Public Member Functions inherited from vtkOverlappingAMRAlgorithm
vtkOverlappingAMRAlgorithmNewInstance () const
 
vtkOverlappingAMRGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkOverlappingAMRGetOutput (int)
 
- Public Member Functions inherited from vtkUniformGridAMRAlgorithm
vtkUniformGridAMRAlgorithmNewInstance () const
 
vtkUniformGridAMRGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkUniformGridAMRGetOutput (int)
 
void SetInputData (vtkDataObject *)
 Set an input of this algorithm. More...
 
void SetInputData (int, vtkDataObject *)
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 See vtkAlgorithm for details. More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int 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...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
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 Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. 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 ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
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)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
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 SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
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 void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
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...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
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)
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
int * GetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAMRBaseReaderSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkOverlappingAMRAlgorithm
static vtkOverlappingAMRAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOverlappingAMRAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkUniformGridAMRAlgorithm
static vtkUniformGridAMRAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkUniformGridAMRAlgorithmSafeDownCast (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 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 (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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
 
 vtkAMRBaseReader ()
 
 ~vtkAMRBaseReader () override
 
bool IsParallel ()
 
bool IsBlockMine (const int blockIdx)
 Determines if the block is owned by this process based on the the block index and total number of processes. More...
 
vtkUniformGridGetAMRBlock (const int blockIdx)
 Loads the AMR block corresponding to the given index. More...
 
void AssignAndLoadBlocks (vtkOverlappingAMR *amrds)
 This method assigns blocks to processes using block-cyclic distribution. More...
 
void LoadRequestedBlocks (vtkOverlappingAMR *amrds)
 This method loads all the blocks in the BlockMap for the given process. More...
 
void GetAMRData (const int blockIdx, vtkUniformGrid *block, const char *fieldName)
 Loads the AMR data corresponding to the given field name. More...
 
void GetAMRPointData (const int blockIdx, vtkUniformGrid *block, const char *fieldName)
 Loads the AMR point data corresponding to the given field name. More...
 
void LoadPointData (const int blockIdx, vtkUniformGrid *block)
 A wrapper that loops over point arrays and load the point arrays that are enabled, i.e., selected for the given block. More...
 
void LoadCellData (const int blockIdx, vtkUniformGrid *block)
 A wrapper that loops over all cell arrays and loads the cell arrays that are enabled, i.e., selected for the given block. More...
 
int GetBlockProcessId (const int blockIdx)
 Returns the block process ID for the block corresponding to the given block index. More...
 
void SetupBlockRequest (vtkInformation *outputInfo)
 Initializes the request of blocks to be loaded. More...
 
virtual void ReadMetaData ()=0
 Reads all the metadata from the file. More...
 
virtual int GetBlockLevel (const int blockIdx)=0
 Returns the block level for the given block. More...
 
virtual int FillMetaData ()=0
 Loads all the AMR metadata & constructs the LevelIdxPair12InternalIdx datastructure which maps (level,id) pairs to an internal linear index used to identify the corresponding block. More...
 
virtual vtkUniformGridGetAMRGrid (const int blockIdx)=0
 Loads the block according to the index w.r.t. More...
 
virtual void GetAMRGridData (const int blockIdx, vtkUniformGrid *block, const char *field)=0
 Loads the block data. More...
 
virtual void GetAMRGridPointData (const int blockIdx, vtkUniformGrid *block, const char *field)=0
 Loads the block Point data. More...
 
int RequestData (vtkInformation *vtkNotUsed(request), vtkInformationVector **vtkNotUsed(inputVector), vtkInformationVector *outputVector) override
 Standard Pipeline methods, subclasses may override this method if needed. More...
 
int RequestInformation (vtkInformation *rqst, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 This is called by the superclass. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 See algorithm for more info. More...
 
void InitializeArraySelections ()
 Initializes the array selections. More...
 
virtual void SetUpDataArraySelections ()=0
 Initializes the PointDataArraySelection & CellDataArraySelection. More...
 
- Protected Member Functions inherited from vtkOverlappingAMRAlgorithm
 vtkOverlappingAMRAlgorithm ()
 
 ~vtkOverlappingAMRAlgorithm () override
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
- Protected Member Functions inherited from vtkUniformGridAMRAlgorithm
 vtkUniformGridAMRAlgorithm ()
 
 ~vtkUniformGridAMRAlgorithm () override
 
virtual int RequestDataObject (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
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)
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
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 assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
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)
 
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)
 
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)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
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)
 
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)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. 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)
 
- 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static void SelectionModifiedCallback (vtkObject *caller, unsigned long eid, void *clientdata, void *calldata)
 Call-back registered with the SelectionObserver. More...
 
- 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 ()
 

Protected Attributes

vtkDataArraySelectionPointDataArraySelection
 
vtkDataArraySelectionCellDataArraySelection
 
vtkCallbackCommandSelectionObserver
 
bool InitialRequest
 
int MaxLevel
 
char * FileName
 
vtkMultiProcessControllerController
 
vtkTypeBool EnableCaching
 
vtkAMRDataSetCacheCache
 
int NumBlocksFromFile
 
int NumBlocksFromCache
 
vtkOverlappingAMRMetadata
 
bool LoadedMetaData
 
std::vector< int > BlockMap
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

An abstract class that encapsulates common functionality for all AMR readers.

Definition at line 39 of file vtkAMRBaseReader.h.

Member Typedef Documentation

◆ Superclass

Definition at line 42 of file vtkAMRBaseReader.h.

Constructor & Destructor Documentation

◆ vtkAMRBaseReader()

vtkAMRBaseReader::vtkAMRBaseReader ( )
protected

◆ ~vtkAMRBaseReader()

vtkAMRBaseReader::~vtkAMRBaseReader ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkAMRBaseReader::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 vtkOverlappingAMRAlgorithm.

Reimplemented in vtkAMREnzoReader, vtkAMReXGridReader, vtkAMRVelodyneReader, and vtkAMRFlashReader.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkAMRBaseReader::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkAMRBaseReader* vtkAMRBaseReader::NewInstance ( ) const

◆ PrintSelf()

void vtkAMRBaseReader::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 vtkOverlappingAMRAlgorithm.

Reimplemented in vtkAMREnzoReader, vtkAMReXGridReader, and vtkAMRFlashReader.

◆ Initialize()

void vtkAMRBaseReader::Initialize ( )

Initializes the AMR reader.

All concrete instances must call this method in their constructor.

◆ SetEnableCaching()

virtual void vtkAMRBaseReader::SetEnableCaching ( vtkTypeBool  )
virtual

Set/Get Reader caching property.

◆ GetEnableCaching()

virtual vtkTypeBool vtkAMRBaseReader::GetEnableCaching ( )
virtual

◆ EnableCachingOn()

virtual void vtkAMRBaseReader::EnableCachingOn ( )
virtual

◆ EnableCachingOff()

virtual void vtkAMRBaseReader::EnableCachingOff ( )
virtual

◆ IsCachingEnabled()

bool vtkAMRBaseReader::IsCachingEnabled ( ) const
inline

Definition at line 58 of file vtkAMRBaseReader.h.

◆ SetController()

virtual void vtkAMRBaseReader::SetController ( vtkMultiProcessController )
virtual

Set/Get a multiprocess-controller for reading in parallel.

By default this parameter is set to nullptr by the constructor.

◆ GetController()

virtual vtkMultiProcessController* vtkAMRBaseReader::GetController ( )
virtual

◆ SetMaxLevel()

virtual void vtkAMRBaseReader::SetMaxLevel ( int  )
virtual

Set the level, up to which the blocks are loaded.

◆ GetCellDataArraySelection()

virtual vtkDataArraySelection* vtkAMRBaseReader::GetCellDataArraySelection ( )
virtual

Get the data array selection tables used to configure which data arrays are loaded by the reader.

◆ GetPointDataArraySelection()

virtual vtkDataArraySelection* vtkAMRBaseReader::GetPointDataArraySelection ( )
virtual

◆ GetNumberOfPointArrays()

int vtkAMRBaseReader::GetNumberOfPointArrays ( )

Get the number of point or cell arrays available in the input.

◆ GetNumberOfCellArrays()

int vtkAMRBaseReader::GetNumberOfCellArrays ( )

◆ GetPointArrayName()

const char* vtkAMRBaseReader::GetPointArrayName ( int  index)

Get the name of the point or cell array with the given index in the input.

◆ GetCellArrayName()

const char* vtkAMRBaseReader::GetCellArrayName ( int  index)

◆ GetPointArrayStatus()

int vtkAMRBaseReader::GetPointArrayStatus ( const char *  name)

Get/Set whether the point or cell array with the given name is to be read.

◆ GetCellArrayStatus()

int vtkAMRBaseReader::GetCellArrayStatus ( const char *  name)

◆ SetPointArrayStatus()

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

◆ SetCellArrayStatus()

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

◆ GetFileName()

virtual char* vtkAMRBaseReader::GetFileName ( )
virtual

Set/Get the filename.

Concrete instances of this class must implement the SetFileName method accordingly.

◆ SetFileName()

virtual void vtkAMRBaseReader::SetFileName ( const char *  fileName)
pure virtual

◆ GetNumberOfBlocks()

virtual int vtkAMRBaseReader::GetNumberOfBlocks ( )
pure virtual

Returns the total number of blocks.

Implemented by concrete instances.

Implemented in vtkAMREnzoReader, vtkAMReXGridReader, vtkAMRVelodyneReader, and vtkAMRFlashReader.

◆ GetNumberOfLevels()

virtual int vtkAMRBaseReader::GetNumberOfLevels ( )
pure virtual

Returns the total number of levels.

Implemented by concrete instances.

Implemented in vtkAMREnzoReader, vtkAMReXGridReader, vtkAMRFlashReader, and vtkAMRVelodyneReader.

◆ IsParallel()

bool vtkAMRBaseReader::IsParallel ( )
protected

◆ IsBlockMine()

bool vtkAMRBaseReader::IsBlockMine ( const int  blockIdx)
protected

Determines if the block is owned by this process based on the the block index and total number of processes.

◆ GetAMRBlock()

vtkUniformGrid* vtkAMRBaseReader::GetAMRBlock ( const int  blockIdx)
protected

Loads the AMR block corresponding to the given index.

The block is either loaded from the file, or, from the cache if caching is enabled.

◆ AssignAndLoadBlocks()

void vtkAMRBaseReader::AssignAndLoadBlocks ( vtkOverlappingAMR amrds)
protected

This method assigns blocks to processes using block-cyclic distribution.

It is the method that is used to load distributed AMR data by default.

◆ LoadRequestedBlocks()

void vtkAMRBaseReader::LoadRequestedBlocks ( vtkOverlappingAMR amrds)
protected

This method loads all the blocks in the BlockMap for the given process.

It assumes that the downstream module is doing an upstream request with the flag LOAD_REQUESTED_BLOCKS which indicates that the downstream filter has already assigned which blocks are needed for each process.

◆ GetAMRData()

void vtkAMRBaseReader::GetAMRData ( const int  blockIdx,
vtkUniformGrid block,
const char *  fieldName 
)
protected

Loads the AMR data corresponding to the given field name.

NOTE: Currently, only cell-data are supported.

◆ GetAMRPointData()

void vtkAMRBaseReader::GetAMRPointData ( const int  blockIdx,
vtkUniformGrid block,
const char *  fieldName 
)
protected

Loads the AMR point data corresponding to the given field name.

◆ LoadPointData()

void vtkAMRBaseReader::LoadPointData ( const int  blockIdx,
vtkUniformGrid block 
)
protected

A wrapper that loops over point arrays and load the point arrays that are enabled, i.e., selected for the given block.

NOTE: This method is currently not implemented.

◆ LoadCellData()

void vtkAMRBaseReader::LoadCellData ( const int  blockIdx,
vtkUniformGrid block 
)
protected

A wrapper that loops over all cell arrays and loads the cell arrays that are enabled, i.e., selected for the given block.

The data are either loaded from the file, or, from the cache if caching is enabled.

◆ GetBlockProcessId()

int vtkAMRBaseReader::GetBlockProcessId ( const int  blockIdx)
protected

Returns the block process ID for the block corresponding to the given block index.

If this reader instance is serial, i.e., there is no controller associated, the method returns 0. Otherwise, static block-cyclic-distribution is assumed and each block is assigned to a process according to blockIdxN, where N is the total number of processes.

◆ SetupBlockRequest()

void vtkAMRBaseReader::SetupBlockRequest ( vtkInformation outputInfo)
protected

Initializes the request of blocks to be loaded.

This method checks if an upstream request has been issued from a downstream module which specifies which blocks are to be loaded, otherwise, it uses the max level associated with this reader instance to determine which blocks are to be loaded.

◆ ReadMetaData()

virtual void vtkAMRBaseReader::ReadMetaData ( )
protectedpure virtual

Reads all the metadata from the file.

Implemented by concrete classes.

Implemented in vtkAMREnzoReader, vtkAMReXGridReader, vtkAMRFlashReader, and vtkAMRVelodyneReader.

◆ GetBlockLevel()

virtual int vtkAMRBaseReader::GetBlockLevel ( const int  blockIdx)
protectedpure virtual

Returns the block level for the given block.

Implemented in vtkAMREnzoReader, vtkAMReXGridReader, vtkAMRFlashReader, and vtkAMRVelodyneReader.

◆ FillMetaData()

virtual int vtkAMRBaseReader::FillMetaData ( )
protectedpure virtual

Loads all the AMR metadata & constructs the LevelIdxPair12InternalIdx datastructure which maps (level,id) pairs to an internal linear index used to identify the corresponding block.

Implemented in vtkAMREnzoReader, vtkAMReXGridReader, vtkAMRFlashReader, and vtkAMRVelodyneReader.

◆ GetAMRGrid()

virtual vtkUniformGrid* vtkAMRBaseReader::GetAMRGrid ( const int  blockIdx)
protectedpure virtual

Loads the block according to the index w.r.t.

the generated BlockMap.

Implemented in vtkAMREnzoReader, vtkAMReXGridReader, vtkAMRFlashReader, and vtkAMRVelodyneReader.

◆ GetAMRGridData()

virtual void vtkAMRBaseReader::GetAMRGridData ( const int  blockIdx,
vtkUniformGrid block,
const char *  field 
)
protectedpure virtual

Loads the block data.

Implemented in vtkAMREnzoReader, vtkAMReXGridReader, vtkAMRFlashReader, and vtkAMRVelodyneReader.

◆ GetAMRGridPointData()

virtual void vtkAMRBaseReader::GetAMRGridPointData ( const int  blockIdx,
vtkUniformGrid block,
const char *  field 
)
protectedpure virtual

Loads the block Point data.

◆ RequestData()

int vtkAMRBaseReader::RequestData ( vtkInformation vtkNotUsedrequest,
vtkInformationVector **  vtkNotUsedinputVector,
vtkInformationVector outputVector 
)
overrideprotected

Standard Pipeline methods, subclasses may override this method if needed.

◆ RequestInformation()

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

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkUniformGridAMRAlgorithm.

Reimplemented in vtkAMRVelodyneReader.

◆ FillOutputPortInformation()

int vtkAMRBaseReader::FillOutputPortInformation ( int  port,
vtkInformation info 
)
overrideprotectedvirtual

See algorithm for more info.

Reimplemented from vtkOverlappingAMRAlgorithm.

◆ InitializeArraySelections()

void vtkAMRBaseReader::InitializeArraySelections ( )
protected

Initializes the array selections.

If this is an initial request, i.e., the first load from the file, all the arrays are deselected, and the InitialRequest ivar is set to false.

◆ SetUpDataArraySelections()

virtual void vtkAMRBaseReader::SetUpDataArraySelections ( )
protectedpure virtual

Initializes the PointDataArraySelection & CellDataArraySelection.

Implemented in vtkAMREnzoReader, vtkAMReXGridReader, vtkAMRFlashReader, and vtkAMRVelodyneReader.

◆ SelectionModifiedCallback()

static void vtkAMRBaseReader::SelectionModifiedCallback ( vtkObject caller,
unsigned long  eid,
void *  clientdata,
void *  calldata 
)
staticprotected

Call-back registered with the SelectionObserver.

Member Data Documentation

◆ PointDataArraySelection

vtkDataArraySelection* vtkAMRBaseReader::PointDataArraySelection
protected

Definition at line 259 of file vtkAMRBaseReader.h.

◆ CellDataArraySelection

vtkDataArraySelection* vtkAMRBaseReader::CellDataArraySelection
protected

Definition at line 260 of file vtkAMRBaseReader.h.

◆ SelectionObserver

vtkCallbackCommand* vtkAMRBaseReader::SelectionObserver
protected

Definition at line 261 of file vtkAMRBaseReader.h.

◆ InitialRequest

bool vtkAMRBaseReader::InitialRequest
protected

Definition at line 281 of file vtkAMRBaseReader.h.

◆ MaxLevel

int vtkAMRBaseReader::MaxLevel
protected

Definition at line 282 of file vtkAMRBaseReader.h.

◆ FileName

char* vtkAMRBaseReader::FileName
protected

Definition at line 283 of file vtkAMRBaseReader.h.

◆ Controller

vtkMultiProcessController* vtkAMRBaseReader::Controller
protected

Definition at line 284 of file vtkAMRBaseReader.h.

◆ EnableCaching

vtkTypeBool vtkAMRBaseReader::EnableCaching
protected

Definition at line 286 of file vtkAMRBaseReader.h.

◆ Cache

vtkAMRDataSetCache* vtkAMRBaseReader::Cache
protected

Definition at line 287 of file vtkAMRBaseReader.h.

◆ NumBlocksFromFile

int vtkAMRBaseReader::NumBlocksFromFile
protected

Definition at line 288 of file vtkAMRBaseReader.h.

◆ NumBlocksFromCache

int vtkAMRBaseReader::NumBlocksFromCache
protected

Definition at line 289 of file vtkAMRBaseReader.h.

◆ Metadata

vtkOverlappingAMR* vtkAMRBaseReader::Metadata
protected

Definition at line 291 of file vtkAMRBaseReader.h.

◆ LoadedMetaData

bool vtkAMRBaseReader::LoadedMetaData
protected

Definition at line 292 of file vtkAMRBaseReader.h.

◆ BlockMap

std::vector<int> vtkAMRBaseReader::BlockMap
protected

Definition at line 294 of file vtkAMRBaseReader.h.


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