Ifpack2_TriDiContainer_decl.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//       Ifpack2: Templated Object-Oriented Algebraic Preconditioner Package
//
// Copyright 2009 NTESS and the Ifpack2 contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER
#ifndef IFPACK2_TRIDICONTAINER_DECL_HPP
#define IFPACK2_TRIDICONTAINER_DECL_HPP


#include "Ifpack2_Container.hpp"
#include "Tpetra_MultiVector.hpp"
#include "Tpetra_Map.hpp"
#include "Tpetra_RowMatrix.hpp"
#include "Teuchos_SerialDenseVector.hpp"
#include "Teuchos_SerialTriDiMatrix.hpp"
#include <type_traits>
#include <string>

namespace Ifpack2 {


template <class MatrixType, class LocalScalarType>
class TriDiContainer
  : public ContainerImpl<MatrixType, LocalScalarType> {

 private:
  using matrix_type = MatrixType;

  using typename Container<MatrixType>::SC;
  using typename Container<MatrixType>::LO;
  using typename Container<MatrixType>::GO;
  using typename Container<MatrixType>::NO;
  using LSC = LocalScalarType;

  using typename Container<MatrixType>::mv_type;
  using typename Container<MatrixType>::map_type;
  using typename Container<MatrixType>::vector_type;
  using typename Container<MatrixType>::import_type;

  using typename Container<MatrixType>::ISC;
  using typename ContainerImpl<MatrixType, LocalScalarType>::LISC;
  using typename Container<MatrixType>::HostView;
  using local_mv_type = Tpetra::MultiVector<LSC, LO, GO, NO>;
  using HostViewLocal = typename Kokkos::View<LSC**, Kokkos::HostSpace>;
  using typename ContainerImpl<MatrixType, LocalScalarType>::HostSubviewLocal;
  using typename ContainerImpl<MatrixType, LocalScalarType>::ConstHostSubviewLocal;
  using typename ContainerImpl<MatrixType, LocalScalarType>::block_crs_matrix_type;
  static_assert(std::is_same<MatrixType, Tpetra::RowMatrix<SC, LO, GO, NO>>::value,
                "Ifpack2::TriDiContainer: MatrixType must be a Tpetra::RowMatrix specialization.");

  using typename Container<MatrixType>::row_matrix_type;
 public:


  TriDiContainer(const Teuchos::RCP<const row_matrix_type>& matrix,
                 const Teuchos::Array<Teuchos::Array<LO>>& partitions,
                 const Teuchos::RCP<const import_type>& importer,
                 bool pointIndexed);

  TriDiContainer(const TriDiContainer<MatrixType, LocalScalarType>& rhs) = delete;

  virtual ~TriDiContainer();





  virtual void initialize();

  virtual void compute();

  void clearBlocks();

  void solveBlock(ConstHostSubviewLocal X,
                  HostSubviewLocal Y,
                  int blockIndex,
                  Teuchos::ETransp mode,
                  LSC alpha,
                  LSC beta) const;



  virtual std::ostream& print(std::ostream& os) const;



  virtual std::string description() const;

  virtual void
  describe(Teuchos::FancyOStream& out,
           const Teuchos::EVerbosityLevel verbLevel =
               Teuchos::Describable::verbLevel_default) const;


  static std::string getName();

 private:
  void extract();

  void factor();

  std::vector<Teuchos::SerialTriDiMatrix<int, LSC>> diagBlocks_;

  mutable Teuchos::Array<int> ipiv_;

  Teuchos::Array<LSC> scalars_;

  Teuchos::Array<int> scalarOffsets_;
};

}  // namespace Ifpack2

#endif  // IFPACK2_TRIDICONTAINER_DECL_HPP