vtkm::source::Amr Class Reference

The Amr source creates a dataset similar to VTK's vtkRTAnalyticSource. More...

#include <Amr.h>

Public Member Functions
	Amr ()=default
	Amr (vtkm::IdComponent dimension, vtkm::IdComponent cellsPerDimension=6, vtkm::IdComponent numberOfLevels=4)
	~Amr ()=default
void	SetDimension (vtkm::IdComponent dimension)
vtkm::IdComponent	GetDimension () const
void	SetCellsPerDimension (vtkm::IdComponent cellsPerDimension)
vtkm::IdComponent	GetCellsPerDimension () const
void	SetNumberOfLevels (vtkm::IdComponent numberOfLevels)
vtkm::IdComponent	GetNumberOfLevels () const
vtkm::cont::PartitionedDataSet	Execute () const

Private Member Functions
template<vtkm::IdComponent Dim>
vtkm::cont::DataSet	GenerateDataSet (unsigned int level, unsigned int amrIndex) const

Private Attributes
vtkm::IdComponent	Dimension = 2
vtkm::IdComponent	CellsPerDimension = 6
vtkm::IdComponent	NumberOfLevels = 4

Detailed Description

The Amr source creates a dataset similar to VTK's vtkRTAnalyticSource.

This class generates a predictable structured dataset with a smooth yet interesting set of scalars, which is useful for testing and benchmarking.

The Execute method creates a complete structured dataset that have a point field names 'scalars'

The scalars are computed as:

MaxVal * Gauss + MagX * sin(FrqX*x) + MagY * sin(FrqY*y) + MagZ * cos(FrqZ*z)

The dataset properties are determined by:

• Minimum/MaximumExtent: The logical point extents of the dataset.
• Spacing: The distance between points of the dataset.
• Center: The center of the dataset.

The scalar functions is control via:

• Center: The center of a Gaussian contribution to the scalars.
• StandardDeviation: The unscaled width of a Gaussian contribution.
• MaximumValue: Upper limit of the scalar range.
• Frequency: The Frq[XYZ] parameters of the periodic contributions.
• Magnitude: The Mag[XYZ] parameters of the periodic contributions.

By default, the following parameters are used:

• Extents: { -10, -10, -10 } --> { 10, 10, 10 }
• Spacing: { 1, 1, 1 }
• Center: { 0, 0, 0 }
• StandardDeviation: 0.5
• MaximumValue: 255
• Frequency: { 60, 30, 40 }
• Magnitude: { 10, 18, 5 }

Constructor & Destructor Documentation

Amr() [1/2]

vtkm::source::Amr::Amr ( )

default

Amr() [2/2]

vtkm::source::Amr::Amr	(	vtkm::IdComponent	dimension,
		vtkm::IdComponent	cellsPerDimension = 6,
		vtkm::IdComponent	numberOfLevels = 4
	)

~Amr()

vtkm::source::Amr::~Amr ( )

default

Member Function Documentation

Execute()

vtkm::cont::PartitionedDataSet vtkm::source::Amr::Execute

(

)

const

GenerateDataSet()

template<vtkm::IdComponent Dim>

vtkm::cont::DataSet vtkm::source::Amr::GenerateDataSet ( unsigned int  level, unsigned int  amrIndex  ) const

private

GetCellsPerDimension()

vtkm::IdComponent vtkm::source::Amr::GetCellsPerDimension ( ) const

inline

GetDimension()

vtkm::IdComponent vtkm::source::Amr::GetDimension ( ) const

inline

GetNumberOfLevels()

vtkm::IdComponent vtkm::source::Amr::GetNumberOfLevels ( ) const

inline

SetCellsPerDimension()

void vtkm::source::Amr::SetCellsPerDimension ( vtkm::IdComponent  cellsPerDimension )

inline

SetDimension()

void vtkm::source::Amr::SetDimension ( vtkm::IdComponent  dimension )

inline

SetNumberOfLevels()

void vtkm::source::Amr::SetNumberOfLevels ( vtkm::IdComponent  numberOfLevels )

inline

Member Data Documentation

CellsPerDimension

vtkm::IdComponent vtkm::source::Amr::CellsPerDimension = 6

private

Dimension

vtkm::IdComponent vtkm::source::Amr::Dimension = 2

private

NumberOfLevels

vtkm::IdComponent vtkm::source::Amr::NumberOfLevels = 4

private

---

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

• Amr.h