mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-09-16 17:22:55 +00:00
84bc723121
Originally, most of the sources used constructor parameters to set the various options of the source. Although convenient, it was difficult to keep track of what each parameter meant. To make the code more clear, source parameters are now set with accessor functions (e.g. `SetPointDimensions`). Although this makes code more verbose, it helps prevent mistakes and makes the changes more resilient to future changes.
85 lines
2.7 KiB
C++
85 lines
2.7 KiB
C++
//============================================================================
|
|
// Copyright (c) Kitware, Inc.
|
|
// All rights reserved.
|
|
// See LICENSE.txt for details.
|
|
//
|
|
// This software is distributed WITHOUT ANY WARRANTY; without even
|
|
// the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
|
|
// PURPOSE. See the above copyright notice for more information.
|
|
//============================================================================
|
|
#ifndef vtk_m_source_OscillatorSource_h
|
|
#define vtk_m_source_OscillatorSource_h
|
|
|
|
#include <vtkm/source/Source.h>
|
|
|
|
namespace vtkm
|
|
{
|
|
namespace source
|
|
{
|
|
|
|
/**\brief 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.
|
|
*/
|
|
class VTKM_SOURCE_EXPORT Oscillator final : public vtkm::source::Source
|
|
{
|
|
public:
|
|
VTKM_CONT Oscillator();
|
|
|
|
///Construct a Oscillator with Cell Dimensions
|
|
VTKM_CONT VTKM_DEPRECATED(
|
|
2.0,
|
|
"Use SetCellDimensions or SetPointDimensions.") explicit Oscillator(vtkm::Id3 dims);
|
|
|
|
// We can not declare default destructor here since compiler does not know how
|
|
// to create one for the Worklet at this point yet. However, the implementation
|
|
// in Oscillator.cxx does have ~Oscillator() = default;
|
|
VTKM_CONT ~Oscillator() override;
|
|
|
|
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);
|
|
|
|
private:
|
|
VTKM_CONT vtkm::cont::DataSet DoExecute() const override;
|
|
|
|
struct InternalStruct;
|
|
std::unique_ptr<InternalStruct> Internals;
|
|
};
|
|
}
|
|
}
|
|
|
|
#endif // vtk_m_source_OscillatorSource_h
|