vtkLiutex.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 vtkLiutex_h
#define vtkLiutex_h
 
#include "vtkFiltersFlowPathsModule.h" // For export macro
#include "vtkPassInputTypeAlgorithm.h"
 
#include <string> // For std::string
 
VTK_ABI_NAMESPACE_BEGIN
class vtkDataSet;
 
class VTKFILTERSFLOWPATHS_EXPORT vtkLiutex : public vtkPassInputTypeAlgorithm
{
public:
  static vtkLiutex* New();
  vtkTypeMacro(vtkLiutex, vtkPassInputTypeAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkSetMacro(ComputeLiutexVector, bool);
  vtkGetMacro(ComputeLiutexVector, bool);
  vtkBooleanMacro(ComputeLiutexVector, bool);


  vtkSetMacro(ComputeLiutexMagnitude, bool);
  vtkGetMacro(ComputeLiutexMagnitude, bool);
  vtkBooleanMacro(ComputeLiutexMagnitude, bool);


  vtkSetMacro(ComputeOmegaLiutex, bool);
  vtkGetMacro(ComputeOmegaLiutex, bool);
  vtkBooleanMacro(ComputeOmegaLiutex, bool);


  vtkSetMacro(LiutexVectorArrayName, std::string);
  vtkGetMacro(LiutexVectorArrayName, std::string);
  vtkSetMacro(LiutexMagnitudeArrayName, std::string);
  vtkGetMacro(LiutexMagnitudeArrayName, std::string);
  vtkSetMacro(OmegaLiutexArrayName, std::string);
  vtkGetMacro(OmegaLiutexArrayName, std::string);


  vtkSetClampMacro(OmegaLiutexB0, double, 0.0, VTK_DOUBLE_MAX);
  vtkGetMacro(OmegaLiutexB0, double);


  vtkSetMacro(OmegaLiutexEpsilon, double);
  vtkGetMacro(OmegaLiutexEpsilon, double);


  vtkSetMacro(FasterApproximation, bool);
  vtkGetMacro(FasterApproximation, bool);
  vtkBooleanMacro(FasterApproximation, bool);
 
protected:
  vtkLiutex();
  ~vtkLiutex() override;
 
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int FillInputPortInformation(int port, vtkInformation* info) override;
 
private:
  vtkLiutex(const vtkLiutex&) = delete;
  void operator=(const vtkLiutex&) = delete;
 
  struct BlockState;
  // Adds the requested arrays to dataSet, which shares its arrays with the input.
  bool ProcessDataSet(vtkDataSet* dataSet, BlockState& state, double& maxLambdaCi2);
 
  bool ComputeLiutexVector = true;
  bool ComputeLiutexMagnitude = true;
  bool ComputeOmegaLiutex = false;
  std::string LiutexVectorArrayName = "Liutex";
  std::string LiutexMagnitudeArrayName = "LiutexMagnitude";
  std::string OmegaLiutexArrayName = "OmegaLiutex";
  double OmegaLiutexB0 = 0.001;
  double OmegaLiutexEpsilon = -1.0;
  bool FasterApproximation = false;
};
 
VTK_ABI_NAMESPACE_END
#endif