ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
vtkPGenericIOMultiBlockReader Class Reference

Creates a vtkMultiBlockDataSet from a GenericIO file. More...

#include <vtkPGenericIOMultiBlockReader.h>

Inherits vtkMultiBlockDataSetAlgorithm.

Public Types

enum  IOType { IOTYPEMPI, IOTYPEPOSIX }
 
enum  BlockAssignment { ROUND_ROBIN, RCB }
 
typedef vtkMultiBlockDataSetAlgorithm Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int GetNumberOfPointArrays ()
 Returns the number of arrays in the file, i.e., the number of columns. More...
 
const char * GetPointArrayName (int i)
 Returns the name of the ith array. More...
 
int GetPointArrayStatus (const char *name)
 Returns the status of the array corresponding to the given name. More...
 
void SetPointArrayStatus (const char *name, int status)
 Sets the status of the array corresponding to the given name. More...
 
vtkIdType GetRequestedHaloId (vtkIdType i)
 Gets the ith requested halo id. More...
 
vtkIdType GetNumberOfRequestedHaloIds ()
 Gets the number of requested halo ids. More...
 
void SetNumberOfRequestedHaloIds (vtkIdType numIds)
 Sets the number of requested halo ids. More...
 
void AddRequestedHaloId (vtkIdType haloId)
 Adds the given halo id to the list of halo ids to request. More...
 
void ClearRequestedHaloIds ()
 Clears the list of requested halo ids. More...
 
void SetRequestedHaloId (vtkIdType i, vtkIdType haloId)
 Sets the ith requested halo id to the given haloId. More...
 
virtual void SetXAxisVariableName (const char *)
 Set/Get the variable name to be used as the x-axis for plotting particles. More...
 
virtual char * GetXAxisVariableName ()
 Set/Get the variable name to be used as the x-axis for plotting particles. More...
 
virtual void SetYAxisVariableName (const char *)
 Set/Get the variable name to be used as the y-axis for plotting particles. More...
 
virtual char * GetYAxisVariableName ()
 Set/Get the variable name to be used as the y-axis for plotting particles. More...
 
virtual void SetZAxisVariableName (const char *)
 Set/Get the variable name to be used as the z-axis for plotting particles. More...
 
virtual char * GetZAxisVariableName ()
 Set/Get the variable name to be used as the z-axis for plotting particles. More...
 
virtual void SetFileName (const char *)
 Specify the name of the cosmology particle binary file to read. More...
 
virtual char * GetFileName ()
 Specify the name of the cosmology particle binary file to read. More...
 
virtual void SetGenericIOType (int)
 Set/Get the underlying IO method the reader will employ, i.e., MPI or POSIX. More...
 
virtual int GetGenericIOType ()
 Set/Get the underlying IO method the reader will employ, i.e., MPI or POSIX. More...
 
virtual void SetBlockAssignment (int)
 Set/Get the underlying block-assignment strategy to use, i.e., ROUND_ROBIN, or RCB. More...
 
virtual int GetBlockAssignment ()
 Set/Get the underlying block-assignment strategy to use, i.e., ROUND_ROBIN, or RCB. More...
 
virtual vtkStringArray * GetArrayList ()
 Returns the list of arrays used to select the variables to be used for the x,y and z axis. More...
 
virtual vtkDataArraySelection * GetPointDataArraySelection ()
 Get the data array selection tables used to configure which data arrays are loaded by the reader. More...
 
virtual vtkMultiProcessController * GetController ()
 Set/Get a multiprocess-controller for reading in parallel. More...
 
virtual void SetController (vtkMultiProcessController *)
 Set/Get a multiprocess-controller for reading in parallel. More...
 
virtual void SetHaloIdVariableName (const char *)
 Gets/Sets the variable name for the halo id of the particle. More...
 
virtual char * GetHaloIdVariableName ()
 Gets/Sets the variable name for the halo id of the particle. More...
 

Static Public Member Functions

static vtkPGenericIOMultiBlockReaderNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPGenericIOMultiBlockReaderSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkPGenericIOMultiBlockReader ()
 
 ~vtkPGenericIOMultiBlockReader ()
 
gio::GenericIOReader * GetInternalReader ()
 
bool ReaderParametersChanged ()
 
void LoadMetaData ()
 
void LoadRawVariableDataForBlock (const std::string &varName, int blockId)
 
void LoadRawDataForBlock (int blockId)
 
void GetPointFromRawData (int xType, void *xBuffer, int yType, void *yBuffer, int zType, void *zBuffer, vtkIdType id, double point[3])
 
