Xpetra Version of the Day
Loading...
Searching...
No Matches
Xpetra_TpetraBlockCrsMatrix_decl.hpp
Go to the documentation of this file.
1// @HEADER
2// *****************************************************************************
3// Xpetra: A linear algebra interface package
4//
5// Copyright 2012 NTESS and the Xpetra contributors.
6// SPDX-License-Identifier: BSD-3-Clause
7// *****************************************************************************
8// @HEADER
9
10#ifndef XPETRA_TPETRABLOCKCRSMATRIX_DECL_HPP
11#define XPETRA_TPETRABLOCKCRSMATRIX_DECL_HPP
12
13/* this file is automatically generated - do not edit (see script/tpetra.py) */
14
15#include "Xpetra_TpetraConfigDefs.hpp"
16
17#include "Tpetra_BlockCrsMatrix.hpp"
18#include "Tpetra_CrsMatrix.hpp"
19
20#include "Xpetra_CrsMatrix.hpp"
21#include "Xpetra_TpetraMap_decl.hpp"
22#include "Xpetra_TpetraMultiVector_decl.hpp"
23#include "Xpetra_TpetraVector_decl.hpp"
24#include "Xpetra_TpetraCrsGraph_decl.hpp"
25#include "Xpetra_Exceptions.hpp"
26
27namespace Xpetra {
28
29template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
30class TpetraBlockCrsMatrix
31 : public CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> //, public TpetraRowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node>
32{
33 // The following typedef are used by the XPETRA_DYNAMIC_CAST() macro.
34 typedef TpetraBlockCrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> TpetraBlockCrsMatrixClass;
35 typedef TpetraVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> TpetraVectorClass;
36 typedef TpetraImport<LocalOrdinal, GlobalOrdinal, Node> TpetraImportClass;
37 typedef TpetraExport<LocalOrdinal, GlobalOrdinal, Node> TpetraExportClass;
38
39 public:
41
43 TpetraBlockCrsMatrix(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &rowMap,
44 size_t maxNumEntriesPerRow,
45 const Teuchos::RCP<Teuchos::ParameterList> &params = Teuchos::null);
46
48 TpetraBlockCrsMatrix(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &rowMap,
49 const ArrayRCP<const size_t> &NumEntriesPerRowToAlloc,
50 const Teuchos::RCP<Teuchos::ParameterList> &params = Teuchos::null);
51
53 TpetraBlockCrsMatrix(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &rowMap,
54 const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &colMap,
55 size_t maxNumEntriesPerRow,
56 const Teuchos::RCP<Teuchos::ParameterList> &params = Teuchos::null);
57
59 TpetraBlockCrsMatrix(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &rowMap,
60 const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &colMap,
61 const ArrayRCP<const size_t> &NumEntriesPerRowToAlloc,
62 const Teuchos::RCP<Teuchos::ParameterList> &params = Teuchos::null);
63
65 TpetraBlockCrsMatrix(const Teuchos::RCP<const CrsGraph<LocalOrdinal, GlobalOrdinal, Node> > &graph,
66 const Teuchos::RCP<Teuchos::ParameterList> &params = Teuchos::null);
67
69 TpetraBlockCrsMatrix(const Teuchos::RCP<const CrsGraph<LocalOrdinal, GlobalOrdinal, Node> > &graph,
70 const LocalOrdinal blockSize);
71
73 TpetraBlockCrsMatrix(const Teuchos::RCP<const CrsGraph<LocalOrdinal, GlobalOrdinal, Node> > &graph,
74 const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &pointDomainMap,
75 const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &pointRangeMap,
76 const LocalOrdinal blockSize);
77
79 TpetraBlockCrsMatrix(const Teuchos::RCP<const Tpetra::BlockCrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> > &sourceMatrix,
80 const Import<LocalOrdinal, GlobalOrdinal, Node> &importer,
81 const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &domainMap = Teuchos::null,
82 const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &rangeMap = Teuchos::null,
83 const Teuchos::RCP<Teuchos::ParameterList> &params = Teuchos::null);
84
86 TpetraBlockCrsMatrix(const Teuchos::RCP<const Tpetra::BlockCrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> > &sourceMatrix,
87 const Export<LocalOrdinal, GlobalOrdinal, Node> &exporter,
88 const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &domainMap = Teuchos::null,
89 const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &rangeMap = Teuchos::null,
90 const Teuchos::RCP<Teuchos::ParameterList> &params = Teuchos::null);
91
93 TpetraBlockCrsMatrix(const Teuchos::RCP<const Tpetra::BlockCrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> > &sourceMatrix,
94 const Import<LocalOrdinal, GlobalOrdinal, Node> &RowImporter,
95 const Teuchos::RCP<const Import<LocalOrdinal, GlobalOrdinal, Node> > DomainImporter,
96 const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &domainMap,
97 const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &rangeMap,
98 const Teuchos::RCP<Teuchos::ParameterList> &params);
99
101 TpetraBlockCrsMatrix(const Teuchos::RCP<const Tpetra::BlockCrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> > &sourceMatrix,
102 const Export<LocalOrdinal, GlobalOrdinal, Node> &RowExporter,
103 const Teuchos::RCP<const Export<LocalOrdinal, GlobalOrdinal, Node> > DomainExporter,
104 const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &domainMap,
105 const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &rangeMap,
106 const Teuchos::RCP<Teuchos::ParameterList> &params);
107
109 virtual ~TpetraBlockCrsMatrix();
110
112
114 void insertGlobalValues(GlobalOrdinal globalRow,
115 const ArrayView<const GlobalOrdinal> &cols,
116 const ArrayView<const Scalar> &vals);
117
119 void insertLocalValues(LocalOrdinal localRow,
120 const ArrayView<const LocalOrdinal> &cols,
121 const ArrayView<const Scalar> &vals);
122
124 void replaceGlobalValues(GlobalOrdinal globalRow,
125 const ArrayView<const GlobalOrdinal> &cols,
126 const ArrayView<const Scalar> &vals);
127
129 void replaceLocalValues(LocalOrdinal localRow,
130 const ArrayView<const LocalOrdinal> &cols,
131 const ArrayView<const Scalar> &vals);
132
134 void setAllToScalar(const Scalar &alpha);
135
137 void scale(const Scalar &alpha);
138
140 //** \warning This is an expert-only routine and should not be called from user code. (not implemented)
141 void allocateAllValues(size_t numNonZeros, ArrayRCP<size_t> &rowptr,
142 ArrayRCP<LocalOrdinal> &colind,
143 ArrayRCP<Scalar> &values);
144
146 void setAllValues(const ArrayRCP<size_t> &rowptr,
147 const ArrayRCP<LocalOrdinal> &colind,
148 const ArrayRCP<Scalar> &values);
149
151 void getAllValues(ArrayRCP<const size_t> &rowptr,
152 ArrayRCP<const LocalOrdinal> &colind,
153 ArrayRCP<const Scalar> &values) const;
154
156 void getAllValues(ArrayRCP<Scalar> &values);
157
159
161 void resumeFill(const RCP<ParameterList> &params = null);
162
164 void fillComplete(const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &domainMap,
165 const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &rangeMap, const RCP<ParameterList> &params = null);
166
168 void fillComplete(const RCP<ParameterList> &params = null);
169
171 void replaceDomainMapAndImporter(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &newDomainMap,
172 Teuchos::RCP<const Import<LocalOrdinal, GlobalOrdinal, Node> > &newImporter);
173
175 void expertStaticFillComplete(const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &domainMap,
176 const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &rangeMap,
177 const RCP<const Import<LocalOrdinal, GlobalOrdinal, Node> > &importer = Teuchos::null,
178 const RCP<const Export<LocalOrdinal, GlobalOrdinal, Node> > &exporter = Teuchos::null,
179 const RCP<ParameterList> &params = Teuchos::null);
180
182
184 const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > getRowMap() const;
185
187 const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > getColMap() const;
188
190 RCP<const CrsGraph<LocalOrdinal, GlobalOrdinal, Node> > getCrsGraph() const;
191
193 global_size_t getGlobalNumRows() const;
194
196 global_size_t getGlobalNumCols() const;
197
199 size_t getLocalNumRows() const;
200
202 size_t getLocalNumCols() const;
203
205 global_size_t getGlobalNumEntries() const;
206
208 size_t getLocalNumEntries() const;
209
211 size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const;
212
214 size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const;
215
217 size_t getGlobalMaxNumRowEntries() const;
218
220 size_t getLocalMaxNumRowEntries() const;
221
223 bool isLocallyIndexed() const;
224
226 bool isGloballyIndexed() const;
227
229 bool isFillComplete() const;
230
232 bool isFillActive() const;
233
235 typename ScalarTraits<Scalar>::magnitudeType getFrobeniusNorm() const;
236
238 bool supportsRowViews() const;
239
241 void getLocalRowCopy(LocalOrdinal LocalRow, const ArrayView<LocalOrdinal> &Indices, const ArrayView<Scalar> &Values, size_t &NumEntries) const;
242
244 void getGlobalRowView(GlobalOrdinal GlobalRow, ArrayView<const GlobalOrdinal> &indices, ArrayView<const Scalar> &values) const;
245
247 void getGlobalRowCopy(GlobalOrdinal GlobalRow, const ArrayView<GlobalOrdinal> &indices, const ArrayView<Scalar> &values, size_t &numEntries) const;
248
250 void getLocalRowView(LocalOrdinal LocalRow, ArrayView<const LocalOrdinal> &indices, ArrayView<const Scalar> &values) const;
251
253 virtual bool haveGlobalConstants() const;
254
256
258 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;
259
261 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;
262
264 const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > getDomainMap() const;
265
267 const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > getRangeMap() const;
268
270
272 std::string description() const;
273
275 void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel = Teuchos::Describable::verbLevel_default) const;
276
278 void setObjectLabel(const std::string &objectLabel);
279
281 void getLocalDiagCopy(Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &diag) const;
282
284 void getLocalDiagCopy(Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &diag,
285 const Teuchos::ArrayView<const size_t> &offsets) const;
286
288 void getLocalDiagOffsets(Teuchos::ArrayRCP<size_t> &offsets) const;
289
291 void getLocalDiagCopy(Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &diag, const Kokkos::View<const size_t *, typename Node::device_type, Kokkos::MemoryUnmanaged> &offsets) const;
292
293 void replaceDiag(const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &diag);
294
296 void leftScale(const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &x);
297
299 void rightScale(const Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &x);
300
302
304 Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > getMap() const;
305
307 void doImport(const DistObject<char, LocalOrdinal, GlobalOrdinal, Node> &source,
308 const Import<LocalOrdinal, GlobalOrdinal, Node> &importer, CombineMode CM);
309
311 void doExport(const DistObject<char, LocalOrdinal, GlobalOrdinal, Node> &dest,
312 const Import<LocalOrdinal, GlobalOrdinal, Node> &importer, CombineMode CM);
313
315 void doImport(const DistObject<char, LocalOrdinal, GlobalOrdinal, Node> &source,
316 const Export<LocalOrdinal, GlobalOrdinal, Node> &exporter, CombineMode CM);
317
319 void doExport(const DistObject<char, LocalOrdinal, GlobalOrdinal, Node> &dest,
320 const Export<LocalOrdinal, GlobalOrdinal, Node> &exporter, CombineMode CM);
321
322 void removeEmptyProcessesInPlace(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > &newMap);
323
325
327 bool hasMatrix() const;
328
330 TpetraBlockCrsMatrix(const Teuchos::RCP<Tpetra::BlockCrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> > &mtx);
331
333 RCP<const Tpetra::BlockCrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> > getTpetra_BlockCrsMatrix() const;
334
336 RCP<Tpetra::BlockCrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> > getTpetra_BlockCrsMatrixNonConst() const;
337
338#ifdef HAVE_XPETRA_TPETRA
339 // using local_matrix_type = typename Xpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::local_matrix_type;
340 using local_matrix_type = typename CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>::local_matrix_type;
341
342 local_matrix_type getLocalMatrixDevice() const;
343#if KOKKOS_VERSION >= 40799
344 typename local_matrix_type::host_mirror_type getLocalMatrixHost() const;
345#else
346 typename local_matrix_type::HostMirror getLocalMatrixHost() const;
347#endif
348
349 void setAllValues(const typename local_matrix_type::row_map_type &ptr,
350 const typename local_matrix_type::StaticCrsGraphType::entries_type::non_const_type &ind,
351 const typename local_matrix_type::values_type &val);
352#endif // HAVE_XPETRA_TPETRA
353
355 LocalOrdinal GetStorageBlockSize() const { return mtx_->getBlockSize(); }
356
358 void residual(const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &X,
359 const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &B,
360 MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &R) const {
361 using STS = Teuchos::ScalarTraits<Scalar>;
362 R.update(STS::one(), B, STS::zero());
363 this->apply(X, R, Teuchos::NO_TRANS, -STS::one(), STS::one());
364 }
365
366 private:
367 RCP<Tpetra::BlockCrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> > mtx_;
368
369}; // TpetraBlockCrsMatrix class
370
371} // namespace Xpetra
372
373#define XPETRA_TPETRABLOCKCRSMATRIX_SHORT
374#endif // XPETRA_TPETRABLOCKCRSMATRIX_DECL_HPP
Xpetra_CrsMatrix.hpp
Xpetra_Exceptions.hpp
Xpetra_TpetraConfigDefs.hpp
Xpetra_TpetraCrsGraph_decl.hpp
Xpetra_TpetraMap_decl.hpp
Xpetra_TpetraMultiVector_decl.hpp
Xpetra_TpetraVector_decl.hpp
Teuchos::Describable::verbLevel_default
static const EVerbosityLevel verbLevel_default
Teuchos::basic_FancyOStream
Xpetra::CrsMatrix::local_matrix_type
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...
Definition Xpetra_CrsMatrix.hpp:293
Xpetra::MultiVector::update
virtual void update(const Scalar &alpha, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &A, const Scalar &beta)=0
Update multi-vector values with scaled values of A, this = beta*this + alpha*A.
Xpetra::TpetraBlockCrsMatrix::insertGlobalValues
void insertGlobalValues(GlobalOrdinal globalRow, const ArrayView< const GlobalOrdinal > &cols, const ArrayView< const Scalar > &vals)
Insert matrix entries, using global IDs (not implemented)
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:139
Xpetra::TpetraBlockCrsMatrix::setObjectLabel
void setObjectLabel(const std::string &objectLabel)
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:523
Xpetra::TpetraBlockCrsMatrix::getLocalMatrixHost
local_matrix_type::HostMirror getLocalMatrixHost() const
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:702
Xpetra::TpetraBlockCrsMatrix::getRowMap
const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getRowMap() const
Returns the Map that describes the row distribution in this matrix.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:266
Xpetra::TpetraBlockCrsMatrix::setAllToScalar
void setAllToScalar(const Scalar &alpha)
Set all matrix entries equal to scalarThis.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:174
Xpetra::TpetraBlockCrsMatrix::description
std::string description() const
A simple one-line description of this object.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:508
Xpetra::TpetraBlockCrsMatrix::haveGlobalConstants
virtual bool haveGlobalConstants() const
Returns true if globalConstants have been computed; false otherwise.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:465
Xpetra::TpetraBlockCrsMatrix::TpetraImportClass
TpetraImport< LocalOrdinal, GlobalOrdinal, Node > TpetraImportClass
Definition Xpetra_TpetraBlockCrsMatrix_decl.hpp:36
Xpetra::TpetraBlockCrsMatrix::getLocalNumCols
size_t getLocalNumCols() const
Returns the number of columns connected to the locally owned rows of this matrix.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:318
Xpetra::TpetraBlockCrsMatrix::allocateAllValues
void allocateAllValues(size_t numNonZeros, ArrayRCP< size_t > &rowptr, ArrayRCP< LocalOrdinal > &colind, ArrayRCP< Scalar > &values)
Allocates and returns ArrayRCPs of the Crs arrays — This is an Xpetra-only routine.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:190
Xpetra::TpetraBlockCrsMatrix::getLocalRowCopy
void getLocalRowCopy(LocalOrdinal LocalRow, const ArrayView< LocalOrdinal > &Indices, const ArrayView< Scalar > &Values, size_t &NumEntries) const
Extract a list of entries in a specified local row of the matrix. Put into storage allocated by calli...
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:405
Xpetra::TpetraBlockCrsMatrix::getGlobalMaxNumRowEntries
size_t getGlobalMaxNumRowEntries() const
Returns the maximum number of entries across all rows/columns on all nodes.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:356
Xpetra::TpetraBlockCrsMatrix::supportsRowViews
bool supportsRowViews() const
Returns true if getLocalRowView() and getGlobalRowView() are valid for this class.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:398
Xpetra::TpetraBlockCrsMatrix::isLocallyIndexed
bool isLocallyIndexed() const
If matrix indices are in the local range, this function returns true. Otherwise, this function return...
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:368
Xpetra::TpetraBlockCrsMatrix::getGlobalNumRows
global_size_t getGlobalNumRows() const
Number of global elements in the row map of this matrix.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:294
Xpetra::TpetraBlockCrsMatrix::getNumEntriesInLocalRow
size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const
Returns the current number of entries on this node in the specified local row.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:342
Xpetra::TpetraBlockCrsMatrix::TpetraBlockCrsMatrixClass
TpetraBlockCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > TpetraBlockCrsMatrixClass
Definition Xpetra_TpetraBlockCrsMatrix_decl.hpp:34
Xpetra::TpetraBlockCrsMatrix::leftScale
void leftScale(const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x)
Left scale operator with given vector values.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:595
Xpetra::TpetraBlockCrsMatrix::getAllValues
void getAllValues(ArrayRCP< const size_t > &rowptr, ArrayRCP< const LocalOrdinal > &colind, ArrayRCP< const Scalar > &values) const
Gets the 1D pointer arrays of the graph (not implemented)
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:204
Xpetra::TpetraBlockCrsMatrix::getLocalNumRows
size_t getLocalNumRows() const
Returns the number of matrix rows owned on the calling node.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:310
Xpetra::TpetraBlockCrsMatrix::getLocalDiagCopy
void getLocalDiagCopy(Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &diag) const
Get a copy of the diagonal entries owned by this node, with local row idices.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:531
Xpetra::TpetraBlockCrsMatrix::TpetraVectorClass
TpetraVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > TpetraVectorClass
Definition Xpetra_TpetraBlockCrsMatrix_decl.hpp:35
Xpetra::TpetraBlockCrsMatrix::hasMatrix
bool hasMatrix() const
Does this have an underlying matrix.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:653
Xpetra::TpetraBlockCrsMatrix::getLocalDiagOffsets
void getLocalDiagOffsets(Teuchos::ArrayRCP< size_t > &offsets) const
Get offsets of the diagonal entries in the matrix.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:558
Xpetra::TpetraBlockCrsMatrix::setAllValues
void setAllValues(const ArrayRCP< size_t > &rowptr, const ArrayRCP< LocalOrdinal > &colind, const ArrayRCP< Scalar > &values)
Sets the 1D pointer arrays of the graph (not impelmented)
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:197
Xpetra::TpetraBlockCrsMatrix::replaceDiag
void replaceDiag(const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &diag)
Replace the diagonal entries of the matrix.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:589
Xpetra::TpetraBlockCrsMatrix::getGlobalNumEntries
global_size_t getGlobalNumEntries() const
Returns the global number of entries in this matrix.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:326
Xpetra::TpetraBlockCrsMatrix::isGloballyIndexed
bool isGloballyIndexed() const
If matrix indices are in the global range, this function returns true. Otherwise, this function retur...
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:374
Xpetra::TpetraBlockCrsMatrix::TpetraExportClass
TpetraExport< LocalOrdinal, GlobalOrdinal, Node > TpetraExportClass
Definition Xpetra_TpetraBlockCrsMatrix_decl.hpp:37
Xpetra::TpetraBlockCrsMatrix::rightScale
void rightScale(const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x)
Right scale operator with given vector values.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:601
Xpetra::TpetraBlockCrsMatrix::getTpetra_BlockCrsMatrix
RCP< const Tpetra::BlockCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getTpetra_BlockCrsMatrix() const
Get the underlying Tpetra matrix.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:665
Xpetra::TpetraBlockCrsMatrix::scale
void scale(const Scalar &alpha)
Scale the current values of a matrix, this = alpha*this (not implemented)
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:182
Xpetra::TpetraBlockCrsMatrix::getColMap
const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getColMap() const
Returns the Map that describes the column distribution in this matrix.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:274
Xpetra::TpetraBlockCrsMatrix::insertLocalValues
void insertLocalValues(LocalOrdinal localRow, const ArrayView< const LocalOrdinal > &cols, const ArrayView< const Scalar > &vals)
Insert matrix entries, using local IDs (not implemented)
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:148
Xpetra::TpetraBlockCrsMatrix::local_matrix_type
typename CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_matrix_type local_matrix_type
Definition Xpetra_TpetraBlockCrsMatrix_decl.hpp:340
Xpetra::TpetraBlockCrsMatrix::apply
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
Computes the sparse matrix-multivector multiplication.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:469
Xpetra::TpetraBlockCrsMatrix::getCrsGraph
RCP< const CrsGraph< LocalOrdinal, GlobalOrdinal, Node > > getCrsGraph() const
Returns the CrsGraph associated with this matrix.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:282
Xpetra::TpetraBlockCrsMatrix::getDomainMap
const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getDomainMap() const
Returns the Map associated with the domain of this operator. This will be null until fillComplete() i...
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:492
Xpetra::TpetraBlockCrsMatrix::getRangeMap
const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getRangeMap() const
Returns the Map associated with the range of this operator, which must be compatible with Y....
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:500
Xpetra::TpetraBlockCrsMatrix::getLocalNumEntries
size_t getLocalNumEntries() const
Returns the local number of entries in this matrix.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:334
Xpetra::TpetraBlockCrsMatrix::fillComplete
void fillComplete(const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &domainMap, const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rangeMap, const RCP< ParameterList > &params=null)
Signal that data entry is complete, specifying domain and range maps.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:230
Xpetra::TpetraBlockCrsMatrix::getFrobeniusNorm
ScalarTraits< Scalar >::magnitudeType getFrobeniusNorm() const
Returns the Frobenius norm of the matrix.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:392
Xpetra::TpetraBlockCrsMatrix::GetStorageBlockSize
LocalOrdinal GetStorageBlockSize() const
Returns the block size of the storage mechanism.
Definition Xpetra_TpetraBlockCrsMatrix_decl.hpp:355
Xpetra::TpetraBlockCrsMatrix::resumeFill
void resumeFill(const RCP< ParameterList > &params=null)
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:224
Xpetra::TpetraBlockCrsMatrix::doImport
void doImport(const DistObject< char, LocalOrdinal, GlobalOrdinal, Node > &source, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)
Import.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:616
Xpetra::TpetraBlockCrsMatrix::mtx_
RCP< Tpetra::BlockCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > mtx_
Definition Xpetra_TpetraBlockCrsMatrix_decl.hpp:367
Xpetra::TpetraBlockCrsMatrix::getGlobalNumCols
global_size_t getGlobalNumCols() const
Number of global columns in the matrix.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:302
Xpetra::TpetraBlockCrsMatrix::getNumEntriesInGlobalRow
size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const
Returns the current number of entries in the (locally owned) global row.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:350
Xpetra::TpetraBlockCrsMatrix::isFillComplete
bool isFillComplete() const
Returns true if the matrix is in compute mode, i.e. if fillComplete() has been called.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:380
Xpetra::TpetraBlockCrsMatrix::replaceLocalValues
void replaceLocalValues(LocalOrdinal localRow, const ArrayView< const LocalOrdinal > &cols, const ArrayView< const Scalar > &vals)
Replace matrix entries, using local IDs.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:166
Xpetra::TpetraBlockCrsMatrix::getGlobalRowCopy
void getGlobalRowCopy(GlobalOrdinal GlobalRow, const ArrayView< GlobalOrdinal > &indices, const ArrayView< Scalar > &values, size_t &numEntries) const
Extract a list of entries in a specified global row of this matrix. Put into pre-allocated storage.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:448
Xpetra::TpetraBlockCrsMatrix::expertStaticFillComplete
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)
Expert static fill complete.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:251
Xpetra::TpetraBlockCrsMatrix::doExport
void doExport(const DistObject< char, LocalOrdinal, GlobalOrdinal, Node > &dest, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)
Export.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:624
Xpetra::TpetraBlockCrsMatrix::replaceGlobalValues
void replaceGlobalValues(GlobalOrdinal globalRow, const ArrayView< const GlobalOrdinal > &cols, const ArrayView< const Scalar > &vals)
Replace matrix entries, using global IDs (not implemented)
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:157
Xpetra::TpetraBlockCrsMatrix::isFillActive
bool isFillActive() const
Returns true if the matrix is in edit mode.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:386
Xpetra::TpetraBlockCrsMatrix::residual
void residual(const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &R) const
Compute a residual R = B - (*this) * X.
Definition Xpetra_TpetraBlockCrsMatrix_decl.hpp:358
Xpetra::TpetraBlockCrsMatrix::describe
void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
Print the object with some verbosity level to an FancyOStream object.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:515
Xpetra::TpetraBlockCrsMatrix::replaceDomainMapAndImporter
void replaceDomainMapAndImporter(const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &newDomainMap, Teuchos::RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > &newImporter)
Replaces the current domainMap and importer with the user-specified objects.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:244
Xpetra::TpetraBlockCrsMatrix::getLocalMaxNumRowEntries
size_t getLocalMaxNumRowEntries() const
Returns the maximum number of entries across all rows/columns on this node.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:362
Xpetra::TpetraBlockCrsMatrix::getTpetra_BlockCrsMatrixNonConst
RCP< Tpetra::BlockCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getTpetra_BlockCrsMatrixNonConst() const
Get the underlying Tpetra matrix.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:673
Xpetra::TpetraBlockCrsMatrix::getGlobalRowView
void getGlobalRowView(GlobalOrdinal GlobalRow, ArrayView< const GlobalOrdinal > &indices, ArrayView< const Scalar > &values) const
Extract a const, non-persisting view of global indices in a specified row of the matrix.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:434
Xpetra::TpetraBlockCrsMatrix::getLocalRowView
void getLocalRowView(LocalOrdinal LocalRow, ArrayView< const LocalOrdinal > &indices, ArrayView< const Scalar > &values) const
Extract a const, non-persisting view of local indices in a specified row of the matrix.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:421
Xpetra::TpetraBlockCrsMatrix::getMap
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getMap() const
Implements DistObject interface.
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:608
Xpetra::TpetraBlockCrsMatrix::removeEmptyProcessesInPlace
void removeEmptyProcessesInPlace(const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &newMap)
Definition Xpetra_TpetraBlockCrsMatrix_def.hpp:647
Teuchos::EVerbosityLevel
EVerbosityLevel
Xpetra::global_size_t
size_t global_size_t
Global size_t object.
Definition Xpetra_ConfigDefs.hpp:138
Xpetra::CombineMode
CombineMode
Xpetra::Combine Mode enumerable type.
Definition Xpetra_ConfigDefs.hpp:176