Tpetra_RowMatrixTransposer_decl.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//          Tpetra: Templated Linear Algebra Services Package
//
// Copyright 2008 NTESS and the Tpetra contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef TPETRA_ROWMATRIXTRANSPOSER_DECL_HPP
#define TPETRA_ROWMATRIXTRANSPOSER_DECL_HPP


#include "Tpetra_RowMatrixTransposer_fwd.hpp"
#include "Tpetra_CrsMatrix_fwd.hpp"
#include "Tpetra_BlockCrsMatrix_fwd.hpp"
#include "Tpetra_Map_fwd.hpp"
#include "Teuchos_RCP.hpp"
#include <string>

#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Teuchos {
// Forward declaration of ParameterList
class ParameterList;
}  // namespace Teuchos
#endif  // DOXYGEN_SHOULD_SKIP_THIS

namespace Tpetra {

template <class Scalar,
          class LocalOrdinal,
          class GlobalOrdinal,
          class Node>
class RowMatrixTransposer {
 public:

  typedef Scalar scalar_type;
  typedef LocalOrdinal local_ordinal_type;
  typedef GlobalOrdinal global_ordinal_type;
  typedef Node node_type;

  typedef Map<LocalOrdinal, GlobalOrdinal, Node> map_type;
  typedef CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> crs_matrix_type;



  RowMatrixTransposer(const Teuchos::RCP<const crs_matrix_type> &origMatrix, const std::string &label = std::string());



  Teuchos::RCP<crs_matrix_type> createTranspose(const Teuchos::RCP<Teuchos::ParameterList> &params = Teuchos::null);

  Teuchos::RCP<crs_matrix_type> createTransposeLocal(const Teuchos::RCP<Teuchos::ParameterList> &params = Teuchos::null);

 private:
  Teuchos::RCP<const crs_matrix_type> origMatrix_;

  std::string label_;
};

template <class Scalar,
          class LocalOrdinal,
          class GlobalOrdinal,
          class Node>
class BlockCrsMatrixTransposer {
 public:

  typedef Scalar scalar_type;
  typedef LocalOrdinal local_ordinal_type;
  typedef GlobalOrdinal global_ordinal_type;
  typedef Node node_type;

  typedef Map<LocalOrdinal, GlobalOrdinal, Node> map_type;
  typedef BlockCrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> bcrs_matrix_type;



  BlockCrsMatrixTransposer(const Teuchos::RCP<const bcrs_matrix_type> &origMatrix, const std::string &label = std::string());



  Teuchos::RCP<bcrs_matrix_type> createTranspose(const Teuchos::RCP<Teuchos::ParameterList> &params = Teuchos::null);

  Teuchos::RCP<bcrs_matrix_type> createTransposeLocal(const Teuchos::RCP<Teuchos::ParameterList> &params = Teuchos::null);

 private:
  Teuchos::RCP<const bcrs_matrix_type> origMatrix_;

  std::string label_;
};

}  // namespace Tpetra

#endif /* TPETRA_ROWMATRIXTRANSPOSER_DECL_HPP */