vtkDiagonalMatrixSource.h

Go to the documentation of this file.

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

#ifndef vtkDiagonalMatrixSource_h
#define vtkDiagonalMatrixSource_h

#include "vtkArrayDataAlgorithm.h"
#include "vtkFiltersSourcesModule.h" // For export macro
#include "vtkWrappingHints.h"        // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkArray;

class VTKFILTERSSOURCES_EXPORT VTK_MARSHALAUTO vtkDiagonalMatrixSource
  : public vtkArrayDataAlgorithm
{
public:
  static vtkDiagonalMatrixSource* New();
  vtkTypeMacro(vtkDiagonalMatrixSource, vtkArrayDataAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  // Determines whether the output matrix will be dense or sparse
  enum StorageType
  {
    DENSE,
    SPARSE
  };

  vtkGetMacro(ArrayType, int);
  vtkSetMacro(ArrayType, int);


  vtkGetMacro(Extents, vtkIdType);
  vtkSetMacro(Extents, vtkIdType);


  vtkGetMacro(Diagonal, double);
  vtkSetMacro(Diagonal, double);


  vtkGetMacro(SuperDiagonal, double);
  vtkSetMacro(SuperDiagonal, double);


  vtkGetMacro(SubDiagonal, double);
  vtkSetMacro(SubDiagonal, double);


  vtkGetStringMacro(RowLabel);
  vtkSetStringMacro(RowLabel);


  vtkGetStringMacro(ColumnLabel);
  vtkSetStringMacro(ColumnLabel);

protected:
  vtkDiagonalMatrixSource();
  ~vtkDiagonalMatrixSource() override;

  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;

private:
  vtkDiagonalMatrixSource(const vtkDiagonalMatrixSource&) = delete;
  void operator=(const vtkDiagonalMatrixSource&) = delete;

  vtkArray* GenerateDenseArray();
  vtkArray* GenerateSparseArray();

  int ArrayType;
  vtkIdType Extents;
  double Diagonal;
  double SuperDiagonal;
  double SubDiagonal;
  char* RowLabel;
  char* ColumnLabel;
};

VTK_ABI_NAMESPACE_END
#endif