VTK: vtkAMRBaseParticlesReader Class Reference

| VTK 9.3.1

Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
vtkAMRBaseParticlesReader Class Referenceabstract

An abstract base class that implements all the common functionality for all particle readers. More...

`#include <vtkAMRBaseParticlesReader.h>`

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

## Public Types
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...
vtkAMRBaseParticlesReader * | NewInstance () const
void | PrintSelf (ostream &os, vtkIndent indent) override
| Methods invoked by print to print information about the object including superclasses. More...
int | GetNumberOfParticleArrays ()
| Get the number of particles arrays available in the input. More...
const char * | GetParticleArrayName (int index)
| Get the particle array name of the array associated with the given index. More...
virtual void | SetFileName (VTK_FILEPATH const char *fileName)
| vtkGetFilePathMacro (FileName)
virtual int | GetTotalNumberOfParticles ()=0
| Returns the total number of particles. More...
virtual int | GetFrequency ()
| Set & Get the frequency. More...
virtual void | SetFrequency (int)
| Set & Get the frequency. More...
virtual vtkMultiProcessController * | GetController ()
| Set & Get the multi-process controller. More...
virtual void | SetController (vtkMultiProcessController *)
| Set & Get the multi-process controller. More...
virtual void | SetFilterLocation (vtkTypeBool)
| Set & Get for filter location and boolean macro. More...
virtual vtkTypeBool | GetFilterLocation ()
| Set & Get for filter location and boolean macro. More...
virtual void | FilterLocationOn ()
| Set & Get for filter location and boolean macro. More...
virtual void | FilterLocationOff ()
| Set & Get for filter location and boolean macro. More...
virtual vtkDataArraySelection * | GetParticleDataArraySelection ()
| Get the data array selection tables used to configure which data arrays are loaded by the reader. More...
int | GetParticleArrayStatus (const char *name)
| Get/Set whether the particle array status. More...
void | SetParticleArrayStatus (const char *name, int status)
| Get/Set whether the particle array status. More...
void | SetMinLocation (double minx, double miny, double minz)
| Sets the min location. More...
void | SetMaxLocation (double maxx, double maxy, double maxz)
| Sets the max location. More...
Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm
vtkMultiBlockDataSetAlgorithm * | NewInstance () const
vtkTypeBool | ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
| see vtkAlgorithm for details More...
vtkMultiBlockDataSet * | GetOutput ()
| Get the output data object for a port on this algorithm. More...
vtkMultiBlockDataSet * | GetOutput (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
vtkAlgorithm * | NewInstance () const
vtkTypeBool | HasExecutive ()
| Check whether this algorithm has an assigned executive. More...
vtkExecutive * | GetExecutive ()
| 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...
vtkInformation * | GetInputPortInformation (int port)
| Get the information object associated with an input port. More...
vtkInformation * | GetOutputPortInformation (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...
vtkInformation * | GetInputArrayInformation (int idx)
| Get the info object for the specified input array to this algorithm. More...
void | RemoveAllInputs ()
| Remove all the input data. More...
vtkDataObject * | GetOutputDataObject (int port)
| Get the data object that will contain the algorithm output for the given port. More...
vtkDataObject * | GetInputDataObject (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)
vtkAlgorithmOutput * | GetOutputPort (int index)
| Get a proxy object corresponding to the given output port of this algorithm. More...
vtkAlgorithmOutput * | GetOutputPort ()
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...
vtkAlgorithmOutput * | GetInputConnection (int port, int index)
| Get the algorithm output port connected to an input port. More...
vtkAlgorithm * | GetInputAlgorithm (int port, int index, int &algPort)
| Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
vtkAlgorithm * | GetInputAlgorithm (int port, int index)
| Returns the algorithm connected to a port-index pair. More...
vtkAlgorithm * | GetInputAlgorithm ()
| Equivalent to GetInputAlgorithm(0, 0). More...
vtkExecutive * | GetInputExecutive (int port, int index)
| Returns the executive associated with a particular input connection. More...
vtkExecutive * | GetInputExecutive ()
| Equivalent to GetInputExecutive(0, 0) More...
vtkInformation * | GetInputInformation (int port, int index)
| Return the information object that is associated with a particular input connection. More...
vtkInformation * | GetInputInformation ()
| Equivalent to GetInputInformation(0, 0) More...
vtkInformation * | GetOutputInformation (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...
virtual vtkInformation * | GetInformation ()
| 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...
vtkAlgorithm * | GetContainerAlgorithm ()
| 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 vtkProgressObserver * | GetProgressObserver ()
| If an ProgressObserver is set, the algorithm will report progress through it rather than directly. 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...
vtkCommand * | GetCommand (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...
virtual 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 vtkTypeBool | IsTypeOf (const char *type)
static vtkAMRBaseParticlesReader * | SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm
static vtkMultiBlockDataSetAlgorithm * | New ()
static vtkTypeBool | IsTypeOf (const char *type)
static vtkMultiBlockDataSetAlgorithm * | SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm * | New ()
static vtkTypeBool | IsTypeOf (const char *type)
static vtkAlgorithm * | SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey * | INPUT_IS_OPTIONAL ()
| Keys used to specify input port requirements. More...
static vtkInformationIntegerKey * | INPUT_IS_REPEATABLE ()
static vtkInformationInformationVectorKey * | INPUT_REQUIRED_FIELDS ()
static vtkInformationStringVectorKey * | INPUT_REQUIRED_DATA_TYPE ()
static vtkInformationInformationVectorKey * | INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKey * | INPUT_PORT ()
static vtkInformationIntegerKey * | INPUT_CONNECTION ()
static vtkInformationIntegerKey * | CAN_PRODUCE_SUB_EXTENT ()
| This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
static vtkInformationIntegerKey * | CAN_HANDLE_PIECE_REQUEST ()
| Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
static vtkInformationIntegerKey * | ABORTED ()
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 vtkObject * | New ()
| 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 vtkObjectBase * | New ()
| 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 vtkObjectBase * | NewInstanceInternal () const
| vtkAMRBaseParticlesReader ()
| ~vtkAMRBaseParticlesReader () override
virtual void | ReadMetaData ()=0
| Reads the metadata, e.g., the number of blocks in the file. More...
virtual vtkPolyData * | ReadParticles (int blkIdx)=0
| Reads the particles corresponding to the block associated with the given supplied block index. More...
bool | CheckLocation (double x, double y, double z)
| Filters particles by their location. More...
bool | IsParallel ()
| Determines whether this reader instance is running in parallel or not. More...
bool | IsBlockMine (int blkIdx)
| Determines if the block associated with the given block index belongs to the process that executes the current instance of the reader. More...
int | GetBlockProcessId (int blkIdx)
| Given the block index, this method determines the process Id. More...
void | Initialize ()
| Initializes the AMR Particles reader NOTE: must be called in the constructor of concrete classes. More...
void | InitializeParticleDataSelections ()
| Initializes the ParticleDataArraySelection object. More...
virtual void | SetupParticleDataSelections ()=0
| Sets up the ParticleDataArraySelection. More...
int | RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
| Standard pipeline operations. More...
int | FillOutputPortInformation (int port, vtkInformation *info) override
| Standard pipeline operations. 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 | RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
| This is called by the superclass. More...
vtkExecutive * | CreateDefaultExecutive () override
| Create a default executive. More...
int | FillInputPortInformation (int port, vtkInformation *info) override
| Fill the input port information objects for this algorithm. More...
vtkDataObject * | GetInput (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...
vtkInformation * | GetInputArrayFieldInformation (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...
vtkDataArray * | GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
| Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
vtkDataArray * | GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
| Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
vtkDataArray * | GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
| Filters that have multiple connections on one port can use this signature. More...
vtkDataArray * | GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
| Filters that have multiple connections on one port can use this signature. More...
vtkDataArray * | GetInputArrayToProcess (int idx, vtkDataObject *input)
| Filters that have multiple connections on one port can use this signature. More...
vtkDataArray * | GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
| Filters that have multiple connections on one port can use this signature. More...
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
| Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
| Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
| Filters that have multiple connections on one port can use this signature. More...
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
| Filters that have multiple connections on one port can use this signature. More...
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
| Filters that have multiple connections on one port can use this signature. More...
vtkAbstractArray * | GetInputAbstractArrayToProcess (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 &)

## Static Protected Member Functions
static void | SelectionModifiedCallback (vtkObject *caller, unsigned long eid, void *clientdata, void *calldata)
| Call-back registered with the SelectionObserver for selecting/deselecting particles. More...
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey * | PORT_REQUIREMENTS_FILLED ()
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction | GetCurrentMallocFunction ()
static vtkReallocingFunction | GetCurrentReallocFunction ()
static vtkFreeingFunction | GetCurrentFreeFunction ()
static vtkFreeingFunction | GetAlternateFreeFunction ()

## Protected Attributes
int | NumberOfBlocks
vtkTypeBool | FilterLocation
double | MinLocation [3]
double | MaxLocation [3]
int | Frequency
vtkMultiProcessController * | Controller
bool | InitialRequest
bool | Initialized
char * | FileName
vtkDataArraySelection * | ParticleDataArraySelection
| Standard Array selection variables & methods. More...
vtkCallbackCommand * | SelectionObserver
| Standard Array selection variables & methods. More...
Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp | LastAbortCheckTime
vtkInformation * | Information
double | Progress
char * | ProgressText
vtkProgressObserver * | ProgressObserver
unsigned long | ErrorCode
| The error code contains a possible error that occurred while reading or writing the file. 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

## Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBool > | AbortExecute
Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp | LastAbortTime
static vtkExecutive * | DefaultExecutivePrototype

## Detailed Description

An abstract base class that implements all the common functionality for all particle readers.

Definition at line 24 of file vtkAMRBaseParticlesReader.h.

## Member Typedef Documentation

## ◆ Superclass

typedef vtkMultiBlockDataSetAlgorithm vtkAMRBaseParticlesReader::Superclass

Definition at line 27 of file vtkAMRBaseParticlesReader.h.

## Constructor & Destructor Documentation

## ◆ vtkAMRBaseParticlesReader()

vtkAMRBaseParticlesReader::vtkAMRBaseParticlesReader | ( |  | ) |
| protected

## ◆ ~vtkAMRBaseParticlesReader()

vtkAMRBaseParticlesReader::~vtkAMRBaseParticlesReader | ( |  | ) |
| overrideprotected

## Member Function Documentation

## ◆ IsTypeOf()

static vtkTypeBool vtkAMRBaseParticlesReader::IsTypeOf | ( | const char * | type | ) |
| static

## ◆ IsA()

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

Reimplemented in vtkAMRFlashParticlesReader, and vtkAMREnzoParticlesReader.

## ◆ SafeDownCast()

static vtkAMRBaseParticlesReader* vtkAMRBaseParticlesReader::SafeDownCast | ( | vtkObjectBase * | o | ) |
| static

## ◆ NewInstanceInternal()

virtual vtkObjectBase* vtkAMRBaseParticlesReader::NewInstanceInternal | ( |  | ) | const
| protectedvirtual

Reimplemented from vtkMultiBlockDataSetAlgorithm.

Reimplemented in vtkAMRFlashParticlesReader, and vtkAMREnzoParticlesReader.

## ◆ NewInstance()

vtkAMRBaseParticlesReader* vtkAMRBaseParticlesReader::NewInstance | ( |  | ) | const

## ◆ PrintSelf()

void vtkAMRBaseParticlesReader::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.

Reimplemented in vtkAMRFlashParticlesReader, and vtkAMREnzoParticlesReader.

## ◆ GetFrequency()

virtual int vtkAMRBaseParticlesReader::GetFrequency | ( |  | ) |
| virtual

Set & Get the frequency.

## ◆ SetFrequency()

virtual void vtkAMRBaseParticlesReader::SetFrequency | ( | int |  | ) |
| virtual

Set & Get the frequency.

## ◆ GetController()

virtual vtkMultiProcessController* vtkAMRBaseParticlesReader::GetController | ( |  | ) |
| virtual

Set & Get the multi-process controller.

## ◆ SetController()

virtual void vtkAMRBaseParticlesReader::SetController | ( | vtkMultiProcessController * |  | ) |
| virtual

Set & Get the multi-process controller.

## ◆ SetFilterLocation()

virtual void vtkAMRBaseParticlesReader::SetFilterLocation | ( | vtkTypeBool |  | ) |
| virtual

Set & Get for filter location and boolean macro.

## ◆ GetFilterLocation()

virtual vtkTypeBool vtkAMRBaseParticlesReader::GetFilterLocation | ( |  | ) |
| virtual

Set & Get for filter location and boolean macro.

## ◆ FilterLocationOn()

virtual void vtkAMRBaseParticlesReader::FilterLocationOn | ( |  | ) |
| virtual

Set & Get for filter location and boolean macro.

## ◆ FilterLocationOff()

virtual void vtkAMRBaseParticlesReader::FilterLocationOff | ( |  | ) |
| virtual

Set & Get for filter location and boolean macro.

## ◆ GetParticleDataArraySelection()

virtual vtkDataArraySelection* vtkAMRBaseParticlesReader::GetParticleDataArraySelection | ( |  | ) |
| virtual

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

## ◆ GetNumberOfParticleArrays()

int vtkAMRBaseParticlesReader::GetNumberOfParticleArrays | ( |  | ) |

Get the number of particles arrays available in the input.

## ◆ GetParticleArrayName()

const char* vtkAMRBaseParticlesReader::GetParticleArrayName | ( | int | index | ) |

Get the particle array name of the array associated with the given index.

## ◆ GetParticleArrayStatus()

int vtkAMRBaseParticlesReader::GetParticleArrayStatus | ( | const char * | name | ) |

Get/Set whether the particle array status.

## ◆ SetParticleArrayStatus()

void vtkAMRBaseParticlesReader::SetParticleArrayStatus | ( | const char * | name,
|  | int | status
| ) |  |

Get/Set whether the particle array status.

## ◆ SetFileName()

virtual void vtkAMRBaseParticlesReader::SetFileName | ( | VTK_FILEPATH const char * | fileName | ) |
| virtual

## ◆ vtkGetFilePathMacro()

vtkAMRBaseParticlesReader::vtkGetFilePathMacro | ( | FileName |  | ) |

## ◆ SetMinLocation()

void vtkAMRBaseParticlesReader::SetMinLocation | ( | double | minx,
|  | double | miny,
|  | double | minz
| ) |  |
| inline

Sets the min location.

Definition at line 89 of file vtkAMRBaseParticlesReader.h.

## ◆ SetMaxLocation()

void vtkAMRBaseParticlesReader::SetMaxLocation | ( | double | maxx,
|  | double | maxy,
|  | double | maxz
| ) |  |
| inline

Sets the max location.

Definition at line 101 of file vtkAMRBaseParticlesReader.h.

## ◆ GetTotalNumberOfParticles()

virtual int vtkAMRBaseParticlesReader::GetTotalNumberOfParticles | ( |  | ) |
| pure virtual

Returns the total number of particles.

Implemented in vtkAMRFlashParticlesReader, and vtkAMREnzoParticlesReader.

## ◆ ReadMetaData()

virtual void vtkAMRBaseParticlesReader::ReadMetaData | ( |  | ) |
| protectedpure virtual

Reads the metadata, e.g., the number of blocks in the file.

After the metadata is read, this->Initialized is set to true. Furthermore, to limit I/O, all concrete classes must make sure that this method returns immediately if this->Initialized is true.

Implemented in vtkAMRFlashParticlesReader, and vtkAMREnzoParticlesReader.

## ◆ ReadParticles()

virtual vtkPolyData* vtkAMRBaseParticlesReader::ReadParticles | ( | int | blkIdx | ) |
| protectedpure virtual

Reads the particles corresponding to the block associated with the given supplied block index.

Implemented in vtkAMRFlashParticlesReader, and vtkAMREnzoParticlesReader.

## ◆ CheckLocation()

bool vtkAMRBaseParticlesReader::CheckLocation | ( | double | x,
|  | double | y,
|  | double | z
| ) |  |
| protected

Filters particles by their location.

If FilterLocation is ON, this method returns whether or not the particle with the supplied xyz coordinates class within the bounding box specified by the user using the SetMinLocation & SetMaxLocation.

## ◆ IsParallel()

bool vtkAMRBaseParticlesReader::IsParallel | ( |  | ) |
| protected

Determines whether this reader instance is running in parallel or not.

## ◆ IsBlockMine()

bool vtkAMRBaseParticlesReader::IsBlockMine | ( | int | blkIdx | ) |
| protected

Determines if the block associated with the given block index belongs to the process that executes the current instance of the reader.

## ◆ GetBlockProcessId()

int vtkAMRBaseParticlesReader::GetBlockProcessId | ( | int | blkIdx | ) |
| protected

Given the block index, this method determines the process Id.

If the reader instance is serial this method always returns 0. Otherwise, static block-cyclic-distribution is assumed and each block is assigned to a process according to blkIdxN, where N is the total number of processes.

## ◆ Initialize()

void vtkAMRBaseParticlesReader::Initialize | ( |  | ) |
| protected

Initializes the AMR Particles reader NOTE: must be called in the constructor of concrete classes.

## ◆ InitializeParticleDataSelections()

void vtkAMRBaseParticlesReader::InitializeParticleDataSelections | ( |  | ) |
| protected

Initializes the ParticleDataArraySelection object.

This method only executes for an initial request in which case all arrays are deselected.

## ◆ SetupParticleDataSelections()

virtual void vtkAMRBaseParticlesReader::SetupParticleDataSelections | ( |  | ) |
| protectedpure virtual

Sets up the ParticleDataArraySelection.

Implemented by concrete classes.

Implemented in vtkAMRFlashParticlesReader, and vtkAMREnzoParticlesReader.

## ◆ SelectionModifiedCallback()

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

Call-back registered with the SelectionObserver for selecting/deselecting particles.

## ◆ RequestData()

int vtkAMRBaseParticlesReader::RequestData | ( | vtkInformation * | request,
|  | vtkInformationVector ** | inputVector,
|  | vtkInformationVector * | outputVector
| ) |  |
| overrideprotectedvirtual

Standard pipeline operations.

Reimplemented from vtkMultiBlockDataSetAlgorithm.

## ◆ FillOutputPortInformation()

int vtkAMRBaseParticlesReader::FillOutputPortInformation | ( | int | port,
|  | vtkInformation * | info
| ) |  |
| overrideprotectedvirtual

Standard pipeline operations.

Reimplemented from vtkMultiBlockDataSetAlgorithm.

## Member Data Documentation

## ◆ ParticleDataArraySelection

vtkDataArraySelection* vtkAMRBaseParticlesReader::ParticleDataArraySelection
| protected

Standard Array selection variables & methods.

Definition at line 170 of file vtkAMRBaseParticlesReader.h.

## ◆ SelectionObserver

vtkCallbackCommand* vtkAMRBaseParticlesReader::SelectionObserver
| protected

Standard Array selection variables & methods.

Definition at line 171 of file vtkAMRBaseParticlesReader.h.

## ◆ NumberOfBlocks

int vtkAMRBaseParticlesReader::NumberOfBlocks
| protected

Definition at line 203 of file vtkAMRBaseParticlesReader.h.

## ◆ FilterLocation

vtkTypeBool vtkAMRBaseParticlesReader::FilterLocation
| protected

Definition at line 205 of file vtkAMRBaseParticlesReader.h.

## ◆ MinLocation

double vtkAMRBaseParticlesReader::MinLocation[3]
| protected

Definition at line 206 of file vtkAMRBaseParticlesReader.h.

## ◆ MaxLocation

double vtkAMRBaseParticlesReader::MaxLocation[3]
| protected

Definition at line 207 of file vtkAMRBaseParticlesReader.h.

## ◆ Frequency

int vtkAMRBaseParticlesReader::Frequency
| protected

Definition at line 209 of file vtkAMRBaseParticlesReader.h.

## ◆ Controller

vtkMultiProcessController* vtkAMRBaseParticlesReader::Controller
| protected

Definition at line 210 of file vtkAMRBaseParticlesReader.h.

## ◆ InitialRequest

bool vtkAMRBaseParticlesReader::InitialRequest
| protected

Definition at line 212 of file vtkAMRBaseParticlesReader.h.

## ◆ Initialized

bool vtkAMRBaseParticlesReader::Initialized
| protected

Definition at line 213 of file vtkAMRBaseParticlesReader.h.

## ◆ FileName

char* vtkAMRBaseParticlesReader::FileName
| protected

Definition at line 214 of file vtkAMRBaseParticlesReader.h.

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

- IO/AMR/vtkAMRBaseParticlesReader.h