49 #ifndef XPETRA_MATRIX_HPP
50 #define XPETRA_MATRIX_HPP
52 #include <Tpetra_KokkosCompat_DefaultNode.hpp>
57 #include "Xpetra_MultiVector.hpp"
63 #include "Xpetra_StridedMap.hpp"
64 #include "Xpetra_StridedMapFactory.hpp"
66 #include <Teuchos_SerialDenseMatrix.hpp>
67 #include <Teuchos_Hashtable.hpp>
93 template <
class Scalar,
96 class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
97 class Matrix :
public Xpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal, Node> {
110 #ifdef HAVE_XPETRA_TPETRA
128 RCP<MatrixView> view = rcp(
new MatrixView(rowMap, colMap));
133 void CreateView(
const viewLabel_t viewLabel,
const RCP<const Matrix> &A,
bool transposeA =
false,
const RCP<const Matrix> &B = Teuchos::null,
bool transposeB =
false) {
134 RCP<const Map> domainMap = Teuchos::null;
135 RCP<const Map> rangeMap = Teuchos::null;
137 const size_t blkSize = 1;
138 std::vector<size_t> stridingInfo(1, blkSize);
139 LocalOrdinal stridedBlockId = -1;
141 if (A->IsView(viewLabel)) {
142 rangeMap = transposeA ? A->getColMap(viewLabel) : A->getRowMap(viewLabel);
143 domainMap = transposeA ? A->getRowMap(viewLabel) : A->getColMap(viewLabel);
146 rangeMap = transposeA ? A->getDomainMap() : A->getRangeMap();
147 domainMap = transposeA ? A->getRangeMap() : A->getDomainMap();
149 if (viewLabel ==
"stridedMaps") {
155 if (B != Teuchos::null) {
158 if (B->IsView(viewLabel)) {
159 domainMap = transposeB ? B->getRowMap(viewLabel) : B->getColMap(viewLabel);
162 domainMap = transposeB ? B->getRangeMap() : B->getDomainMap();
164 if (viewLabel ==
"stridedMaps")
177 int last = out.getOutputToRootOnly();
178 Teuchos::OSTab tab(out);
179 out.setOutputToRootOnly(0);
180 Teuchos::Array<viewLabel_t> viewLabels;
181 Teuchos::Array<RCP<MatrixView> > viewList;
183 out <<
"views associated with this operator" << std::endl;
184 for (
int i = 0; i < viewLabels.size(); ++i)
185 out << viewLabels[i] << std::endl;
186 out.setOutputToRootOnly(last);
229 virtual void insertGlobalValues(GlobalOrdinal globalRow,
const ArrayView<const GlobalOrdinal> &cols,
const ArrayView<const Scalar> &vals) = 0;
239 virtual void insertLocalValues(LocalOrdinal localRow,
const ArrayView<const LocalOrdinal> &cols,
const ArrayView<const Scalar> &vals) = 0;
248 const ArrayView<const GlobalOrdinal> &cols,
249 const ArrayView<const Scalar> &vals) = 0;
256 const ArrayView<const LocalOrdinal> &cols,
257 const ArrayView<const Scalar> &vals) = 0;
263 virtual void scale(
const Scalar &alpha) = 0;
278 virtual void resumeFill(
const RCP<ParameterList> ¶ms = null) = 0;
291 virtual void fillComplete(
const RCP<const Map> &domainMap,
const RCP<const Map> &rangeMap,
const RCP<ParameterList> ¶ms = null) = 0;
307 virtual void fillComplete(
const RCP<ParameterList> ¶ms = null) = 0;
393 const ArrayView<LocalOrdinal> &Indices,
394 const ArrayView<Scalar> &Values,
395 size_t &NumEntries)
const = 0;
407 virtual void getGlobalRowView(GlobalOrdinal GlobalRow, ArrayView<const GlobalOrdinal> &indices, ArrayView<const Scalar> &values)
const = 0;
419 virtual void getLocalRowView(LocalOrdinal LocalRow, ArrayView<const LocalOrdinal> &indices, ArrayView<const Scalar> &values)
const = 0;
427 virtual typename ScalarTraits<Scalar>::magnitudeType
getFrobeniusNorm()
const = 0;
444 virtual const Teuchos::RCP<const Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node> >
getMap()
const = 0;
476 virtual void describe(Teuchos::FancyOStream &out,
const Teuchos::EVerbosityLevel verbLevel = Teuchos::Describable::verbLevel_default)
const = 0;
490 virtual RCP<const CrsGraph>
getCrsGraph()
const = 0;
498 Teuchos::ETransp mode,
501 bool sumInterfaceValues,
503 const Teuchos::ArrayRCP<LocalOrdinal> ®ionInterfaceLIDs)
const = 0;
516 std::vector<size_t> stridingInfo;
517 stridingInfo.push_back(Teuchos::as<size_t>(blksize));
518 LocalOrdinal stridedBlockId = -1;
532 CreateView(
"stridedMaps", stridedRangeMap, stridedDomainMap);
541 TEUCHOS_TEST_FOR_EXCEPTION(rangeMap == Teuchos::null,
Exceptions::BadCast,
"Xpetra::Matrix::GetFixedBlockSize(): rangeMap is not of type StridedMap");
542 TEUCHOS_TEST_FOR_EXCEPTION(domainMap == Teuchos::null,
Exceptions::BadCast,
"Xpetra::Matrix::GetFixedBlockSize(): domainMap is not of type StridedMap");
543 TEUCHOS_TEST_FOR_EXCEPTION(domainMap->getFixedBlockSize() != rangeMap->getFixedBlockSize(),
Exceptions::RuntimeError,
"Xpetra::Matrix::GetFixedBlockSize(): block size of rangeMap and domainMap are different.");
544 return Teuchos::as<LocalOrdinal>(domainMap->getFixedBlockSize());
552 return IsView(
"stridedMaps");
571 #ifdef HAVE_XPETRA_TPETRA
576 #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."
596 #define XPETRA_MATRIX_SHORT
597 #endif // XPETRA_MATRIX_DECL_HPP
virtual void insertLocalValues(LocalOrdinal localRow, const ArrayView< const LocalOrdinal > &cols, const ArrayView< const Scalar > &vals)=0
Insert matrix entries, using local IDs.
virtual global_size_t getGlobalNumRows() const =0
Returns the number of global rows in this 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.
void RemoveView(const viewLabel_t viewLabel)
virtual global_size_t getGlobalNumCols() const =0
Returns the number of global columns in the matrix.
LocalOrdinal local_ordinal_type
virtual ScalarTraits< Scalar >::magnitudeType getFrobeniusNorm() const =0
Get Frobenius norm of the matrix.
virtual void resumeFill(const RCP< ParameterList > ¶ms=null)=0
virtual LocalOrdinal GetStorageBlockSize() const =0
Returns the block size of the storage mechanism, which is usually 1, except for Tpetra::BlockCrsMatri...
Exception throws to report errors in the internal logical of the program.
virtual size_t getGlobalMaxNumRowEntries() const =0
Returns the maximum number of entries across all rows/columns on all nodes.
Teuchos::Hashtable< viewLabel_t, RCP< MatrixView > > operatorViewTable_
virtual const Teuchos::RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getMap() const =0
Implements DistObject interface.
virtual bool isGloballyIndexed() const =0
If matrix indices are in the global range, this function returns true. Otherwise, this function retur...
virtual void doExport(const Matrix &dest, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)=0
Export.
virtual const RCP< const Map > & getColMap() const
Returns the Map that describes the column distribution in this matrix. This might be null until fillC...
Exception indicating invalid cast attempted.
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 > > ®ionInterfaceImporter, const Teuchos::ArrayRCP< LocalOrdinal > ®ionInterfaceLIDs) const =0
Computes the matrix-multivector multiplication for region layout matrices.
virtual void SetMaxEigenvalueEstimate(Scalar const &sigma)
virtual void fillComplete(const RCP< const Map > &domainMap, const RCP< const Map > &rangeMap, const RCP< ParameterList > ¶ms=null)=0
Signal that data entry is complete, specifying domain and range maps.
Xpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > CrsMatrix
virtual void setObjectLabel(const std::string &objectLabel)=0
virtual ~Matrix()
Destructor.
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 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 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...
viewLabel_t defaultViewLabel_
virtual void insertGlobalValues(GlobalOrdinal globalRow, const ArrayView< const GlobalOrdinal > &cols, const ArrayView< const Scalar > &vals)=0
Insert matrix entries, using global IDs.
void SetFixedBlockSize(LocalOrdinal blksize, GlobalOrdinal offset=0)
virtual bool haveGlobalConstants() const =0
Returns true if globalConstants have been computed; false otherwise.
virtual size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const =0
Returns the current number of entries in the specified global row.
virtual void rightScale(const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x)=0
Right scale matrix using the given vector entries.
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.
bool IsView(const viewLabel_t viewLabel) const
const viewLabel_t & GetCurrentViewLabel() const
Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > Map
virtual size_t getLocalNumEntries() const =0
Returns the local number of entries in this matrix.
virtual bool isFillComplete() const =0
Returns true if fillComplete() has been called and the matrix is in compute mode. ...
void CreateView(viewLabel_t viewLabel, const RCP< const Map > &rowMap, const RCP< const Map > &colMap)
virtual void replaceLocalValues(LocalOrdinal localRow, const ArrayView< const LocalOrdinal > &cols, const ArrayView< const Scalar > &vals)=0
Replace matrix entries, using local IDs.
virtual const RCP< const Map > & getColMap(viewLabel_t viewLabel) const
Returns the Map that describes the column distribution in this matrix.
viewLabel_t currentViewLabel_
const viewLabel_t SwitchToDefaultView()
virtual void leftScale(const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x)=0
Left scale matrix using the given vector entries.
virtual const Teuchos::RCP< const map_type > getRangeMap() const =0
The Map associated with the range of this operator, which must be compatible with Y...
void PrintViews(Teuchos::FancyOStream &out) const
Print all of the views associated with the Matrix.
LocalOrdinal GetFixedBlockSize() const
virtual size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const =0
Returns the current number of entries on this node in the specified local row.
Xpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node > CrsGraph
size_t global_size_t
Global size_t object.
virtual size_t getLocalNumRows() const =0
Returns the number of matrix rows owned on the calling node.
virtual void replaceGlobalValues(GlobalOrdinal globalRow, const ArrayView< const GlobalOrdinal > &cols, const ArrayView< const Scalar > &vals)=0
Replace matrix entries, using global IDs.
virtual void doImport(const Matrix &source, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)=0
Import.
virtual RCP< const CrsGraph > getCrsGraph() const =0
Returns the CrsGraph associated with this matrix.
CrsMatrix::local_matrix_type local_matrix_type
virtual std::string description() const =0
Return a simple one-line description of this object.
virtual bool isLocallyIndexed() const =0
If matrix indices are in the local range, this function returns true. Otherwise, this function return...
virtual Scalar GetMaxEigenvalueEstimate() const
virtual local_matrix_type::HostMirror getLocalMatrixHost() const =0
bool IsFixedBlockSizeSet() const
Returns true, if SetFixedBlockSize has been called before.
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 global_size_t getGlobalNumEntries() const =0
Returns the global number of entries in this matrix.
virtual const Teuchos::RCP< const map_type > getDomainMap() const =0
The Map associated with the domain of this operator, which must be compatible with X...
virtual size_t getLocalMaxNumRowEntries() const =0
Returns the maximum number of entries across all rows/columns on this node.
CombineMode
Xpetra::Combine Mode enumerable type.
static RCP< Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node > > Build(UnderlyingLib lib, global_size_t numGlobalElements, GlobalOrdinal indexBase, std::vector< size_t > &stridingInfo, const Teuchos::RCP< const Teuchos::Comm< int >> &comm, LocalOrdinal stridedBlockId=-1, GlobalOrdinal offset=0, LocalGlobal lg=Xpetra::GloballyDistributed)
Map constructor with Xpetra-defined contiguous uniform distribution.
virtual const RCP< const Map > & getRowMap() const
Returns the Map that describes the row distribution in this matrix.
void CreateView(const viewLabel_t viewLabel, const RCP< const Matrix > &A, bool transposeA=false, const RCP< const Matrix > &B=Teuchos::null, bool transposeB=false)
virtual void scale(const Scalar &alpha)=0
Scale the current values of a matrix, this = alpha*this.
const viewLabel_t & GetDefaultViewLabel() const
Xpetra::MatrixView< Scalar, LocalOrdinal, GlobalOrdinal, Node > MatrixView
virtual const RCP< const Map > & getRowMap(viewLabel_t viewLabel) const
Returns the Map that describes the row distribution in this matrix.
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 void setAllToScalar(const Scalar &alpha)=0
Set all matrix entries equal to scalar.
Xpetra::CrsMatrixFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > CrsMatrixFactory
virtual local_matrix_type getLocalMatrixDevice() const =0
Xpetra-specific matrix class.
Class that stores a strided map.
const viewLabel_t SwitchToView(const viewLabel_t viewLabel)
virtual bool hasCrsGraph() const =0
Supports the getCrsGraph() call.
GlobalOrdinal global_ordinal_type