paraview.simple.HyperTreeGrid

paraview.simple.HyperTreeGrid(*input, **params)

This source uses input parameters,

most notably a string descriptor, to generate a vtkHyperTreeGrid instance representing the corresponding a tree-based AMR grid with arbitrary rectilinear geometry and either binary or ternary subdivision.

Data Descriptors

BranchFactor

This property specifies the subdivision scheme (binary or ternary) of the hyper tree grid.

Descriptor

This property specifies the string used to describe the hyper tree grid. Use ‘.’ for leaves, ‘R’ for coarse cells, and ‘’ to separate refinement levels. Prefix root-level trees with digits in distributed server mode to select the rank where they should show up. The number of cells must match the dimension and branch factor specified above. For instance, for dimensions [3,4,1], maximum depth of 2 and branch factor of 2, you can use the string ‘….R…..’ to define a tree with a single top-level refined cell. To distribute this HTG across 2 server processes, you can use the string ‘1…0.R…..’. The first 3 Hyper Trees will be located on MPI rank 1, and the other 3 on the rank 0.

Dimensions

The three values in this property specify the number of points in each dimension of the hyper tree grid.

GridScale

The three values in this property specify the scale of the root cells in each dimension of the hyper tree grid.

Mask

This property specifies the string used to describe the mask of the hyper tree grid. Use ‘0’ for masked cells, ‘1’ for unmasked ones, and ‘’ to separate refinement levels. The number of cells in the mask must match exactly the number of cells in the descriptor for each level. Refined cells ‘R’ cannot be masked. Using the descriptor from the Descriptor property example, we could use the mask string ‘0101111110’ to mask 2 top-level cells and 1 cell on the next refinement level.

MaxDepth

The value of this property specifies the maximum number of levels in the hyper tree grid. Cells specified as refined ‘R’ in the descriptor will be considered leaves if they are at the maximum depth.

UseMask

Set whether the tree mask should be used.

Data Descriptors inherited from Proxy

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

Methods

Initialize = aInitialize(self, connection=None, update=True)

Methods inherited from SourceProxy

FileNameChanged(self)

Called when the filename of a source proxy is changed.

GetCellDataInformation(self)

Returns the associated cell data information.

GetDataInformation(self, idx=None)

This method returns a DataInformation wrapper around a vtkPVDataInformation

GetFieldDataInformation(self)

Returns the associated cell data information.

GetPointDataInformation(self)

Returns the associated point data information.

UpdatePipeline(self, time=None)

This method updates the server-side VTK pipeline and the associated data information. Make sure to update a source to validate the output meta-data.

UpdatePipelineInformation(self)

This method updates the meta-data of the server-side VTK pipeline and the associated information properties

__getitem__(self, idx)

Given a slice, int or string, returns the corresponding output port

Methods inherited from Proxy

GetProperty(self, name)

Given a property name, returns the property object.

GetPropertyValue(self, name)

Returns a scalar for properties with 1 elements, the property itself for vectors.

InitializeFromProxy(self, aProxy, update=True)

Constructor. Assigns proxy to self.SMProxy, updates the server object as well as register the proxy in _pyproxies dictionary.

ListProperties(self)

Returns a list of all property names on this proxy.

SetPropertyWithName(self, pname, arg)

Generic method for setting the value of a property.

__del__(self)

Destructor. Cleans up all observers as well as remove the proxy from the _pyproxies dictionary

__eq__(self, other)

Returns true if the underlying SMProxies are the same.

__getattr__(self, name)

With the exception of a few overloaded methods, returns the SMProxy method

__hash__(self)

Return hash(self).

__init__(self, **args)

Default constructor. It can be used to initialize properties by passing keyword arguments where the key is the name of the property. In addition registrationGroup and registrationName (optional) can be specified (as keyword arguments) to automatically register the proxy with the proxy manager.

__iter__(self)

Creates an iterator for the properties.

__ne__(self, other)

Returns false if the underlying SMProxies are the same.

__setattr__(self, name, value)

Implement setattr(self, name, value).

add_attribute(self, name, value)

For the full list of servermanager proxies, please refer to Available readers, sources, writers, filters and animation cues