VTK-m  2.0
Public Member Functions | Private Member Functions | Private Attributes | List of all members
vtkm::source::Tangle Class Referencefinal

The Tangle source creates a uniform dataset. More...

#include <Tangle.h>

Inheritance diagram for vtkm::source::Tangle:

Public Member Functions

VTKM_CONT Tangle ()=default
VTKM_CONT ~Tangle ()=default
VTKM_CONT Tangle (vtkm::Id3 dims)
VTKM_CONT vtkm::Id3 GetPointDimensions () const
VTKM_CONT void SetPointDimensions (vtkm::Id3 dims)
VTKM_CONT vtkm::Id3 GetCellDimensions () const
VTKM_CONT void SetCellDimensions (vtkm::Id3 dims)
- Public Member Functions inherited from vtkm::source::Source
virtual VTKM_CONT ~Source ()=default
vtkm::cont::DataSet Execute () const

Private Member Functions

vtkm::cont::DataSet DoExecute () const override

Private Attributes

vtkm::Id3 PointDimensions = { 16, 16, 16 }

Additional Inherited Members

- Protected Attributes inherited from vtkm::source::Source
vtkm::cont::Invoker Invoke

Detailed Description

The Tangle source creates a uniform dataset.

This class generates a predictable uniform grid dataset with an interesting point field, which is useful for testing and benchmarking.

The Execute method creates a complete structured dataset of a resolution specified in the constructor that is bounded by the cube in the range [0,1] in each dimension. The dataset has a point field named 'tangle' computed with the following formula

x^4 - 5x^2 + y^4 - 5y^2 + z^4 - 5z^2

Constructor & Destructor Documentation

◆ Tangle() [1/2]

VTKM_CONT vtkm::source::Tangle::Tangle ( )

◆ ~Tangle()

VTKM_CONT vtkm::source::Tangle::~Tangle ( )

◆ Tangle() [2/2]

VTKM_CONT vtkm::source::Tangle::Tangle ( vtkm::Id3  dims)

Member Function Documentation

◆ DoExecute()

vtkm::cont::DataSet vtkm::source::Tangle::DoExecute ( ) const

Implements vtkm::source::Source.

◆ GetCellDimensions()

VTKM_CONT vtkm::Id3 vtkm::source::Tangle::GetCellDimensions ( ) const

◆ GetPointDimensions()

VTKM_CONT vtkm::Id3 vtkm::source::Tangle::GetPointDimensions ( ) const

◆ SetCellDimensions()

VTKM_CONT void vtkm::source::Tangle::SetCellDimensions ( vtkm::Id3  dims)

◆ SetPointDimensions()

VTKM_CONT void vtkm::source::Tangle::SetPointDimensions ( vtkm::Id3  dims)

Member Data Documentation

◆ PointDimensions

vtkm::Id3 vtkm::source::Tangle::PointDimensions = { 16, 16, 16 }

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