void LoadCoordinatesForBlock (vtkUnstructuredGrid *grid, std::set< vtkIdType > &pointsInSelectedHalos, int blockId)
 
void LoadDataArraysForBlock (vtkUnstructuredGrid *grid, const std::set< vtkIdType > &pointsInSelectedHalos, int blockId)
 
vtkUnstructuredGrid * LoadBlock (int blockId)
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 

Static Protected Member Functions

static void SelectionModifiedCallback (vtkObject *caller, unsigned long eid, void *clientdata, void *calldata)
 Call-back registered with the SelectionObserver. More...
 

Protected Attributes

char * XAxisVariableName
 
char * YAxisVariableName
 
char * ZAxisVariableName
 
char * HaloIdVariableName
 
char * FileName
 
int GenericIOType
 
int BlockAssignment
 
bool BuildMetaData
 
vtkMultiProcessController * Controller
 
vtkStringArray * ArrayList
 
vtkDataArraySelection * PointDataArraySelection
 
vtkIdList * HaloList
 
vtkCallbackCommand * SelectionObserver
 
gio::GenericIOReader * Reader
 

Detailed Description

Creates a vtkMultiBlockDataSet from a GenericIO file.

Definition at line 44 of file vtkPGenericIOMultiBlockReader.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMultiBlockDataSetAlgorithm vtkPGenericIOMultiBlockReader::Superclass

Definition at line 61 of file vtkPGenericIOMultiBlockReader.h.

Member Enumeration Documentation

◆ IOType

Enumerator
IOTYPEMPI 
IOTYPEPOSIX 

Definition at line 48 of file vtkPGenericIOMultiBlockReader.h.

◆ BlockAssignment

Enumerator
ROUND_ROBIN 
RCB 

Definition at line 54 of file vtkPGenericIOMultiBlockReader.h.

Constructor & Destructor Documentation

◆ vtkPGenericIOMultiBlockReader()

vtkPGenericIOMultiBlockReader::vtkPGenericIOMultiBlockReader ( )
protected

◆ ~vtkPGenericIOMultiBlockReader()

vtkPGenericIOMultiBlockReader::~vtkPGenericIOMultiBlockReader ( )
protected

Member Function Documentation

◆ New()

static vtkPGenericIOMultiBlockReader* vtkPGenericIOMultiBlockReader::New ( )
static

◆ GetClassName()

virtual const char* vtkPGenericIOMultiBlockReader::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

virtual int vtkPGenericIOMultiBlockReader::IsA ( const char *  type)
virtual

◆ SafeDownCast()

static vtkPGenericIOMultiBlockReader* vtkPGenericIOMultiBlockReader::SafeDownCast ( vtkObject *  o)
static

◆ PrintSelf()

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

◆ SetXAxisVariableName()

virtual void vtkPGenericIOMultiBlockReader::SetXAxisVariableName ( const char *  )
virtual

Set/Get the variable name to be used as the x-axis for plotting particles.

◆ GetXAxisVariableName()

virtual char* vtkPGenericIOMultiBlockReader::GetXAxisVariableName ( )
virtual

Set/Get the variable name to be used as the x-axis for plotting particles.

◆ SetYAxisVariableName()

virtual void vtkPGenericIOMultiBlockReader::SetYAxisVariableName ( const char *  )
virtual

Set/Get the variable name to be used as the y-axis for plotting particles.

◆ GetYAxisVariableName()

virtual char* vtkPGenericIOMultiBlockReader::GetYAxisVariableName ( )
virtual

Set/Get the variable name to be used as the y-axis for plotting particles.

◆ SetZAxisVariableName()

virtual void vtkPGenericIOMultiBlockReader::SetZAxisVariableName ( const char *  )
virtual

Set/Get the variable name to be used as the z-axis for plotting particles.

◆ GetZAxisVariableName()

virtual char* vtkPGenericIOMultiBlockReader::GetZAxisVariableName ( )
virtual

Set/Get the variable name to be used as the z-axis for plotting particles.

◆ SetFileName()

virtual void vtkPGenericIOMultiBlockReader::SetFileName ( const char *  )
virtual

Specify the name of the cosmology particle binary file to read.

◆ GetFileName()

virtual char* vtkPGenericIOMultiBlockReader::GetFileName ( )
virtual

Specify the name of the cosmology particle binary file to read.

◆ SetGenericIOType()

virtual void vtkPGenericIOMultiBlockReader::SetGenericIOType ( int  )
virtual

