Tpetra parallel linear algebra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Tpetra_RowMatrixTransposer_decl.hpp
Go to the documentation of this file.
1 
2 // @HEADER
3 // ***********************************************************************
4 //
5 // Tpetra: Templated Linear Algebra Services Package
6 // Copyright (2008) Sandia Corporation
7 //
8 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9 // the U.S. Government retains certain rights in this software.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
39 //
40 // ************************************************************************
41 // @HEADER
42 
43 #ifndef TPETRA_ROWMATRIXTRANSPOSER_DECL_HPP
44 #define TPETRA_ROWMATRIXTRANSPOSER_DECL_HPP
45 
49 
51 #include "Tpetra_CrsMatrix_fwd.hpp"
52 #include "Tpetra_Map_fwd.hpp"
53 #include "Teuchos_RCP.hpp"
54 #include <string>
55 
56 #ifndef DOXYGEN_SHOULD_SKIP_THIS
57 namespace Teuchos {
58  // Forward declaration of ParameterList
59  class ParameterList;
60 } // namespace Teuchos
61 #endif // DOXYGEN_SHOULD_SKIP_THIS
62 
63 namespace Tpetra {
64 
75 template<class Scalar,
76  class LocalOrdinal,
77  class GlobalOrdinal,
78  class Node>
80 public:
82 
83  typedef Scalar scalar_type;
84  typedef LocalOrdinal local_ordinal_type;
85  typedef GlobalOrdinal global_ordinal_type;
86  typedef Node node_type;
87 
90 
92 
94 
96  RowMatrixTransposer (const Teuchos::RCP<const crs_matrix_type>& origMatrix,const std::string & label = std::string());
97 
99 
101 
103  Teuchos::RCP<crs_matrix_type> createTranspose(const Teuchos::RCP<Teuchos::ParameterList> &params=Teuchos::null);
104 
113  Teuchos::RCP<crs_matrix_type> createTransposeLocal (const Teuchos::RCP<Teuchos::ParameterList> &params=Teuchos::null);
114 
115 private:
117  Teuchos::RCP<const crs_matrix_type> origMatrix_;
118 
120  std::string label_;
121 };
122 
123 } // namespace Tpetra
124 
125 #endif /* TPETRA_ROWMATRIXTRANSPOSER_DECL_HPP */
RowMatrixTransposer(const Teuchos::RCP< const crs_matrix_type > &origMatrix, const std::string &label=std::string())
Constructor that takes the matrix to transpose.
Sparse matrix that presents a row-oriented interface that lets users read or modify entries...
Forward declaration of Tpetra::RowMatrixTransposer.
Construct and (optionally) redistribute the explicitly stored transpose of a CrsMatrix.
Forward declaration of Tpetra::CrsMatrix.
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.
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.
A parallel distribution of indices over processes.
Forward declaration of Tpetra::Map.