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

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

#include <Oscillator.h>

Inheritance diagram for vtkm::source::Oscillator:
vtkm::source::Source

Public Member Functions

VTKM_CONT Oscillator ()
 
VTKM_CONT void SetPointDimensions (vtkm::Id3 pointDimensions)
 
VTKM_CONT vtkm::Id3 GetPointDimensions () const
 
VTKM_CONT void SetCellDimensions (vtkm::Id3 pointDimensions)
 
VTKM_CONT vtkm::Id3 GetCellDimensions () const
 
VTKM_CONT void SetTime (vtkm::FloatDefault time)
 
VTKM_CONT void AddPeriodic (vtkm::FloatDefault x, vtkm::FloatDefault y, vtkm::FloatDefault z, vtkm::FloatDefault radius, vtkm::FloatDefault omega, vtkm::FloatDefault zeta)
 
VTKM_CONT void AddDamped (vtkm::FloatDefault x, vtkm::FloatDefault y, vtkm::FloatDefault z, vtkm::FloatDefault radius, vtkm::FloatDefault omega, vtkm::FloatDefault zeta)
 
VTKM_CONT 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 VTKM_CONT ~Source ()=default
 
vtkm::cont::DataSet Execute () const
 

Private Member Functions

VTKM_CONT 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()

VTKM_CONT vtkm::source::Oscillator::Oscillator ( )

Member Function Documentation

◆ AddDamped()

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

◆ AddDecaying()

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

◆ AddPeriodic()

VTKM_CONT 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 vtkm::cont::DataSet vtkm::source::Oscillator::DoExecute ( ) const
overrideprivatevirtual

Implements vtkm::source::Source.

◆ GetCellDimensions()

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

◆ GetPointDimensions()

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

◆ SetCellDimensions()

VTKM_CONT void vtkm::source::Oscillator::SetCellDimensions ( vtkm::Id3  pointDimensions)

◆ SetPointDimensions()

VTKM_CONT void vtkm::source::Oscillator::SetPointDimensions ( vtkm::Id3  pointDimensions)

◆ SetTime()

VTKM_CONT 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: