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.
62 lines
1.9 KiB
C++
62 lines
1.9 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_Tangle_h
|
|
#define vtk_m_source_Tangle_h
|
|
|
|
#include <vtkm/source/Source.h>
|
|
|
|
namespace vtkm
|
|
{
|
|
namespace source
|
|
{
|
|
/**
|
|
* @brief The Tangle source creates a uniform dataset.
|
|
*
|
|
* This class generates a predictable uniform grid dataset with an
|
|
* interesting point field, which is useful for testing and
|
|
* benchmarking.
|
|
*
|
|
* The Execute method creates a complete structured dataset of a
|
|
* resolution specified in the constructor that is bounded by the
|
|
* cube in the range [0,1] in each dimension. The dataset has a
|
|
* point field named 'tangle' computed with the following formula
|
|
*
|
|
* x^4 - 5x^2 + y^4 - 5y^2 + z^4 - 5z^2
|
|
*
|
|
**/
|
|
class VTKM_SOURCE_EXPORT Tangle final : public vtkm::source::Source
|
|
{
|
|
public:
|
|
VTKM_CONT Tangle() = default;
|
|
VTKM_CONT ~Tangle() = default;
|
|
|
|
VTKM_DEPRECATED(2.0, "Use SetCellDimensions or SetPointDimensions.")
|
|
VTKM_CONT Tangle(vtkm::Id3 dims)
|
|
: PointDimensions(dims + vtkm::Id3(1))
|
|
{
|
|
}
|
|
|
|
VTKM_CONT vtkm::Id3 GetPointDimensions() const { return this->PointDimensions; }
|
|
VTKM_CONT void SetPointDimensions(vtkm::Id3 dims) { this->PointDimensions = dims; }
|
|
|
|
VTKM_CONT vtkm::Id3 GetCellDimensions() const { return this->PointDimensions - vtkm::Id3(1); }
|
|
VTKM_CONT void SetCellDimensions(vtkm::Id3 dims) { this->PointDimensions = dims + vtkm::Id3(1); }
|
|
|
|
private:
|
|
vtkm::cont::DataSet DoExecute() const override;
|
|
|
|
vtkm::Id3 PointDimensions = { 16, 16, 16 };
|
|
};
|
|
} //namespace source
|
|
} //namespace vtkm
|
|
|
|
#endif //vtk_m_source_Tangle_h
|