Amesos2 - Direct Sparse Solver Interfaces Version of the Day
Amesos2_TpetraCrsMatrix_MatrixAdapter_decl.hpp
Go to the documentation of this file.
1// @HEADER
2//
3// ***********************************************************************
4//
5// Amesos2: Templated Direct Sparse Solver Package
6// Copyright 2011 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//
42// @HEADER
43
44
55#ifndef AMESOS2_TPETRACRSMATRIX_MATRIXADAPTER_DECL_HPP
56#define AMESOS2_TPETRACRSMATRIX_MATRIXADAPTER_DECL_HPP
57
58#include "Amesos2_config.h"
59
60#include "Amesos2_TpetraRowMatrix_AbstractMatrixAdapter_decl.hpp"
61#include "Amesos2_MatrixAdapter_decl.hpp"
62
63namespace Amesos2 {
64
77 template <typename Scalar,
78 typename LocalOrdinal,
79 typename GlobalOrdinal,
80 typename Node>
81 class ConcreteMatrixAdapter<Tpetra::CrsMatrix<Scalar,
82 LocalOrdinal,
83 GlobalOrdinal,
84 Node> >
85 : public AbstractConcreteMatrixAdapter<Tpetra::RowMatrix<Scalar,
86 LocalOrdinal,
87 GlobalOrdinal,
88 Node>,
89 Tpetra::CrsMatrix<Scalar,
90 LocalOrdinal,
91 GlobalOrdinal,
92 Node> >
93 {
94 // Give our matrix adapter class access to our private
95 // implementation functions
96 friend class MatrixAdapter<Tpetra::RowMatrix<Scalar,
97 LocalOrdinal,
98 GlobalOrdinal,
99 Node> >;
100 public:
101 typedef Tpetra::CrsMatrix<Scalar,
102 LocalOrdinal,
103 GlobalOrdinal,
104 Node> matrix_t;
105 private:
107 Tpetra::RowMatrix<Scalar,
108 LocalOrdinal,
109 GlobalOrdinal,
110 Node>, matrix_t> super_t;
111 public:
112 // 'import' superclass types
113 typedef typename super_t::scalar_t scalar_t;
114 typedef typename super_t::local_ordinal_t local_ordinal_t;
115 typedef typename super_t::global_ordinal_t global_ordinal_t;
116 typedef typename super_t::node_t node_t;
117 typedef typename super_t::global_size_t global_size_t;
118
119 typedef ConcreteMatrixAdapter<matrix_t> type;
120
121 ConcreteMatrixAdapter(RCP<matrix_t> m);
122
123 RCP<const MatrixAdapter<matrix_t> > get_impl(const Teuchos::Ptr<const Tpetra::Map<local_ordinal_t,global_ordinal_t,node_t> > map, EDistribution distribution = ROOTED) const;
124
125 };
126
127} // end namespace Amesos2
128
129#endif // AMESOS2_TPETRACRSMATRIX_MATRIXADAPTER_DECL_HPP
Definition: Amesos2_AbstractConcreteMatrixAdapter.hpp:89
A Matrix adapter interface for Amesos2.
Definition: Amesos2_MatrixAdapter_decl.hpp:76