Tpetra::RowMatrixTransposer< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

Construct and (optionally) redistribute the explicitly stored transpose of a CrsMatrix. More...

#include <Tpetra_RowMatrixTransposer_decl.hpp>

Public Member Functions
Constructors
	RowMatrixTransposer (const Teuchos::RCP< const crs_matrix_type > &origMatrix, const std::string &label=std::string())
	Constructor that takes the matrix to transpose.

Methods for computing the explicit transpose.
Teuchos::RCP< crs_matrix_type >	createTranspose (const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null)
	Compute and return the transpose of the matrix given to the constructor.
Teuchos::RCP< crs_matrix_type >	createTransposeLocal (const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null)
	Compute and return the transpose of the matrix given to the constructor.

Detailed Description

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
class Tpetra::RowMatrixTransposer< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Construct and (optionally) redistribute the explicitly stored transpose of a CrsMatrix.

This class is based on the EpetraExt version. It first transposes the matrix to an intermediate version with overlapping row map. That matrix is then converted to a final version whose row map is "unique", i.e., a row is wholly owned by one process.

This class takes the same template parameters as CrsMatrix.

Definition at line 48 of file Tpetra_RowMatrixTransposer_decl.hpp.

Constructor & Destructor Documentation

RowMatrixTransposer()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

Tpetra::RowMatrixTransposer< Scalar, LocalOrdinal, GlobalOrdinal, Node >::RowMatrixTransposer	(	const Teuchos::RCP< const crs_matrix_type > &	origMatrix,
		const std::string &	label = std::string()
	)

Constructor that takes the matrix to transpose.

Definition at line 29 of file Tpetra_RowMatrixTransposer_def.hpp.

Member Function Documentation

createTranspose()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

Teuchos::RCP< CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Tpetra::RowMatrixTransposer< Scalar, LocalOrdinal, GlobalOrdinal, Node >::createTranspose

(

const Teuchos::RCP< Teuchos::ParameterList > &

params = Teuchos::null

)

Compute and return the transpose of the matrix given to the constructor.

Parameters

params

[in] Optional list of parameters. "compute global constants" (bool, default "true") determines if the the resulting matrix will have global constants. "conjugate values" (bool) determines if the values of the transposed matrix should also be complex conjugated. For complex matrices the default behavior is to conjugate the values.

Definition at line 39 of file Tpetra_RowMatrixTransposer_def.hpp.

createTransposeLocal()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

Teuchos::RCP< CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Tpetra::RowMatrixTransposer< Scalar, LocalOrdinal, GlobalOrdinal, Node >::createTransposeLocal

(

const Teuchos::RCP< Teuchos::ParameterList > &

params = Teuchos::null

)

Compute and return the transpose of the matrix given to the constructor.

In this call, we (potentially) leave the matrix with an overlapping row Map. This is a perfectly valid matrix, but won't work correctly with some routines in Ifpack or Muelu.

Warning

This routine leaves overlapping rows. Unless you're sure that's OK, call createTranspose() instead.

Definition at line 78 of file Tpetra_RowMatrixTransposer_def.hpp.

---

The documentation for this class was generated from the following files:

• Tpetra_RowMatrixTransposer_decl.hpp
• Tpetra_RowMatrixTransposer_def.hpp