49 #ifndef XPETRA_MATRIX_HPP 50 #define XPETRA_MATRIX_HPP 93 template <class Scalar = Operator<>::scalar_type,
97 class Matrix :
public Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > {
110 #ifdef HAVE_XPETRA_KOKKOS_REFACTOR 111 typedef typename CrsMatrix::local_matrix_type local_matrix_type;
137 const size_t blkSize = 1;
138 std::vector<size_t> stridingInfo(1, blkSize);
139 LocalOrdinal stridedBlockId = -1;
142 if (A->IsView(viewLabel)) {
143 rangeMap = transposeA ? A->getColMap(viewLabel) : A->getRowMap(viewLabel);
144 domainMap = transposeA ? A->getRowMap(viewLabel) : A->getColMap(viewLabel);
147 rangeMap = transposeA ? A->getDomainMap() : A->getRangeMap();
148 domainMap = transposeA ? A->getRangeMap() : A->getDomainMap();
150 if (viewLabel ==
"stridedMaps") {
156 if (B != Teuchos::null ) {
159 if (B->IsView(viewLabel)) {
160 domainMap = transposeB ? B->getRowMap(viewLabel) : B->getColMap(viewLabel);
163 domainMap = transposeB ? B->getRangeMap() : B->getDomainMap();
165 if (viewLabel ==
"stridedMaps")
185 out <<
"views associated with this operator" << std::endl;
186 for (
int i=0; i<viewLabels.
size(); ++i)
187 out << viewLabels[i] << std::endl;
205 bool IsView(
const viewLabel_t viewLabel)
const {
266 virtual void scale(
const Scalar &alpha)= 0;
526 std::vector<size_t> stridingInfo;
527 stridingInfo.push_back(Teuchos::as<size_t>(blksize));
528 LocalOrdinal stridedBlockId = -1;
544 CreateView(
"stridedMaps", stridedRangeMap, stridedDomainMap);
550 if(
IsView(
"stridedMaps")==
true) {
554 TEUCHOS_TEST_FOR_EXCEPTION(domainMap == Teuchos::null,
Exceptions::BadCast,
"Xpetra::Matrix::GetFixedBlockSize(): domainMap is not of type StridedMap");
555 TEUCHOS_TEST_FOR_EXCEPTION(domainMap->getFixedBlockSize() != rangeMap->getFixedBlockSize(),
Exceptions::RuntimeError,
"Xpetra::Matrix::GetFixedBlockSize(): block size of rangeMap and domainMap are different.");
556 return Teuchos::as<LocalOrdinal>(domainMap->getFixedBlockSize());
575 #ifdef HAVE_XPETRA_KOKKOS_REFACTOR 576 virtual local_matrix_type getLocalMatrix ()
const = 0;
591 #define XPETRA_MATRIX_SHORT 592 #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 size_t getNodeMaxNumRowEntries() const =0
Returns the maximum number of entries across all rows/columns on this node.
virtual size_t getNodeNumRows() const =0
Returns the number of matrix rows owned on the calling node.
virtual size_t getNodeNumEntries() const =0
Returns the local number of entries in this matrix.
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.
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
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
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 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.
Node node_type
The Kokkos Node type.
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.
GlobalOrdinal global_ordinal_type
The global index type.
virtual const Teuchos::RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getMap() const =0
Multiplies this matrix by a MultiVector.
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 ~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 idices.
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)
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
virtual global_size_t getGlobalNumDiags() const =0
Returns the number of global diagonal entries, based on global row/column index comparisons.
LocalOrdinal local_ordinal_type
The local index type.
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 bool isFillComplete() const =0
Returns true if fillComplete() has been called and the matrix is in compute mode. ...
static RCP< StridedMap > 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, const Teuchos::RCP< Node > &node=defaultArgNode())
Map constructor with Xpetra-defined contiguous uniform distribution.
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()
basic_FancyOStream & setOutputToRootOnly(const int rootRank)
int getOutputToRootOnly() const
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 void replaceGlobalValues(GlobalOrdinal globalRow, const ArrayView< const GlobalOrdinal > &cols, const ArrayView< const Scalar > &vals)=0
Replace matrix entries, using global IDs.
static const EVerbosityLevel verbLevel_default
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.
virtual size_t getNodeNumDiags() const =0
Returns the number of local diagonal entries, based on global row/column index comparisons.
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 global_size_t getGlobalNumEntries() const =0
Returns the global number of entries in this matrix.
virtual Teuchos::RCP< const Map > getRangeMap() const =0
The Map associated with the range of this operator, which must be compatible with Y...
CombineMode
Xpetra::Combine Mode enumerable type.
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.
virtual void setAllToScalar(const Scalar &alpha)=0
Set all matrix entries equal to scalar.
virtual Teuchos::RCP< const Map > getDomainMap() const =0
The Map associated with the domain of this operator, which must be compatible with X...
Xpetra::CrsMatrixFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > CrsMatrixFactory
Xpetra-specific matrix class.
Class that stores a strided map.
const viewLabel_t SwitchToView(const viewLabel_t viewLabel)
GlobalOrdinal global_ordinal_type