VTK
Public Member Functions | Static Public Member Functions | List of all members
vtkXdmfDomain Class Reference

#include <vtkXdmfReaderInternal.h>

Public Member Functions

 vtkXdmfDomain (xdmf2::XdmfDOM *xmlDom, int domain_index)
 
bool IsValid ()
 After instantiating, check that the domain is valid. More...
 
vtkGraphGetSIL ()
 
XdmfInt64 GetNumberOfGrids ()
 Returns the number of top-level grids present in this domain. More...
 
xdmf2::XdmfGrid * GetGrid (XdmfInt64 cc)
 Provides access to a top-level grid from this domain. More...
 
int GetVTKDataType ()
 Returns the VTK data type need for this domain. More...
 
const std::map< XdmfFloat64, int > & GetTimeSteps ()
 Returns the timesteps. More...
 
const std::map< int, XdmfFloat64 > & GetTimeStepsRev ()
 
int GetIndexForTime (double time)
 Given a time value, returns the index. More...
 
XdmfFloat64 GetTimeForIndex (int index)
 Returns the time value at the given index. More...
 
xdmf2::XdmfGrid * GetGrid (xdmf2::XdmfGrid *xmfGrid, double time)
 If xmfGrid is a temporal collection, returns the child-grid matching the requested time. More...
 
bool IsStructured (xdmf2::XdmfGrid *)
 Returns true if the grids is a structured dataset. More...
 
bool GetWholeExtent (xdmf2::XdmfGrid *, int extents[6])
 Returns the whole extents for the dataset if the grid if IsStructured() returns true for the given grid. More...
 
bool GetOriginAndSpacing (xdmf2::XdmfGrid *, double origin[3], double spacing[3])
 Returns the spacing and origin for the grid if the grid topology == XDMF_2DCORECTMESH or XDMF_3DCORECTMESH i.e. More...
 
 ~vtkXdmfDomain ()
 
int GetVTKDataType (xdmf2::XdmfGrid *xmfGrid)
 
vtkXdmfArraySelectionGetPointArraySelection ()
 
vtkXdmfArraySelectionGetCellArraySelection ()
 
vtkXdmfArraySelectionGetGridSelection ()
 
vtkXdmfArraySelectionGetSetsSelection ()
 

Static Public Member Functions

static int GetDataDimensionality (xdmf2::XdmfGrid *xmfGrid)
 

Detailed Description

Definition at line 183 of file vtkXdmfReaderInternal.h.

Constructor & Destructor Documentation

◆ vtkXdmfDomain()

vtkXdmfDomain::vtkXdmfDomain ( xdmf2::XdmfDOM *  xmlDom,
int  domain_index 
)

◆ ~vtkXdmfDomain()

vtkXdmfDomain::~vtkXdmfDomain ( )

Member Function Documentation

◆ IsValid()

bool vtkXdmfDomain::IsValid ( )
inline

After instantiating, check that the domain is valid.

If this returns false, it means that the specified domain could not be located.

Definition at line 219 of file vtkXdmfReaderInternal.h.

◆ GetSIL()

vtkGraph* vtkXdmfDomain::GetSIL ( )
inline

Definition at line 222 of file vtkXdmfReaderInternal.h.

◆ GetNumberOfGrids()

XdmfInt64 vtkXdmfDomain::GetNumberOfGrids ( )
inline

Returns the number of top-level grids present in this domain.

Definition at line 228 of file vtkXdmfReaderInternal.h.

◆ GetGrid() [1/2]

xdmf2::XdmfGrid* vtkXdmfDomain::GetGrid ( XdmfInt64  cc)

Provides access to a top-level grid from this domain.

◆ GetVTKDataType() [1/2]

int vtkXdmfDomain::GetVTKDataType ( )

Returns the VTK data type need for this domain.

If the domain has only 1 grid, then a vtkDataSet-type is returned, otherwise a vtkMultiBlockDataSet is required. Returns -1 on error.

◆ GetTimeSteps()

const std::map<XdmfFloat64, int>& vtkXdmfDomain::GetTimeSteps ( )
inline

Returns the timesteps.

Definition at line 249 of file vtkXdmfReaderInternal.h.

◆ GetTimeStepsRev()

const std::map<int, XdmfFloat64>& vtkXdmfDomain::GetTimeStepsRev ( )
inline

Definition at line 250 of file vtkXdmfReaderInternal.h.

◆ GetIndexForTime()

int vtkXdmfDomain::GetIndexForTime ( double  time)

Given a time value, returns the index.

◆ GetTimeForIndex()

XdmfFloat64 vtkXdmfDomain::GetTimeForIndex ( int  index)
inline

Returns the time value at the given index.

Definition at line 263 of file vtkXdmfReaderInternal.h.

◆ GetGrid() [2/2]

xdmf2::XdmfGrid* vtkXdmfDomain::GetGrid ( xdmf2::XdmfGrid *  xmfGrid,
double  time 
)

If xmfGrid is a temporal collection, returns the child-grid matching the requested time.

◆ IsStructured()

bool vtkXdmfDomain::IsStructured ( xdmf2::XdmfGrid *  )

Returns true if the grids is a structured dataset.

◆ GetWholeExtent()

bool vtkXdmfDomain::GetWholeExtent ( xdmf2::XdmfGrid *  ,
int  extents[6] 
)

Returns the whole extents for the dataset if the grid if IsStructured() returns true for the given grid.

Returns true if the extents are valid. NOTE: returned extents are always (0, dimx-1, 0, dimy-1, 0, dimz-1).

◆ GetOriginAndSpacing()

bool vtkXdmfDomain::GetOriginAndSpacing ( xdmf2::XdmfGrid *  ,
double  origin[3],
double  spacing[3] 
)

Returns the spacing and origin for the grid if the grid topology == XDMF_2DCORECTMESH or XDMF_3DCORECTMESH i.e.

image data. Returns true if the extents are valid.

◆ GetVTKDataType() [2/2]

int vtkXdmfDomain::GetVTKDataType ( xdmf2::XdmfGrid *  xmfGrid)

◆ GetDataDimensionality()

static int vtkXdmfDomain::GetDataDimensionality ( xdmf2::XdmfGrid *  xmfGrid)
static

◆ GetPointArraySelection()

vtkXdmfArraySelection* vtkXdmfDomain::GetPointArraySelection ( )
inline

Definition at line 310 of file vtkXdmfReaderInternal.h.

◆ GetCellArraySelection()

vtkXdmfArraySelection* vtkXdmfDomain::GetCellArraySelection ( )
inline

Definition at line 311 of file vtkXdmfReaderInternal.h.

◆ GetGridSelection()

vtkXdmfArraySelection* vtkXdmfDomain::GetGridSelection ( )
inline

Definition at line 312 of file vtkXdmfReaderInternal.h.

◆ GetSetsSelection()

vtkXdmfArraySelection* vtkXdmfDomain::GetSetsSelection ( )
inline

Definition at line 313 of file vtkXdmfReaderInternal.h.


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