Viskores  1.0
Public Member Functions | Private Member Functions | Private Attributes | List of all members
viskores::source::Tangle Class Referencefinal

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

#include <Tangle.h>

Inheritance diagram for viskores::source::Tangle:
viskores::source::Source

Public Member Functions

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

Private Member Functions

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

Private Attributes

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

Additional Inherited Members

- Protected Attributes inherited from viskores::source::Source
viskores::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]

viskores::source::Tangle::Tangle ( )
default

◆ ~Tangle()

viskores::source::Tangle::~Tangle ( )
default

◆ Tangle() [2/2]

viskores::source::Tangle::Tangle ( viskores::Id3  dims)
inline

Member Function Documentation

◆ DoExecute()

viskores::cont::DataSet viskores::source::Tangle::DoExecute ( ) const
overrideprivatevirtual

◆ GetCellDimensions()

viskores::Id3 viskores::source::Tangle::GetCellDimensions ( ) const
inline

◆ GetPointDimensions()

viskores::Id3 viskores::source::Tangle::GetPointDimensions ( ) const
inline

◆ SetCellDimensions()

void viskores::source::Tangle::SetCellDimensions ( viskores::Id3  dims)
inline

◆ SetPointDimensions()

void viskores::source::Tangle::SetPointDimensions ( viskores::Id3  dims)
inline

Member Data Documentation

◆ PointDimensions

viskores::Id3 viskores::source::Tangle::PointDimensions = { 16, 16, 16 }
private

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