vtkTensorPrincipalInvariants.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkTensorPrincipalInvariants_h
#define vtkTensorPrincipalInvariants_h
 
#include "vtkDataSetAlgorithm.h"
#include "vtkFiltersTensorModule.h" // For export macro
#include "vtkNew.h"                 // For vtkNew
 
#include <array>  // for std::array
#include <string> // for std::string
 
VTK_ABI_NAMESPACE_BEGIN
class vtkDataArray;
class vtkDataArraySelection;
class vtkDataSet;
 
class VTKFILTERSTENSOR_EXPORT vtkTensorPrincipalInvariants : public vtkDataSetAlgorithm
{
public:
  static vtkTensorPrincipalInvariants* New();
  vtkTypeMacro(vtkTensorPrincipalInvariants, vtkDataSetAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkGetMacro(ScaleVectors, bool);
  vtkSetMacro(ScaleVectors, bool);

  vtkGetObjectMacro(PointDataArraySelection, vtkDataArraySelection);

  vtkGetObjectMacro(CellDataArraySelection, vtkDataArraySelection);

  static std::string GetSigmaValueArrayName(const std::string& baseName, int index);

  static std::string GetSigmaVectorArrayName(const std::string& baseName, int index);
 
protected:
  vtkTensorPrincipalInvariants();
  ~vtkTensorPrincipalInvariants() override = default;

  bool IsSymmetricTensor(vtkDataArray* array) const;

  bool ComputePrincipalInvariants(vtkDataSet* output, vtkDataArray* array,
    const std::string& arrayName, vtkIdType nbTuples, bool isPointData) const;

  std::array<int, 3> GetDecreasingOrder(double values[3]) const;
 
  int RequestInformation(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
  vtkNew<vtkDataArraySelection> PointDataArraySelection;
  vtkNew<vtkDataArraySelection> CellDataArraySelection;
  bool ScaleVectors = false;
 
private:
  vtkTensorPrincipalInvariants(const vtkTensorPrincipalInvariants&) = delete;
  void operator=(const vtkTensorPrincipalInvariants&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif