Xpetra Version of the Day
Loading...
Searching...
No Matches
Xpetra_CrsMatrix.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_CRSMATRIX_HPP
47#define XPETRA_CRSMATRIX_HPP
48
49/* this file is automatically generated - do not edit (see script/interfaces.py) */
50
51#include <KokkosCompat_DefaultNode.hpp>
52#include "Xpetra_ConfigDefs.hpp"
53#include "Xpetra_RowMatrix.hpp"
54#include "Xpetra_DistObject.hpp"
55#include "Xpetra_CrsGraph.hpp"
56#include "Xpetra_Vector.hpp"
57
58#ifdef HAVE_XPETRA_TPETRA
59#include <Kokkos_StaticCrsGraph.hpp>
60#include <KokkosSparse_CrsMatrix.hpp>
61#endif
62
63namespace Xpetra {
64
65 template <class Scalar,
66 class LocalOrdinal,
67 class GlobalOrdinal,
70 : public RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node>,
71 public DistObject<char, LocalOrdinal,GlobalOrdinal,Node>
72 {
73 public:
74 typedef Scalar scalar_type;
75 typedef LocalOrdinal local_ordinal_type;
76 typedef GlobalOrdinal global_ordinal_type;
77 typedef Node node_type;
78
80
81
83 virtual ~CrsMatrix() { }
84
86
88
90 virtual void
91 insertGlobalValues (GlobalOrdinal globalRow,
93 const ArrayView<const Scalar>& vals) = 0;
94
96 virtual void insertLocalValues(LocalOrdinal localRow, const ArrayView< const LocalOrdinal > &cols, const ArrayView< const Scalar > &vals)= 0;
97
99 virtual void replaceGlobalValues(GlobalOrdinal globalRow, const ArrayView< const GlobalOrdinal > &cols, const ArrayView< const Scalar > &vals)= 0;
100
102 virtual void replaceLocalValues(LocalOrdinal localRow, const ArrayView< const LocalOrdinal > &cols, const ArrayView< const Scalar > &vals)= 0;
103
105 virtual void setAllToScalar(const Scalar &alpha)= 0;
106
108 virtual void scale(const Scalar &alpha)= 0;
109
120 virtual void allocateAllValues(size_t numNonZeros,ArrayRCP<size_t> & rowptr, ArrayRCP<LocalOrdinal> & colind, ArrayRCP<Scalar> & values)=0;
121
123 virtual void setAllValues(const ArrayRCP<size_t> & rowptr, const ArrayRCP<LocalOrdinal> & colind, const ArrayRCP<Scalar> & values)=0;
124
127
129 virtual void getAllValues(ArrayRCP<Scalar>& values) =0;
130
132
134
135
137 virtual void resumeFill(const RCP< ParameterList > &params=null)= 0;
138
140 virtual void fillComplete(const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &domainMap, const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rangeMap, const RCP< ParameterList > &params=null)= 0;
141
143 virtual void fillComplete(const RCP< ParameterList > &params=null)= 0;
144
147
150 const RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > & rangeMap,
151 const RCP<const Import<LocalOrdinal,GlobalOrdinal,Node> > &importer=Teuchos::null,
152 const RCP<const Export<LocalOrdinal,GlobalOrdinal,Node> > &exporter=Teuchos::null,
153 const RCP<ParameterList> &params=Teuchos::null) = 0;
155
157
158
161
164
167
169 virtual global_size_t getGlobalNumRows() const = 0;
170
172 virtual global_size_t getGlobalNumCols() const = 0;
173
175 virtual size_t getLocalNumRows() const = 0;
176
179
181 virtual size_t getLocalNumEntries() const = 0;
182
184 virtual size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const = 0;
185
187 virtual size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const = 0;
188
190 virtual size_t getGlobalMaxNumRowEntries() const = 0;
191
193 virtual size_t getLocalMaxNumRowEntries() const = 0;
194
196 virtual bool isLocallyIndexed() const = 0;
197
199 virtual bool isGloballyIndexed() const = 0;
200
202 virtual bool isFillComplete() const = 0;
203
205 virtual bool isFillActive() const = 0;
206
209
211 virtual bool supportsRowViews() const = 0;
212
214 virtual void getGlobalRowView(GlobalOrdinal GlobalRow, ArrayView< const GlobalOrdinal > &indices, ArrayView< const Scalar > &values) const = 0;
215
217 virtual void getGlobalRowCopy(GlobalOrdinal GlobalRow, const ArrayView<GlobalOrdinal> &indices, const ArrayView<Scalar> &values, size_t &numEntries) const = 0;
218
220 virtual void getLocalRowView(LocalOrdinal LocalRow, ArrayView< const LocalOrdinal > &indices, ArrayView< const Scalar > &values) const = 0;
221
224
226 virtual void getLocalDiagOffsets(Teuchos::ArrayRCP<size_t> &offsets) const = 0;
227
230
233
236
239
241
243 virtual bool haveGlobalConstants() const = 0;
244
246
248
249
263
281 virtual void apply(const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Y, Teuchos::ETransp mode, Scalar alpha, Scalar beta, bool sumInterfaceValues, const RCP<Import<LocalOrdinal, GlobalOrdinal, Node> >& regionInterfaceImporter, const Teuchos::ArrayRCP<LocalOrdinal>& regionInterfaceLIDs) const = 0;
282
283
286
289
291
293
294
296 virtual std::string description() const = 0;
297
300
302
304
305 virtual void setObjectLabel( const std::string &objectLabel ) =0;
307
309
310#ifdef HAVE_XPETRA_TPETRA
311 using impl_scalar_type = typename Kokkos::Details::ArithTraits<Scalar>::val_type;
312 using execution_space = typename node_type::device_type;
313
314 // that is the local_graph_type in Tpetra::CrsGraph...
315 using local_graph_type = Kokkos::StaticCrsGraph<LocalOrdinal,
316 Kokkos::LayoutLeft,
318 void,
319 size_t>;
323 using local_matrix_type = KokkosSparse::CrsMatrix<impl_scalar_type, LocalOrdinal, execution_space,void,
324 typename local_graph_type::size_type>;
325
327 virtual typename local_matrix_type::HostMirror getLocalMatrixHost () const = 0;
328
329 virtual void setAllValues (const typename local_matrix_type::row_map_type& ptr,
330 const typename local_graph_type::entries_type::non_const_type& ind,
331 const typename local_matrix_type::values_type& val)=0;
332#else
333#ifdef __GNUC__
334#warning "Xpetra Kokkos interface for CrsMatrix is enabled (HAVE_XPETRA_KOKKOS_REFACTOR) but Tpetra is disabled. The Kokkos interface needs Tpetra to be enabled, too."
335#endif
336#endif
337
339
340 // Adding these functions by hand, as they're in the skip list.
341
343 virtual size_t getLocalNumCols() const = 0;
344
346 virtual void getLocalRowCopy(LocalOrdinal LocalRow, const ArrayView< LocalOrdinal > &Indices, const ArrayView< Scalar > &Values, size_t &NumEntries) const = 0;
347
349 virtual bool hasMatrix() const = 0;
350
352 virtual LocalOrdinal GetStorageBlockSize() const = 0;
353
358
359
360 }; // CrsMatrix class
361
362} // Xpetra namespace
363
364#define XPETRA_CRSMATRIX_SHORT
365#endif // XPETRA_CRSMATRIX_HPP
static const EVerbosityLevel verbLevel_default
virtual void getLocalDiagOffsets(Teuchos::ArrayRCP< size_t > &offsets) const =0
Get offsets of the diagonal entries in the matrix.
virtual void replaceLocalValues(LocalOrdinal localRow, const ArrayView< const LocalOrdinal > &cols, const ArrayView< const Scalar > &vals)=0
Replace matrix entries, using local IDs.
virtual void replaceDomainMapAndImporter(const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &newDomainMap, Teuchos::RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > &newImporter)=0
Replaces the current domainMap and importer with the user-specified objects.
virtual RCP< const CrsGraph< LocalOrdinal, GlobalOrdinal, Node > > getCrsGraph() const =0
Returns the CrsGraph associated with this matrix.
virtual size_t getGlobalMaxNumRowEntries() const =0
Returns the maximum number of entries across all rows/columns on all nodes.
virtual void rightScale(const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x)=0
Right scale matrix using the given vector entries.
virtual void setAllValues(const typename local_matrix_type::row_map_type &ptr, const typename local_graph_type::entries_type::non_const_type &ind, const typename local_matrix_type::values_type &val)=0
virtual void getLocalDiagCopy(Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &diag, const Teuchos::ArrayView< const size_t > &offsets) const =0
Get a copy of the diagonal entries owned by this node, with local row indices, using row offsets.
GlobalOrdinal global_ordinal_type
virtual bool isLocallyIndexed() const =0
If matrix indices are in the local range, this function returns true. Otherwise, this function return...
virtual const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getRowMap() const =0
Returns the Map that describes the row distribution in this matrix.
virtual void fillComplete(const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &domainMap, const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rangeMap, const RCP< ParameterList > &params=null)=0
Signal that data entry is complete, specifying domain and range maps.
virtual void scale(const Scalar &alpha)=0
Scale the current values of a matrix, this = alpha*this.
virtual void residual(const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &R) const =0
Compute a residual R = B - (*this) * X.
virtual std::string description() const =0
A simple one-line description of this object.
virtual void expertStaticFillComplete(const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &domainMap, const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rangeMap, const RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > &importer=Teuchos::null, const RCP< const Export< LocalOrdinal, GlobalOrdinal, Node > > &exporter=Teuchos::null, const RCP< ParameterList > &params=Teuchos::null)=0
Expert static fill complete.
virtual size_t getLocalNumRows() const =0
Returns the number of matrix rows owned on the calling node.
virtual ~CrsMatrix()
Destructor.
virtual void setAllValues(const ArrayRCP< size_t > &rowptr, const ArrayRCP< LocalOrdinal > &colind, const ArrayRCP< Scalar > &values)=0
Sets the 1D pointer arrays of the graph.
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.
virtual void setObjectLabel(const std::string &objectLabel)=0
virtual void leftScale(const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x)=0
Left scale matrix using the given vector entries.
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 void removeEmptyProcessesInPlace(const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &newMap)=0
virtual void fillComplete(const RCP< ParameterList > &params=null)=0
Signal that data entry is complete.
virtual void setAllToScalar(const Scalar &alpha)=0
Set all matrix entries equal to scalarThis.
virtual const 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 void replaceGlobalValues(GlobalOrdinal globalRow, const ArrayView< const GlobalOrdinal > &cols, const ArrayView< const Scalar > &vals)=0
Replace matrix entries, using global IDs.
virtual size_t getLocalMaxNumRowEntries() const =0
Returns the maximum number of entries across all rows/columns on this node.
virtual size_t getLocalNumEntries() const =0
Returns the local number of entries in this matrix.
Kokkos::StaticCrsGraph< LocalOrdinal, Kokkos::LayoutLeft, execution_space, void, size_t > local_graph_type
virtual void getGlobalRowCopy(GlobalOrdinal GlobalRow, const ArrayView< GlobalOrdinal > &indices, const ArrayView< Scalar > &values, size_t &numEntries) const =0
Extract a list of entries in a specified global row of this matrix. Put into pre-allocated storage.
typename node_type::device_type execution_space
virtual const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getDomainMap() const =0
Returns the Map associated with the domain of this operator. This will be null until fillComplete() i...
virtual ScalarTraits< Scalar >::magnitudeType getFrobeniusNorm() const =0
Returns the Frobenius norm of the matrix.
virtual global_size_t getGlobalNumRows() const =0
Number of global elements in the row map of this matrix.
virtual void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const =0
Print the object with some verbosity level to an FancyOStream object.
virtual local_matrix_type::HostMirror getLocalMatrixHost() const =0
virtual void getLocalRowCopy(LocalOrdinal LocalRow, const ArrayView< LocalOrdinal > &Indices, const ArrayView< Scalar > &Values, size_t &NumEntries) const =0
Extract a list of entries in a specified local row of the matrix. Put into storage allocated by calli...
LocalOrdinal local_ordinal_type
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 bool isFillComplete() const =0
Returns true if the matrix is in compute mode, i.e. if fillComplete() has been called.
virtual global_size_t getGlobalNumEntries() const =0
Returns the global 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 getGlobalNumCols() const =0
Number of global columns in the matrix.
virtual void resumeFill(const RCP< ParameterList > &params=null)=0
virtual void insertGlobalValues(GlobalOrdinal globalRow, const ArrayView< const GlobalOrdinal > &cols, const ArrayView< const Scalar > &vals)=0
Insert matrix entries, using global IDs.
virtual bool isFillActive() const =0
Returns true if the matrix is in edit mode.
virtual size_t getLocalNumCols() const =0
Returns the number of matrix columns owned on the calling node.
virtual void replaceDiag(const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &diag)=0
Replace the diagonal entries of the matrix.
virtual size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const =0
Returns the current number of entries on this node in the specified local row.
virtual void apply(const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, Scalar alpha=ScalarTraits< Scalar >::one(), Scalar beta=ScalarTraits< Scalar >::zero()) const =0
Computes the sparse matrix-multivector multiplication.
virtual size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const =0
Returns the current number of entries in the specified global row.
virtual bool hasMatrix() const =0
Does this have an underlying matrix.
virtual void insertLocalValues(LocalOrdinal localRow, const ArrayView< const LocalOrdinal > &cols, const ArrayView< const Scalar > &vals)=0
Insert matrix entries, using local IDs.
virtual bool haveGlobalConstants() const =0
Returns true if globalConstants have been computed; false otherwise.
virtual void getAllValues(ArrayRCP< const size_t > &rowptr, ArrayRCP< const LocalOrdinal > &colind, ArrayRCP< const Scalar > &values) const =0
Gets the 1D pointer arrays of the graph.
typename Kokkos::Details::ArithTraits< Scalar >::val_type impl_scalar_type
virtual void apply(const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Y, Teuchos::ETransp mode, Scalar alpha, Scalar beta, bool sumInterfaceValues, const RCP< Import< LocalOrdinal, GlobalOrdinal, Node > > &regionInterfaceImporter, const Teuchos::ArrayRCP< LocalOrdinal > &regionInterfaceLIDs) const =0
Computes the sparse matrix-multivector multiplication for region layout matrices.
virtual void allocateAllValues(size_t numNonZeros, ArrayRCP< size_t > &rowptr, ArrayRCP< LocalOrdinal > &colind, ArrayRCP< Scalar > &values)=0
Allocates and returns ArrayRCPs of the Crs arrays — This is an Xpetra-only routine.
virtual const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getColMap() const =0
Returns the Map that describes the column distribution in this matrix.
virtual LocalOrdinal GetStorageBlockSize() const =0
Returns the block size of the storage mechanism, which is usually 1, except for Tpetra::BlockCrsMatri...
virtual bool supportsRowViews() const =0
Returns true if getLocalRowView() and getGlobalRowView() are valid for this class.
KokkosSparse::CrsMatrix< impl_scalar_type, LocalOrdinal, execution_space, void, typename local_graph_type::size_type > local_matrix_type
The specialization of Kokkos::CrsMatrix that represents the part of the sparse matrix on each MPI pro...
virtual local_matrix_type getLocalMatrixDevice() const =0
virtual void getAllValues(ArrayRCP< Scalar > &values)=0
Gets the 1D pointer arrays of the graph.
Xpetra namespace
size_t global_size_t
Global size_t object.