viskores::source::Oscillator Class Reference

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

#include <Oscillator.h>

Inheritance diagram for viskores::source::Oscillator:

Public Member Functions
	Oscillator ()
	Oscillator (viskores::Id3 dims)
	Construct a Oscillator with Cell Dimensions. More...
	~Oscillator () override
void	SetPointDimensions (viskores::Id3 pointDimensions)
viskores::Id3	GetPointDimensions () const
void	SetCellDimensions (viskores::Id3 pointDimensions)
viskores::Id3	GetCellDimensions () const
void	SetTime (viskores::FloatDefault time)
void	AddPeriodic (viskores::FloatDefault x, viskores::FloatDefault y, viskores::FloatDefault z, viskores::FloatDefault radius, viskores::FloatDefault omega, viskores::FloatDefault zeta)
void	AddDamped (viskores::FloatDefault x, viskores::FloatDefault y, viskores::FloatDefault z, viskores::FloatDefault radius, viskores::FloatDefault omega, viskores::FloatDefault zeta)
void	AddDecaying (viskores::FloatDefault x, viskores::FloatDefault y, viskores::FloatDefault z, viskores::FloatDefault radius, viskores::FloatDefault omega, viskores::FloatDefault zeta)
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
std::unique_ptr< InternalStruct >	Internals

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

viskores::source::Oscillator::Oscillator

(

)

Oscillator() [2/2]

viskores::source::Oscillator::Oscillator ( viskores::Id3  dims )

explicit

Construct a Oscillator with Cell Dimensions.

~Oscillator()

viskores::source::Oscillator::~Oscillator ( )

override

Member Function Documentation

AddDamped()

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

AddDecaying()

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

AddPeriodic()

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

DoExecute()

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

overrideprivatevirtual

Implements viskores::source::Source.

GetCellDimensions()

viskores::Id3 viskores::source::Oscillator::GetCellDimensions

(

)

const

GetPointDimensions()

viskores::Id3 viskores::source::Oscillator::GetPointDimensions

(

)

const

SetCellDimensions()

void viskores::source::Oscillator::SetCellDimensions

(

viskores::Id3

pointDimensions

)

SetPointDimensions()

void viskores::source::Oscillator::SetPointDimensions

(

viskores::Id3

pointDimensions

)

SetTime()

void viskores::source::Oscillator::SetTime

(

viskores::FloatDefault

time

)

Member Data Documentation

Internals

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

private

---

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

• Oscillator.h