#include <vtkAMRBaseParticlesReader.h>

Inheritance diagram for vtkAMRBaseParticlesReader:

Collaboration diagram for vtkAMRBaseParticlesReader:

Public Types
typedef vtkMultiBlockDataSetAlgorithm	Superclass

Public Types inherited from vtkMultiBlockDataSetAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
typedef vtkObject	Superclass

enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkAMRBaseParticlesReader *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

int	GetNumberOfParticleArrays ()

const char *	GetParticleArrayName (int index)

virtual void	SetFileName (const char *fileName)

virtual char *	GetFileName ()

virtual int	GetTotalNumberOfParticles ()=0


virtual int	GetFrequency ()

virtual void	SetFrequency (int)


virtual vtkMultiProcessController *	GetController ()

virtual void	SetController (vtkMultiProcessController *)


virtual void	SetFilterLocation (int)

virtual int	GetFilterLocation ()

virtual void	FilterLocationOn ()

virtual void	FilterLocationOff ()


virtual vtkDataArraySelection *	GetParticleDataArraySelection ()


int	GetParticleArrayStatus (const char *name)

void	SetParticleArrayStatus (const char *name, int status)


void	SetMinLocation (const double minx, const double miny, const double minz)


void	SetMaxLocation (const double maxx, const double maxy, const double maxz)

Public Member Functions inherited from vtkMultiBlockDataSetAlgorithm
vtkMultiBlockDataSetAlgorithm *	NewInstance () const

vtkMultiBlockDataSet *	GetOutput ()

vtkMultiBlockDataSet *	GetOutput (int)

void	SetInputData (vtkDataObject *)

void	SetInputData (int, vtkDataObject *)

virtual int	ProcessRequest (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const

int	HasExecutive ()

vtkExecutive *	GetExecutive ()

virtual void	SetExecutive (vtkExecutive *executive)

virtual int	ModifyRequest (vtkInformation *request, int when)

vtkInformation *	GetInputPortInformation (int port)

vtkInformation *	GetOutputPortInformation (int port)

int	GetNumberOfInputPorts ()

int	GetNumberOfOutputPorts ()

void	UpdateProgress (double amount)

vtkInformation *	GetInputArrayInformation (int idx)

void	RemoveAllInputs ()

vtkDataObject *	GetOutputDataObject (int port)

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	RemoveInputConnection (int port, int idx)

virtual void	RemoveAllInputConnections (int port)

int	GetNumberOfInputConnections (int port)

int	GetTotalNumberOfInputConnections ()

vtkAlgorithmOutput *	GetInputConnection (int port, int index)

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)

vtkAlgorithm *	GetInputAlgorithm (int port, int index)

vtkExecutive *	GetInputExecutive (int port, int index)

vtkInformation *	GetInputInformation (int port, int index)

vtkInformation *	GetOutputInformation (int port)

virtual void	UpdateInformation ()

virtual void	UpdateDataObject ()

virtual void	PropagateUpdateExtent ()

virtual void	UpdateWholeExtent ()

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)

int	SetUpdateExtentToWholeExtent (int port)

int	SetUpdateExtentToWholeExtent ()

void	SetUpdateExtent (int port, int extent[6])

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, unsigned long *mtime)

virtual vtkInformation *	GetInformation ()

virtual void	SetInformation (vtkInformation *)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

virtual void	SetAbortExecute (int)

virtual int	GetAbortExecute ()

virtual void	AbortExecuteOn ()

virtual void	AbortExecuteOff ()

virtual void	SetProgress (double)

virtual double	GetProgress ()

void	SetProgressText (const char *ptext)

virtual char *	GetProgressText ()

virtual unsigned long	GetErrorCode ()

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)

vtkDataObject *	GetInputDataObject (int port, int connection)

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	SetInputConnection (vtkAlgorithmOutput *input)

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	AddInputConnection (vtkAlgorithmOutput *input)

virtual void	SetInputDataObject (int port, vtkDataObject *data)

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)

vtkAlgorithmOutput *	GetOutputPort ()

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive ()

