Xpetra Version of the Day
Loading...
Searching...
No Matches
Xpetra_RowMatrix.hpp
Go to the documentation of this file.
1// @HEADER
2//
3// ***********************************************************************
4//
5// Xpetra: A linear algebra interface package
6// Copyright 2012 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
39// Jonathan Hu (jhu@sandia.gov)
40// Andrey Prokopenko (aprokop@sandia.gov)
41// Ray Tuminaro (rstumin@sandia.gov)
42//
43// ***********************************************************************
44//
45// @HEADER
46#ifndef XPETRA_ROWMATRIX_HPP
47#define XPETRA_ROWMATRIX_HPP
48
49/* this file is automatically generated - do not edit (see script/interfaces.py) */
50
51// WARNING: This code is experimental. Backwards compatibility should not be expected.
52
53#include <Teuchos_Describable.hpp>
54#include <KokkosCompat_DefaultNode.hpp>
55#include "Xpetra_ConfigDefs.hpp"
56#include "Xpetra_Map.hpp"
57#include "Xpetra_Vector.hpp"
58
59namespace Xpetra {
60
61 template <class Scalar,
62 class LocalOrdinal,
63 class GlobalOrdinal,
65 class RowMatrix {
66 public:
67 typedef Scalar scalar_type;
68 typedef LocalOrdinal local_ordinal_type;
69 typedef GlobalOrdinal global_ordinal_type;
70 typedef Node node_type;
71
73
74
76 virtual ~RowMatrix() { }
77
79
81
82
85
88
90 virtual global_size_t getGlobalNumRows() const = 0;
91
93 virtual global_size_t getGlobalNumCols() const = 0;
94
96 virtual size_t getLocalNumRows() const = 0;
97
99 virtual size_t getLocalNumCols() const = 0;
100
103
105 virtual size_t getLocalNumEntries() const = 0;
106
108 virtual size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const = 0;
109
111 virtual size_t getGlobalMaxNumRowEntries() const = 0;
112
114 virtual size_t getLocalMaxNumRowEntries() const = 0;
115
117 virtual bool isLocallyIndexed() const = 0;
118
120 virtual bool isGloballyIndexed() const = 0;
121
123 virtual bool isFillComplete() const = 0;
124
126 virtual bool supportsRowViews() const = 0;
127
129
131
132
134 virtual void getLocalRowCopy(LocalOrdinal LocalRow, const Teuchos::ArrayView< LocalOrdinal > &Indices, const Teuchos::ArrayView< Scalar > &Values, size_t &NumEntries) const = 0;
135
137 virtual void getGlobalRowView(GlobalOrdinal GlobalRow, ArrayView< const GlobalOrdinal > &indices, ArrayView< const Scalar > &values) const = 0;
138
140 virtual void getLocalRowView(LocalOrdinal LocalRow, ArrayView< const LocalOrdinal > &indices, ArrayView< const Scalar > &values) const = 0;
141
144
146
148
149
152
154
156
157
160
163
166
168
169 }; // RowMatrix class
170
171} // Xpetra namespace
172
173#define XPETRA_ROWMATRIX_SHORT
174#endif // XPETRA_ROWMATRIX_HPP
virtual size_t getLocalNumEntries() const =0
Returns the local number of entries in this matrix.
virtual bool isGloballyIndexed() const =0
If matrix indices are in the global range, this function returns true. Otherwise, this function retur...
virtual global_size_t getGlobalNumEntries() const =0
Returns the global number of entries in this matrix.
virtual size_t getLocalNumCols() const =0
Returns the number of columns needed to apply the forward operator on this node, i....
virtual const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getColMap() const =0
Returns the Map that describes the column distribution in this matrix.
virtual ScalarTraits< Scalar >::magnitudeType getFrobeniusNorm() const =0
Returns the Frobenius norm of the matrix.
virtual void getGlobalRowView(GlobalOrdinal GlobalRow, ArrayView< const GlobalOrdinal > &indices, ArrayView< const Scalar > &values) const =0
Extract a const, non-persisting view of global indices in a specified row of the matrix.
virtual size_t getLocalMaxNumRowEntries() const =0
Returns the maximum number of entries across all rows/columns on this node.
virtual const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getRowMap() const =0
Returns the Map that describes the row distribution in this matrix.
GlobalOrdinal global_ordinal_type
virtual global_size_t getGlobalNumCols() const =0
Returns the number of global columns in this matrix.
virtual global_size_t getGlobalNumRows() const =0
Returns the number of global rows in this matrix.
virtual size_t getGlobalMaxNumRowEntries() const =0
Returns the maximum number of entries across all rows/columns on all nodes.
virtual void apply(const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, Scalar alpha=Teuchos::ScalarTraits< Scalar >::one(), Scalar beta=Teuchos::ScalarTraits< Scalar >::zero()) const =0
Computes the operator-multivector application.
virtual ~RowMatrix()
Destructor.
virtual const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getRangeMap() const =0
Returns the Map associated with the range of this operator, which must be compatible with Y....
virtual bool isLocallyIndexed() const =0
If matrix indices are in the local range, this function returns true. Otherwise, this function return...
virtual bool supportsRowViews() const =0
Returns true if getLocalRowView() and getGlobalRowView() are valid for this class.
virtual const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getDomainMap() const =0
Returns the Map associated with the domain of this operator, which must be compatible with X....
virtual void getLocalDiagCopy(Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &diag) const =0
Get a copy of the diagonal entries owned by this node, with local row indices.
virtual void getLocalRowCopy(LocalOrdinal LocalRow, const Teuchos::ArrayView< LocalOrdinal > &Indices, const Teuchos::ArrayView< Scalar > &Values, size_t &NumEntries) const =0
Extract a list of entries in a specified local row of the graph. Put into storage allocated by callin...
virtual bool isFillComplete() const =0
Returns true if fillComplete() has been called.
virtual size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const =0
Returns the current number of entries on this node in the specified local row.
LocalOrdinal local_ordinal_type
virtual size_t getLocalNumRows() const =0
Returns the number of rows owned on the calling node.
virtual void getLocalRowView(LocalOrdinal LocalRow, ArrayView< const LocalOrdinal > &indices, ArrayView< const Scalar > &values) const =0
Extract a const, non-persisting view of local indices in a specified row of the matrix.
Xpetra namespace
size_t global_size_t
Global size_t object.