Tpetra Matrix/Vector Services Version of the Day
Tpetra::RowMatrixTransposer< Scalar, LocalOrdinal, GlobalOrdinal, Node, SpMatOps > Class Template Reference

#include <Tpetra_RowMatrixTransposer_decl.hpp>

List of all members.

Public Member Functions

Constructors/destructors
 RowMatrixTransposer (const CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &origMatrix)
 Primary Tpetra_CrsMatrixTransposer constructor.
virtual ~RowMatrixTransposer ()
 Tpetra_CrsMatrixTransposer destructor.

Forward transformation methods

RCP< CrsMatrix< Scalar,
LocalOrdinal, GlobalOrdinal,
Node, SpMatOps > > 
createTranspose (const OptimizeOption optimizeTranspose=DoOptimizeStorage, Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > transposeRowMap=Teuchos::null)
 Generate a new Tpetra_CrsMatrix as the transpose of an Tpetra_CrsMatrix passed into the constructor.

Detailed Description

template<class Scalar, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType, class SpMatOps = typename Kokkos::DefaultKernels<Scalar,LocalOrdinal,Node>::SparseOps>
class Tpetra::RowMatrixTransposer< Scalar, LocalOrdinal, GlobalOrdinal, Node, SpMatOps >

This class provides capabilities to construct a transpose matrix of an existing Tpetra_CrsMatrix object and (optionally) redistribute it across a parallel distributed memory machine.

Definition at line 56 of file Tpetra_RowMatrixTransposer_decl.hpp.


Constructor & Destructor Documentation

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node , class SpMatOps >
Tpetra::RowMatrixTransposer< Scalar, LocalOrdinal, GlobalOrdinal, Node, SpMatOps >::RowMatrixTransposer ( const CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  origMatrix)

Primary Tpetra_CrsMatrixTransposer constructor.

Parameters:
origMatrixAn existing Tpetra_CrsMatrix object. The Tpetra_CrsMatrix, the LHS and RHS pointers do not need to be defined before this constructor is called.
Returns:
Pointer to a Tpetra_CrsMatrixTransposer object.

Definition at line 41 of file Tpetra_RowMatrixTransposer_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node , class SpMatOps >
Tpetra::RowMatrixTransposer< Scalar, LocalOrdinal, GlobalOrdinal, Node, SpMatOps >::~RowMatrixTransposer ( ) [virtual]

Tpetra_CrsMatrixTransposer destructor.

Definition at line 49 of file Tpetra_RowMatrixTransposer_def.hpp.


Member Function Documentation

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node , class SpMatOps >
RCP< CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node, SpMatOps > > Tpetra::RowMatrixTransposer< Scalar, LocalOrdinal, GlobalOrdinal, Node, SpMatOps >::createTranspose ( const OptimizeOption  optimizeTranspose = DoOptimizeStorage,
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > >  transposeRowMap = Teuchos::null 
)

Generate a new Tpetra_CrsMatrix as the transpose of an Tpetra_CrsMatrix passed into the constructor.

Constructs a new Tpetra_CrsMatrix that is a copy of the Tpetra_CrsMatrix passed in to the constructor.

Parameters:
optimizeTransposeOptimizes the storage of the newly created Transpose matrix
transposeMatrixThe matrix in which the result of the tranpose operation will be put.
TransposeRowMapIf this argument is defined, the transpose matrix will be distributed using this map as the row map for the transpose. If null, the function will evenly distribute the rows of the tranpose matrix.

Definition at line 57 of file Tpetra_RowMatrixTransposer_def.hpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines