vtkm::source::Oscillator Class Reference

An analytical, time-varying uniform dataset with a point based array. More...

#include <Oscillator.h>

Inheritance diagram for vtkm::source::Oscillator:

Public Member Functions
	Oscillator ()
	Oscillator (vtkm::Id3 dims)
	Construct a Oscillator with Cell Dimensions. More...
	~Oscillator () override
void	SetPointDimensions (vtkm::Id3 pointDimensions)
vtkm::Id3	GetPointDimensions () const
void	SetCellDimensions (vtkm::Id3 pointDimensions)
vtkm::Id3	GetCellDimensions () const
void	SetTime (vtkm::FloatDefault time)
void	AddPeriodic (vtkm::FloatDefault x, vtkm::FloatDefault y, vtkm::FloatDefault z, vtkm::FloatDefault radius, vtkm::FloatDefault omega, vtkm::FloatDefault zeta)
void	AddDamped (vtkm::FloatDefault x, vtkm::FloatDefault y, vtkm::FloatDefault z, vtkm::FloatDefault radius, vtkm::FloatDefault omega, vtkm::FloatDefault zeta)
void	AddDecaying (vtkm::FloatDefault x, vtkm::FloatDefault y, vtkm::FloatDefault z, vtkm::FloatDefault radius, vtkm::FloatDefault omega, vtkm::FloatDefault zeta)
Public Member Functions inherited from vtkm::source::Source
virtual	~Source ()=default
vtkm::cont::DataSet	Execute () const

Private Member Functions
vtkm::cont::DataSet	DoExecute () const override

Private Attributes
std::unique_ptr< InternalStruct >	Internals

Additional Inherited Members
Protected Attributes inherited from vtkm::source::Source
vtkm::cont::Invoker	Invoke

Detailed Description

An analytical, time-varying uniform dataset with a point based array.

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

This array is based on the coordinates and evaluates to a sum of time-varying Gaussian exponentials specified in its configuration.

Constructor & Destructor Documentation

Oscillator() [1/2]

vtkm::source::Oscillator::Oscillator

(

)

Oscillator() [2/2]

vtkm::source::Oscillator::Oscillator ( vtkm::Id3  dims )

explicit

Construct a Oscillator with Cell Dimensions.

~Oscillator()

vtkm::source::Oscillator::~Oscillator ( )

override

Member Function Documentation

AddDamped()

void vtkm::source::Oscillator::AddDamped	(	vtkm::FloatDefault	x,
		vtkm::FloatDefault	y,
		vtkm::FloatDefault	z,
		vtkm::FloatDefault	radius,
		vtkm::FloatDefault	omega,
		vtkm::FloatDefault	zeta
	)

AddDecaying()

void vtkm::source::Oscillator::AddDecaying	(	vtkm::FloatDefault	x,
		vtkm::FloatDefault	y,
		vtkm::FloatDefault	z,
		vtkm::FloatDefault	radius,
		vtkm::FloatDefault	omega,
		vtkm::FloatDefault	zeta
	)

AddPeriodic()

void vtkm::source::Oscillator::AddPeriodic	(	vtkm::FloatDefault	x,
		vtkm::FloatDefault	y,
		vtkm::FloatDefault	z,
		vtkm::FloatDefault	radius,
		vtkm::FloatDefault	omega,
		vtkm::FloatDefault	zeta
	)

DoExecute()

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

overrideprivatevirtual

Implements vtkm::source::Source.

GetCellDimensions()

vtkm::Id3 vtkm::source::Oscillator::GetCellDimensions

(

)

const

GetPointDimensions()

vtkm::Id3 vtkm::source::Oscillator::GetPointDimensions

(

)

const

SetCellDimensions()

void vtkm::source::Oscillator::SetCellDimensions

(

vtkm::Id3

pointDimensions

)

SetPointDimensions()

void vtkm::source::Oscillator::SetPointDimensions

(

vtkm::Id3

pointDimensions

)

SetTime()

void vtkm::source::Oscillator::SetTime

(

vtkm::FloatDefault

time

)

Member Data Documentation

Internals

std::unique_ptr<InternalStruct> vtkm::source::Oscillator::Internals

private

---

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

• Oscillator.h