Set/Get the underlying IO method the reader will employ, i.e., MPI or POSIX.

◆ GetGenericIOType()

virtual int vtkPGenericIOMultiBlockReader::GetGenericIOType ( )
virtual

Set/Get the underlying IO method the reader will employ, i.e., MPI or POSIX.

◆ SetBlockAssignment()

virtual void vtkPGenericIOMultiBlockReader::SetBlockAssignment ( int  )
virtual

Set/Get the underlying block-assignment strategy to use, i.e., ROUND_ROBIN, or RCB.

◆ GetBlockAssignment()

virtual int vtkPGenericIOMultiBlockReader::GetBlockAssignment ( )
virtual

Set/Get the underlying block-assignment strategy to use, i.e., ROUND_ROBIN, or RCB.

◆ GetArrayList()

virtual vtkStringArray* vtkPGenericIOMultiBlockReader::GetArrayList ( )
virtual

Returns the list of arrays used to select the variables to be used for the x,y and z axis.

◆ GetPointDataArraySelection()

virtual vtkDataArraySelection* vtkPGenericIOMultiBlockReader::GetPointDataArraySelection ( )
virtual

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

◆ GetController()

virtual vtkMultiProcessController* vtkPGenericIOMultiBlockReader::GetController ( )
virtual

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

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

◆ SetController()

virtual void vtkPGenericIOMultiBlockReader::SetController ( vtkMultiProcessController *  )
virtual

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

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

◆ GetNumberOfPointArrays()

int vtkPGenericIOMultiBlockReader::GetNumberOfPointArrays ( )

Returns the number of arrays in the file, i.e., the number of columns.

◆ GetPointArrayName()

const char* vtkPGenericIOMultiBlockReader::GetPointArrayName ( int  i)

Returns the name of the ith array.

◆ GetPointArrayStatus()

int vtkPGenericIOMultiBlockReader::GetPointArrayStatus ( const char *  name)

Returns the status of the array corresponding to the given name.

◆ SetPointArrayStatus()

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

Sets the status of the array corresponding to the given name.

◆ SetHaloIdVariableName()

virtual void vtkPGenericIOMultiBlockReader::SetHaloIdVariableName ( const char *  )
virtual

Gets/Sets the variable name for the halo id of the particle.

This is used by the requested halo selector to select only the points in the desired halos.

◆ GetHaloIdVariableName()

virtual char* vtkPGenericIOMultiBlockReader::GetHaloIdVariableName ( )
virtual

Gets/Sets the variable name for the halo id of the particle.

This is used by the requested halo selector to select only the points in the desired halos.

◆ GetRequestedHaloId()

vtkIdType vtkPGenericIOMultiBlockReader::GetRequestedHaloId ( vtkIdType  i)

Gets the ith requested halo id.

If the number of requested halo ids is greater than 0, only points with those halo ids will be read in. Otherwise all points will be read in.

◆ GetNumberOfRequestedHaloIds()

vtkIdType vtkPGenericIOMultiBlockReader::GetNumberOfRequestedHaloIds ( )

Gets the number of requested halo ids.

If the number of requested halo ids is greater than 0, only points with those halo ids will be read in. Otherwise all points will be read in.

◆ SetNumberOfRequestedHaloIds()

void vtkPGenericIOMultiBlockReader::SetNumberOfRequestedHaloIds ( vtkIdType  numIds)

Sets the number of requested halo ids.

Use SetRequestedHaloId() to se the ids after this is called If the number of requested halo ids is greater than 0, only points with those halo ids will be read in. Otherwise all points will be read in.

◆ AddRequestedHaloId()

void vtkPGenericIOMultiBlockReader::AddRequestedHaloId ( vtkIdType  haloId)

Adds the given halo id to the list of halo ids to request.

If the number of requested halo ids is greater than 0, only points with those halo ids will be read in. Otherwise all points will be read in.

◆ ClearRequestedHaloIds()

void vtkPGenericIOMultiBlockReader::ClearRequestedHaloIds ( )

Clears the list of requested halo ids.

If the number of requested halo ids is greater than 0, only points with those halo ids will be read in. Otherwise all points will be read in.

◆ SetRequestedHaloId()

void vtkPGenericIOMultiBlockReader::SetRequestedHaloId ( vtkIdType  i,
vtkIdType  haloId 
)

Sets the ith requested halo id to the given haloId.

If the number of requested halo ids is greater than 0, only points with those halo ids will be read in. Otherwise all points will be read in.

◆ GetInternalReader()