vtkInformation *	GetInputInformation ()

virtual void	Update (int port)

virtual void	Update ()

virtual void	SetReleaseDataFlag (int)

virtual int	GetReleaseDataFlag ()

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)

void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int extent[6])

int *	GetUpdateExtent ()

int *	GetUpdateExtent (int port)

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int extent[6])

void	GetUpdateExtent (int port, int extent[6])

int	GetUpdatePiece ()

int	GetUpdatePiece (int port)

int	GetUpdateNumberOfPieces ()

int	GetUpdateNumberOfPieces (int port)

int	GetUpdateGhostLevel ()

int	GetUpdateGhostLevel (int port)

void	SetProgressObserver (vtkProgressObserver *)

virtual vtkProgressObserver *	GetProgressObserver ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

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)

int	InvokeEvent (unsigned long event, void *callData)

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

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkAMRBaseParticlesReader *	SafeDownCast (vtkObjectBase *o)

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

static int	IsTypeOf (const char *type)

static vtkMultiBlockDataSetAlgorithm *	SafeDownCast (vtkObjectBase *o)

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

static int	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAMRBaseParticlesReader ()

virtual	~vtkAMRBaseParticlesReader ()

virtual void	ReadMetaData ()=0

virtual vtkPolyData *	ReadParticles (const int blkIdx)=0

bool	CheckLocation (const double x, const double y, const double z)

bool	IsParallel ()

bool	IsBlockMine (const int blkIdx)

int	GetBlockProcessId (const int blkIdx)

void	Initialize ()

void	InitializeParticleDataSelections ()

virtual void	SetupParticleDataSelections ()=0


virtual int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual int	FillOutputPortInformation (int port, vtkInformation *info)

Protected Member Functions inherited from vtkMultiBlockDataSetAlgorithm
	vtkMultiBlockDataSetAlgorithm ()

	~vtkMultiBlockDataSetAlgorithm ()

virtual vtkExecutive *	CreateDefaultExecutive ()

virtual int	FillInputPortInformation (int port, vtkInformation *info)

vtkDataObject *	GetInput (int port)

virtual int	RequestDataObject (vtkInformation , vtkInformationVector , vtkInformationVector )

virtual int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )

virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )

Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()

	~vtkAlgorithm ()

virtual void	SetNumberOfInputPorts (int n)

virtual void	SetNumberOfOutputPorts (int n)

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	SetNumberOfInputConnections (int port, int n)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)

int	GetInputArrayAssociation (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)

void	SetInputDataInternal (int port, vtkDataObject *input)

void	AddInputDataInternal (int port, vtkDataObject *input)

virtual void	SetErrorCode (unsigned long)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Member Functions

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

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

Protected Attributes
int	NumberOfBlocks

int	FilterLocation

double	MinLocation [3]

double	MaxLocation [3]

int	Frequency

vtkMultiProcessController *	Controller

bool	InitialRequest

bool	Initialized

char *	FileName


vtkDataArraySelection *	ParticleDataArraySelection

vtkCallbackCommand *	SelectionObserver

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

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

Definition at line 36 of file vtkAMRBaseParticlesReader.h.

Member Typedef Documentation

typedef vtkMultiBlockDataSetAlgorithm vtkAMRBaseParticlesReader::Superclass

Definition at line 40 of file vtkAMRBaseParticlesReader.h.

Constructor & Destructor Documentation

vtkAMRBaseParticlesReader::vtkAMRBaseParticlesReader ( )

protected

virtual vtkAMRBaseParticlesReader::~vtkAMRBaseParticlesReader ( )

protectedvirtual

Member Function Documentation

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

static

virtual int 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 vtkAMREnzoParticlesReader, and vtkAMRFlashParticlesReader.

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

static

virtual vtkObjectBase* vtkAMRBaseParticlesReader::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkMultiBlockDataSetAlgorithm.

Reimplemented in vtkAMREnzoParticlesReader, and vtkAMRFlashParticlesReader.

