#include <vtkAMRBaseParticlesReader.h>

Inheritance diagram for vtkAMRBaseParticlesReader:

Collaboration diagram for vtkAMRBaseParticlesReader:

Public Types
typedef vtkMultiBlockDataSetAlgorithm	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)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkAMRBaseParticlesReader *	SafeDownCast (vtkObjectBase *o)
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)
Static Protected Member Functions

static void	SelectionModifiedCallback (vtkObject caller, unsigned long eid, void clientdata, void *calldata)
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

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

Reimplemented from vtkMultiBlockDataSetAlgorithm.

Reimplemented in vtkAMREnzoParticlesReader, and vtkAMRFlashParticlesReader.

Definition at line 40 of file vtkAMRBaseParticlesReader.h.

Constructor & Destructor Documentation

vtkAMRBaseParticlesReader::vtkAMRBaseParticlesReader ( ) [protected]

virtual vtkAMRBaseParticlesReader::~vtkAMRBaseParticlesReader ( ) [protected, virtual]

Member Function Documentation

static int vtkAMRBaseParticlesReader::IsTypeOf ( const char * name ) [static]

Return 1 if this class type 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.

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]

Reimplemented from vtkMultiBlockDataSetAlgorithm.

Reimplemented in vtkAMREnzoParticlesReader, and vtkAMRFlashParticlesReader.

virtual vtkObjectBase* vtkAMRBaseParticlesReader::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkMultiBlockDataSetAlgorithm.

Reimplemented in vtkAMREnzoParticlesReader, and vtkAMRFlashParticlesReader.

vtkAMRBaseParticlesReader* vtkAMRBaseParticlesReader::NewInstance ( ) const

Reimplemented from vtkMultiBlockDataSetAlgorithm.

Reimplemented in vtkAMREnzoParticlesReader, and vtkAMRFlashParticlesReader.

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 ( ) [protected, pure 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 ) [protected, pure 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 ( ) [protected, pure 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
	)		`[static, protected]`

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

virtual int vtkAMRBaseParticlesReader::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)		`[protected, virtual]`