gio::GenericIOReader* vtkPGenericIOMultiBlockReader::GetInternalReader ( )
protected

◆ ReaderParametersChanged()

bool vtkPGenericIOMultiBlockReader::ReaderParametersChanged ( )
protected

◆ LoadMetaData()

void vtkPGenericIOMultiBlockReader::LoadMetaData ( )
protected

◆ LoadRawVariableDataForBlock()

void vtkPGenericIOMultiBlockReader::LoadRawVariableDataForBlock ( const std::string &  varName,
int  blockId 
)
protected

◆ LoadRawDataForBlock()

void vtkPGenericIOMultiBlockReader::LoadRawDataForBlock ( int  blockId)
protected

◆ GetPointFromRawData()

void vtkPGenericIOMultiBlockReader::GetPointFromRawData ( int  xType,
void *  xBuffer,
int  yType,
void *  yBuffer,
int  zType,
void *  zBuffer,
vtkIdType  id,
double  point[3] 
)
protected

◆ LoadCoordinatesForBlock()

void vtkPGenericIOMultiBlockReader::LoadCoordinatesForBlock ( vtkUnstructuredGrid *  grid,
std::set< vtkIdType > &  pointsInSelectedHalos,
int  blockId 
)
protected

◆ LoadDataArraysForBlock()

void vtkPGenericIOMultiBlockReader::LoadDataArraysForBlock ( vtkUnstructuredGrid *  grid,
const std::set< vtkIdType > &  pointsInSelectedHalos,
int  blockId 
)
protected

◆ LoadBlock()

vtkUnstructuredGrid* vtkPGenericIOMultiBlockReader::LoadBlock ( int  blockId)
protected

◆ SelectionModifiedCallback()

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

Call-back registered with the SelectionObserver.

◆ RequestInformation()

virtual int vtkPGenericIOMultiBlockReader::RequestInformation ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

◆ RequestData()

virtual int vtkPGenericIOMultiBlockReader::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

Member Data Documentation

◆ XAxisVariableName

char* vtkPGenericIOMultiBlockReader::XAxisVariableName
protected

Definition at line 214 of file vtkPGenericIOMultiBlockReader.h.

◆ YAxisVariableName

char* vtkPGenericIOMultiBlockReader::YAxisVariableName
protected

Definition at line 215 of file vtkPGenericIOMultiBlockReader.h.

◆ ZAxisVariableName

char* vtkPGenericIOMultiBlockReader::ZAxisVariableName
protected

Definition at line 216 of file vtkPGenericIOMultiBlockReader.h.

◆ HaloIdVariableName

char* vtkPGenericIOMultiBlockReader::HaloIdVariableName
protected

Definition at line 217 of file vtkPGenericIOMultiBlockReader.h.

◆ FileName

char* vtkPGenericIOMultiBlockReader::FileName
protected

Definition at line 219 of file vtkPGenericIOMultiBlockReader.h.

◆ GenericIOType

int vtkPGenericIOMultiBlockReader::GenericIOType
protected

Definition at line 220 of file vtkPGenericIOMultiBlockReader.h.

◆ BlockAssignment

Definition at line 221 of file vtkPGenericIOMultiBlockReader.h.

◆ BuildMetaData

bool vtkPGenericIOMultiBlockReader::BuildMetaData
protected

Definition at line 223 of file vtkPGenericIOMultiBlockReader.h.

◆ Controller

vtkMultiProcessController* vtkPGenericIOMultiBlockReader::Controller
protected

Definition at line 225 of file vtkPGenericIOMultiBlockReader.h.

◆ ArrayList

vtkStringArray* vtkPGenericIOMultiBlockReader::ArrayList
protected

Definition at line 227 of file vtkPGenericIOMultiBlockReader.h.

◆ PointDataArraySelection

vtkDataArraySelection* vtkPGenericIOMultiBlockReader::PointDataArraySelection
protected

Definition at line 228 of file vtkPGenericIOMultiBlockReader.h.

◆ HaloList

vtkIdList* vtkPGenericIOMultiBlockReader::HaloList
protected

Definition at line 229 of file vtkPGenericIOMultiBlockReader.h.

◆ SelectionObserver

vtkCallbackCommand* vtkPGenericIOMultiBlockReader::SelectionObserver
protected

Definition at line 230 of file vtkPGenericIOMultiBlockReader.h.

◆ Reader

gio::GenericIOReader* vtkPGenericIOMultiBlockReader::Reader
protected

Definition at line 232 of file vtkPGenericIOMultiBlockReader.h.


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