vtkAMRBaseParticlesReader* vtkAMRBaseParticlesReader::NewInstance ( ) const

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

virtual

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 vtkAMREnzoParticlesReader, and vtkAMRFlashParticlesReader.

virtual int vtkAMRBaseParticlesReader::GetFrequency ( )

virtual

Set & Get the frequency.

virtual void vtkAMRBaseParticlesReader::SetFrequency ( int )

virtual

Set & Get the frequency.

virtual vtkMultiProcessController* vtkAMRBaseParticlesReader::GetController ( )

virtual

Set & Get the multi-process controller.

virtual void vtkAMRBaseParticlesReader::SetController ( vtkMultiProcessController * )

virtual

Set & Get the multi-process controller.

virtual void vtkAMRBaseParticlesReader::SetFilterLocation ( int )

virtual

Set & Get for filter location and boolean macro

virtual int vtkAMRBaseParticlesReader::GetFilterLocation ( )

virtual

Set & Get for filter location and boolean macro

virtual void vtkAMRBaseParticlesReader::FilterLocationOn ( )

virtual

Set & Get for filter location and boolean macro

virtual void vtkAMRBaseParticlesReader::FilterLocationOff ( )

virtual

Set & Get for filter location and boolean macro

virtual vtkDataArraySelection* vtkAMRBaseParticlesReader::GetParticleDataArraySelection ( )

virtual

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

int vtkAMRBaseParticlesReader::GetNumberOfParticleArrays ( )

Get the number of particles arrays available in the input.

const char* vtkAMRBaseParticlesReader::GetParticleArrayName ( int index )

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

int vtkAMRBaseParticlesReader::GetParticleArrayStatus ( const char * name )

Get/Set whether the particle array status.

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

Get/Set whether the particle array status.

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

virtual

virtual char* vtkAMRBaseParticlesReader::GetFileName ( )

virtual

void vtkAMRBaseParticlesReader::SetMinLocation	(	const double	minx,
		const double	miny,
		const double	minz
	)

inline

Sets the min location

Definition at line 88 of file vtkAMRBaseParticlesReader.h.

void vtkAMRBaseParticlesReader::SetMaxLocation	(	const double	maxx,
		const double	maxy,
		const double	maxz
	)

inline

Sets the max location

Definition at line 99 of file vtkAMRBaseParticlesReader.h.

virtual int vtkAMRBaseParticlesReader::GetTotalNumberOfParticles ( )

pure virtual

Returns the total number of particles

Implemented in vtkAMREnzoParticlesReader, and vtkAMRFlashParticlesReader.

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 vtkAMREnzoParticlesReader, and vtkAMRFlashParticlesReader.

virtual vtkPolyData* vtkAMRBaseParticlesReader::ReadParticles ( const int blkIdx )

protectedpure virtual

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

Implemented in vtkAMREnzoParticlesReader, and vtkAMRFlashParticlesReader.

bool vtkAMRBaseParticlesReader::CheckLocation	(	const double	x,
		const double	y,
		const double	z
	)

protected

Filters particles by their location. If FilterLocation is ON, this method returns whether or not the particle with the supplied xyz coordiantes flass within the bouning box spefixied by the user using the SetMinLocation & SetMaxLocation.

bool vtkAMRBaseParticlesReader::IsParallel ( )

protected

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

bool vtkAMRBaseParticlesReader::IsBlockMine ( const 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.

int vtkAMRBaseParticlesReader::GetBlockProcessId ( const 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.

void vtkAMRBaseParticlesReader::Initialize ( )

protected

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

void vtkAMRBaseParticlesReader::InitializeParticleDataSelections ( )

protected

Initializes the ParticleDataArraySelection object. This method only executes for an intial request in which case all arrays are deselected.

virtual void vtkAMRBaseParticlesReader::SetupParticleDataSelections ( )

protectedpure virtual

Sets up the ParticleDataArraySelection. Implemented by concrete classes.

Implemented in vtkAMREnzoParticlesReader, and vtkAMRFlashParticlesReader.

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

staticprotected

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

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