vtkGradientFilter.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
// SPDX-License-Identifier: BSD-3-Clause

 
#ifndef vtkGradientFilter_h
#define vtkGradientFilter_h
 
#include "vtkDataSetAlgorithm.h"
#include "vtkFiltersGeneralModule.h" // For export macro
 
VTK_ABI_NAMESPACE_BEGIN
class vtkUnsignedCharArray;
 
class VTKFILTERSGENERAL_EXPORT vtkGradientFilter : public vtkDataSetAlgorithm
{
public:

  static vtkGradientFilter* New();
  vtkTypeMacro(vtkGradientFilter, vtkDataSetAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  enum ContributingCellEnum
  {
    All = 0,   
    Patch = 1, 
    DataSetMax = 2 
  };

  enum ReplacementValueEnum
  {
    Zero = 0,        
    NaN = 1,         
    DataTypeMin = 2, 
    DataTypeMax = 3  
  };


  virtual void SetInputScalars(int fieldAssociation, const char* name);
  virtual void SetInputScalars(int fieldAssociation, int fieldAttributeType);


  vtkGetStringMacro(ResultArrayName);
  vtkSetStringMacro(ResultArrayName);


  vtkGetStringMacro(DivergenceArrayName);
  vtkSetStringMacro(DivergenceArrayName);


  vtkGetStringMacro(VorticityArrayName);
  vtkSetStringMacro(VorticityArrayName);


  vtkGetStringMacro(QCriterionArrayName);
  vtkSetStringMacro(QCriterionArrayName);


  vtkGetStringMacro(Lambda2ArrayName);
  vtkSetStringMacro(Lambda2ArrayName);


  vtkGetMacro(FasterApproximation, vtkTypeBool);
  vtkSetMacro(FasterApproximation, vtkTypeBool);
  vtkBooleanMacro(FasterApproximation, vtkTypeBool);


  vtkSetMacro(ComputeGradient, vtkTypeBool);
  vtkGetMacro(ComputeGradient, vtkTypeBool);
  vtkBooleanMacro(ComputeGradient, vtkTypeBool);


  vtkSetMacro(ComputeDivergence, vtkTypeBool);
  vtkGetMacro(ComputeDivergence, vtkTypeBool);
  vtkBooleanMacro(ComputeDivergence, vtkTypeBool);


  vtkSetMacro(ComputeVorticity, vtkTypeBool);
  vtkGetMacro(ComputeVorticity, vtkTypeBool);
  vtkBooleanMacro(ComputeVorticity, vtkTypeBool);


  vtkSetMacro(ComputeQCriterion, vtkTypeBool);
  vtkGetMacro(ComputeQCriterion, vtkTypeBool);
  vtkBooleanMacro(ComputeQCriterion, vtkTypeBool);


  vtkSetMacro(ComputeLambda2, vtkTypeBool);
  vtkGetMacro(ComputeLambda2, vtkTypeBool);
  vtkBooleanMacro(ComputeLambda2, vtkTypeBool);


  vtkSetClampMacro(ContributingCellOption, int, 0, 2);
  vtkGetMacro(ContributingCellOption, int);


  vtkSetClampMacro(ReplacementValueOption, int, 0, 3);
  vtkGetMacro(ReplacementValueOption, int);
 
protected:
  vtkGradientFilter();
  ~vtkGradientFilter() override;
 
  int RequestUpdateExtent(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;

  virtual int ComputeUnstructuredGridGradient(vtkDataArray* Array, int fieldAssociation,
    vtkDataSet* input, bool computeVorticity, bool computeQCriterion, bool computeDivergence,
    vtkDataSet* output);

  virtual int ComputeRegularGridGradient(vtkDataArray* Array, int* dims, int fieldAssociation,
    bool computeVorticity, bool computeQCriterion, bool computeDivergence, vtkDataSet* output,
    vtkUnsignedCharArray* ghosts, unsigned char hiddenGhost);

  int GetOutputArrayType(vtkDataArray* inputArray);

  char* ResultArrayName;

  char* DivergenceArrayName;

  char* VorticityArrayName;

  char* QCriterionArrayName;

  char* Lambda2ArrayName = nullptr;

  vtkTypeBool FasterApproximation;

  vtkTypeBool ComputeGradient;

  vtkTypeBool ComputeDivergence;

  vtkTypeBool ComputeQCriterion;

  vtkTypeBool ComputeLambda2 = 0;

  vtkTypeBool ComputeVorticity;

  int ContributingCellOption;

  int ReplacementValueOption;
 
private:
  vtkGradientFilter(const vtkGradientFilter&) = delete;
  void operator=(const vtkGradientFilter&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif //_vtkGradientFilter_h