#include <Xpetra_BlockedCrsMatrix.hpp>
Public Types | |
| typedef Scalar | scalar_type |
| typedef LocalOrdinal | local_ordinal_type |
| typedef GlobalOrdinal | global_ordinal_type |
| typedef Node | node_type |
 Public Types inherited from Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType > | |
| typedef Scalar | scalar_type |
| typedef LocalOrdinal | local_ordinal_type |
| typedef GlobalOrdinal | global_ordinal_type |
| typedef KokkosClassic::DefaultNode::DefaultNodeType | node_type |
| Public Types inherited from Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType > | |
| typedef Scalar | scalar_type |
| The type of the entries of the input and output multivectors. More... | |
| typedef LocalOrdinal | local_ordinal_type |
| The local index type. More... | |
| typedef GlobalOrdinal | global_ordinal_type |
| The global index type. More... | |
| typedef KokkosClassic::DefaultNode::DefaultNodeType | node_type |
| The Kokkos Node type. More... | |
helper functions | |
| bool | is_diagonal_ |
| If we're diagonal, a bunch of the extraction stuff should work. More... | |
| Teuchos::RCP< const MapExtractor > | domainmaps_ |
| full domain map together with all partial domain maps More... | |
| Teuchos::RCP< const MapExtractor > | rangemaps_ |
| full range map together with all partial domain maps More... | |
| std::vector< Teuchos::RCP< Matrix > > | blocks_ |
| row major matrix block storage More... | |
| bool | bRangeThyraMode_ |
| boolean flag, which is true, if BlockedCrsMatrix has been created using Thyra-style numbering for sub blocks, i.e. all GIDs of submaps are contiguous and start from 0. More... | |
| bool | bDomainThyraMode_ |
| boolean flag, which is true, if BlockedCrsMatrix has been created using Thyra-style numbering for sub blocks, i.e. all GIDs of submaps are contiguous and start from 0. More... | |
| void | Add (const Matrix &A, const Scalar scalarA, Matrix &B, const Scalar scalarB) const |
| Add a Xpetra::CrsMatrix to another: B = B*scalarB + A*scalarA. More... | |
| void | CreateDefaultView () |
Constructor/Destructor Methods | |
| BlockedCrsMatrix (const Teuchos::RCP< const BlockedMap > &rangeMaps, const Teuchos::RCP< const BlockedMap > &domainMaps, size_t numEntriesPerRow) | |
| Constructor. More... | |
| BlockedCrsMatrix (Teuchos::RCP< const MapExtractor > &rangeMapExtractor, Teuchos::RCP< const MapExtractor > &domainMapExtractor, size_t numEntriesPerRow) | |
| Constructor. More... | |
| virtual | ~BlockedCrsMatrix () |
| Destructor. More... | |
Insertion/Removal Methods | |
| void | insertGlobalValues (GlobalOrdinal globalRow, const ArrayView< const GlobalOrdinal > &cols, const ArrayView< const Scalar > &vals) |
| Insert matrix entries, using global IDs. More... | |
| void | insertLocalValues (LocalOrdinal localRow, const ArrayView< const LocalOrdinal > &cols, const ArrayView< const Scalar > &vals) |
| Insert matrix entries, using local IDs. More... | |
| void | removeEmptyProcessesInPlace (const Teuchos::RCP< const Map > &newMap) |
| void | replaceGlobalValues (GlobalOrdinal globalRow, const ArrayView< const GlobalOrdinal > &cols, const ArrayView< const Scalar > &vals) |
| Replace matrix entries, using global IDs. More... | |
| void | replaceLocalValues (LocalOrdinal localRow, const ArrayView< const LocalOrdinal > &cols, const ArrayView< const Scalar > &vals) |
| Replace matrix entries, using local IDs. More... | |
| virtual void | setAllToScalar (const Scalar &alpha) |
| Set all matrix entries equal to scalar. More... | |
| void | scale (const Scalar &alpha) |
| Scale the current values of a matrix, this = alpha*this. More... | |
Transformational Methods | |
| void | resumeFill (const RCP< ParameterList > ¶ms=null) |
| void | fillComplete (const RCP< const Map > &domainMap, const RCP< const Map > &rangeMap, const RCP< ParameterList > ¶ms=null) |
| Signal that data entry is complete. More... | |
| void | fillComplete (const RCP< ParameterList > ¶ms=null) |
| Signal that data entry is complete. More... | |
| global_size_t | getGlobalNumRows () const |
| Returns the number of global rows. More... | |
| global_size_t | getGlobalNumCols () const |
| Returns the number of global columns in the matrix. More... | |
| size_t | getNodeNumRows () const |
| Returns the number of matrix rows owned on the calling node. More... | |
| global_size_t | getGlobalNumEntries () const |
| Returns the global number of entries in this matrix. More... | |
| size_t | getNodeNumEntries () const |
| Returns the local number of entries in this matrix. More... | |
| size_t | getNumEntriesInLocalRow (LocalOrdinal localRow) const |
| Returns the current number of entries on this node in the specified local row. More... | |
| size_t | getNumEntriesInGlobalRow (GlobalOrdinal globalRow) const |
| Returns the current number of entries in the specified (locally owned) global row. More... | |
| size_t | getGlobalMaxNumRowEntries () const |
| Returns the maximum number of entries across all rows/columns on all nodes. More... | |
| size_t | getNodeMaxNumRowEntries () const |
| Returns the maximum number of entries across all rows/columns on this node. More... | |
| bool | isLocallyIndexed () const |
| If matrix indices of all matrix blocks are in the local range, this function returns true. Otherwise, this function returns false. More... | |
| bool | isGloballyIndexed () const |
| If matrix indices are in the global range, this function returns true. Otherwise, this function returns false. More... | |
| bool | isFillComplete () const |
Returns true if fillComplete() has been called and the matrix is in compute mode. More... | |
| virtual 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 calling routine. More... | |
| 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. More... | |
| 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. More... | |
| void | getLocalDiagCopy (Vector &diag) const |
| Get a copy of the diagonal entries owned by this node, with local row indices. More... | |
| void | leftScale (const Vector &x) |
| Left scale matrix using the given vector entries. More... | |
| void | rightScale (const Vector &x) |
| Right scale matrix using the given vector entries. More... | |
| virtual ScalarTraits< Scalar >::magnitudeType | getFrobeniusNorm () const |
| Get Frobenius norm of the matrix. More... | |
| virtual bool | haveGlobalConstants () const |
| Returns true if globalConstants have been computed; false otherwise. More... | |
Methods implementing Matrix | |
Multiplies this matrix by a MultiVector.
Both are required to have constant stride, and they are not permitted to ocupy overlapping space. No runtime checking will be performed in a non-debug build. This method is templated on the scalar type of MultiVector objects, allowing this method to be applied to MultiVector objects of arbitrary type. However, it is recommended that multiply() not be called directly; instead, use the CrsMatrixMultiplyOp, as it will handle the import/exprt operations required to apply a matrix with non-trivial communication needs. If | |
| virtual void | apply (const MultiVector &X, MultiVector &Y, Teuchos::ETransp mode, Scalar alpha, Scalar beta, bool sumInterfaceValues, const RCP< Xpetra::Import< LocalOrdinal, GlobalOrdinal, Node > > ®ionInterfaceImporter, const Teuchos::ArrayRCP< LocalOrdinal > ®ionInterfaceLIDs) const |
| sparse matrix-multivector multiplication for the region layout matrices (currently no blocked implementation) More... | |
| virtual void | apply (const MultiVector &X, MultiVector &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, Scalar alpha=ScalarTraits< Scalar >::one(), Scalar beta=ScalarTraits< Scalar >::zero()) const |
| Computes the sparse matrix-multivector multiplication. More... | |
| RCP< const Map > | getFullDomainMap () const |
| Returns the Map associated with the full domain of this operator. More... | |
| RCP< const BlockedMap > | getBlockedDomainMap () const |
| Returns the BlockedMap associated with the domain of this operator. More... | |
| RCP< const Map > | getDomainMap () const |
| Returns the Map associated with the domain of this operator. More... | |
| RCP< const Map > | getDomainMap (size_t i) const |
| Returns the Map associated with the i'th block domain of this operator. More... | |
| RCP< const Map > | getDomainMap (size_t i, bool bThyraMode) const |
| Returns the Map associated with the i'th block domain of this operator. More... | |
| RCP< const Map > | getFullRangeMap () const |
| Returns the Map associated with the full range of this operator. More... | |
| RCP< const BlockedMap > | getBlockedRangeMap () const |
| Returns the BlockedMap associated with the range of this operator. More... | |
| RCP< const Map > | getRangeMap () const |
| Returns the Map associated with the range of this operator. More... | |
| RCP< const Map > | getRangeMap (size_t i) const |
| Returns the Map associated with the i'th block range of this operator. More... | |
| RCP< const Map > | getRangeMap (size_t i, bool bThyraMode) const |
| Returns the Map associated with the i'th block range of this operator. More... | |
| RCP< const MapExtractor > | getRangeMapExtractor () const |
| Returns map extractor class for range map. More... | |
| RCP< const MapExtractor > | getDomainMapExtractor () const |
| Returns map extractor for domain map. More... | |
| virtual void | bgs_apply (const MultiVector &X, MultiVector &Y, size_t row, Teuchos::ETransp mode=Teuchos::NO_TRANS, Scalar alpha=ScalarTraits< Scalar >::one(), Scalar beta=ScalarTraits< Scalar >::zero()) const |
| Special multiplication routine (for BGS/Jacobi smoother) More... | |
| const Teuchos::RCP< const Map > | getMap () const |
| Implements DistObject interface. More... | |
| void | doImport (const Matrix &source, const Import &importer, CombineMode CM) |
| Import. More... | |
| void | doExport (const Matrix &dest, const Import &importer, CombineMode CM) |
| Export. More... | |
| void | doImport (const Matrix &source, const Export &exporter, CombineMode CM) |
| Import (using an Exporter). More... | |
| void | doExport (const Matrix &dest, const Export &exporter, CombineMode CM) |
| Export (using an Importer). More... | |
Overridden from Teuchos::Describable | |
| std::string | description () const |
| Return a simple one-line description of this object. More... | |
| 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. More... | |
Overridden from Teuchos::LabeledObject | |
| void | setObjectLabel (const std::string &objectLabel) |
| bool | hasCrsGraph () const |
| Supports the getCrsGraph() call. More... | |
| RCP< const CrsGraph > | getCrsGraph () const |
| Returns the CrsGraph associated with this matrix. More... | |
Block matrix access | |
| virtual bool | isDiagonal () const |
| virtual size_t | Rows () const |
| number of row blocks More... | |
| virtual size_t | Cols () const |
| number of column blocks More... | |
| Teuchos::RCP< Matrix > | getCrsMatrix () const |
| return unwrap 1x1 blocked operators More... | |
| Teuchos::RCP< Matrix > | getInnermostCrsMatrix () |
| helper routine recursively returns the first inner-most non-null matrix block from a (nested) blocked operator More... | |
| Teuchos::RCP< Matrix > | getMatrix (size_t r, size_t c) const |
| return block (r,c) More... | |
| void | setMatrix (size_t r, size_t c, Teuchos::RCP< Matrix > mat) |
| set matrix block More... | |
| Teuchos::RCP< Matrix > | Merge () const |
| merge BlockedCrsMatrix blocks in a CrsMatrix More... | |
| void | residual (const MultiVector &X, const MultiVector &B, MultiVector &R) const |
| Compute a residual R = B - (*this) * X. More... | |
Additional Inherited Members | |
| Public Member Functions inherited from Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType > | |
| virtual void | apply (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType > &X, MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType > &Y, Teuchos::ETransp mode, Scalar alpha, Scalar beta, bool sumInterfaceValues, const RCP< Import< LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType > > ®ionInterfaceImporter, const Teuchos::ArrayRCP< LocalOrdinal > ®ionInterfaceLIDs) const=0 |
| Computes the matrix-multivector multiplication for region layout matrices. More... | |
| void | SetFixedBlockSize (LocalOrdinal blksize, GlobalOrdinal offset=0) |
| LocalOrdinal | GetFixedBlockSize () const |
| bool | IsFixedBlockSizeSet () const |
Returns true, if SetFixedBlockSize has been called before. More... | |
| virtual void | SetMaxEigenvalueEstimate (Scalar const &sigma) |
| virtual Scalar | GetMaxEigenvalueEstimate () const |
| virtual void | residual (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType > &X, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType > &B, MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType > &R) const=0 |
| Compute a residual R = B - (*this) * X. More... | |
| Matrix () | |
| virtual | ~Matrix () |
| Destructor. More... | |
| void | CreateView (viewLabel_t viewLabel, const RCP< const Map > &rowMap, const RCP< const Map > &colMap) |
| void | CreateView (const viewLabel_t viewLabel, const RCP< const Matrix > &A, bool transposeA=false, const RCP< const Matrix > &B=Teuchos::null, bool transposeB=false) |
| void | PrintViews (Teuchos::FancyOStream &out) const |
| Print all of the views associated with the Matrix. More... | |
| void | RemoveView (const viewLabel_t viewLabel) |
| const viewLabel_t | SwitchToView (const viewLabel_t viewLabel) |
| bool | IsView (const viewLabel_t viewLabel) const |
| const viewLabel_t | SwitchToDefaultView () |
| const viewLabel_t & | GetDefaultViewLabel () const |
| const viewLabel_t & | GetCurrentViewLabel () const |
| virtual const RCP< const Map > & | getRowMap () const |
| Returns the Map that describes the row distribution in this matrix. More... | |
| virtual const RCP< const Map > & | getRowMap (viewLabel_t viewLabel) const |
| Returns the Map that describes the row distribution in this matrix. More... | |
| virtual const RCP< const Map > & | getColMap () const |
Returns the Map that describes the column distribution in this matrix. This might be null until fillComplete() is called. More... | |
| virtual const RCP< const Map > & | getColMap (viewLabel_t viewLabel) const |
| Returns the Map that describes the column distribution in this matrix. More... | |
| virtual void | getLocalDiagCopy (Vector< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType > &diag) const=0 |
| Get a copy of the diagonal entries owned by this node, with local row indices. More... | |
| virtual void | leftScale (const Vector< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType > &x)=0 |
| Left scale matrix using the given vector entries. More... | |
| virtual void | rightScale (const Vector< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType > &x)=0 |
| Right scale matrix using the given vector entries. More... | |
| virtual void | doImport (const Matrix &source, const Import< LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType > &importer, CombineMode CM)=0 |
| Import. More... | |
| virtual void | doImport (const Matrix &source, const Export< LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType > &exporter, CombineMode CM)=0 |
| Import (using an Exporter). More... | |
| virtual void | doExport (const Matrix &dest, const Import< LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType > &importer, CombineMode CM)=0 |
| Export. More... | |
| virtual void | doExport (const Matrix &dest, const Export< LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType > &exporter, CombineMode CM)=0 |
| Export (using an Importer). More... | |
| Public Member Functions inherited from Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType > | |
| virtual | ~Operator () |
| virtual bool | hasTransposeApply () const |
| Whether this operator supports applying the transpose or conjugate transpose. More... | |
| Public Member Functions inherited from Teuchos::Describable | |
| virtual std::string | description () const |
| virtual void | describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const |
| void | describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const |
| virtual | ~Describable () |
| DescribableStreamManipulatorState | describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default) |
| std::ostream & | operator<< (std::ostream &os, const DescribableStreamManipulatorState &d) |
| virtual std::string | description () const |
| virtual void | describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const |
| void | describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const |
| virtual | ~Describable () |
| Public Member Functions inherited from Teuchos::LabeledObject | |
| LabeledObject () | |
| virtual | ~LabeledObject () |
| virtual void | setObjectLabel (const std::string &objectLabel) |
| virtual std::string | getObjectLabel () const |
| Static Public Attributes inherited from Teuchos::Describable | |
| static const EVerbosityLevel | verbLevel_default |
| Protected Attributes inherited from Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType > | |
| Teuchos::Hashtable< viewLabel_t, RCP< MatrixView > > | operatorViewTable_ |
| viewLabel_t | defaultViewLabel_ |
| viewLabel_t | currentViewLabel_ |
Detailed Description
class Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >
Definition at line 97 of file Xpetra_BlockedCrsMatrix.hpp.
Member Typedef Documentation
◆ scalar_type
| typedef Scalar Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::scalar_type |
Definition at line 100 of file Xpetra_BlockedCrsMatrix.hpp.
◆ local_ordinal_type
| typedef LocalOrdinal Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_ordinal_type |
Definition at line 101 of file Xpetra_BlockedCrsMatrix.hpp.
◆ global_ordinal_type
| typedef GlobalOrdinal Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::global_ordinal_type |
Definition at line 102 of file Xpetra_BlockedCrsMatrix.hpp.
◆ node_type
| typedef Node Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::node_type |
Definition at line 103 of file Xpetra_BlockedCrsMatrix.hpp.
Constructor & Destructor Documentation
◆ BlockedCrsMatrix() [1/2]
|
inline |
Constructor.
- Parameters
-
rangeMaps range maps for all blocks domainMaps domain maps for all blocks numEntriesPerRow estimated number of entries per row in each block(!)
Definition at line 120 of file Xpetra_BlockedCrsMatrix.hpp.
◆ BlockedCrsMatrix() [2/2]
|
inline |
Constructor.
- Parameters
-
rangeMapExtractor range map extractor for all blocks domainMapExtractor domain map extractor for all blocks numEntriesPerRow estimated number of entries per row in each block(!)
- Note
- This constructor will be deprecated. Please use the constructor which takes BlockedMap objects instead.
Definition at line 149 of file Xpetra_BlockedCrsMatrix.hpp.
◆ ~BlockedCrsMatrix()
|
inlinevirtual |
Destructor.
Definition at line 307 of file Xpetra_BlockedCrsMatrix.hpp.
Member Function Documentation
◆ insertGlobalValues()
|
inlinevirtual |
Insert matrix entries, using global IDs.
Note: this routine throws for Rows() > 1 and/or Cols() > 1
All index values must be in the global space.
- Precondition
globalRowexists as an ID in the global row map-
isLocallyIndexed() == false -
isStorageOptimized() == false
- Postcondition
isGloballyIndexed() == true
- Note
- If
globalRowdoes not belong to the matrix on this node, then it will be communicated to the appropriate node when globalAssemble() is called (which will, at the latest, occur during the next call to fillComplete().) Otherwise, the entries will be inserted in the local matrix. -
If the matrix row already contains values at the indices corresponding to values in
cols, then the new values will be summed with the old values; this may happen at insertion or during the next call to fillComplete(). -
If
hasColMap() == true, only (cols[i],vals[i]) where cols[i] belongs to the column map on this node will be inserted into the matrix.
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 341 of file Xpetra_BlockedCrsMatrix.hpp.
◆ insertLocalValues()
|
inlinevirtual |
Insert matrix entries, using local IDs.
Note: this routine throws if Rows() > 1 and/or Cols() > 1
All index values must be in the local space.
- Precondition
localRowexists as an ID in the local row map-
isGloballyIndexed() == false -
isStorageOptimized() == false
- Postcondition
isLocallyIndexed() == true
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 361 of file Xpetra_BlockedCrsMatrix.hpp.
◆ removeEmptyProcessesInPlace()
|
inlinevirtual |
Reimplemented from Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 370 of file Xpetra_BlockedCrsMatrix.hpp.
◆ replaceGlobalValues()
|
inlinevirtual |
Replace matrix entries, using global IDs.
All index values must be in the global space.
- Precondition
globalRowis a global row belonging to the matrix on this node.
- Note
- If (globalRow,cols[i]) corresponds to an entry that is duplicated in this matrix row (likely because it was inserted more than once and fillComplete() has not been called in the interim), the behavior of this function is not defined.
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 388 of file Xpetra_BlockedCrsMatrix.hpp.
◆ replaceLocalValues()
|
inlinevirtual |
Replace matrix entries, using local IDs.
All index values must be in the local space. Note that if a value is not already present for the specified location in the matrix, the input value will be ignored silently.
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 404 of file Xpetra_BlockedCrsMatrix.hpp.
◆ setAllToScalar()
|
inlinevirtual |
Set all matrix entries equal to scalar.
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 416 of file Xpetra_BlockedCrsMatrix.hpp.
◆ scale()
|
inlinevirtual |
Scale the current values of a matrix, this = alpha*this.
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 428 of file Xpetra_BlockedCrsMatrix.hpp.
◆ resumeFill()
|
inlinevirtual |
Resume fill operations. After calling fillComplete(), resumeFill() must be called before initiating any changes to the matrix.
For BlockedCrsMatrix objects we call the routine iteratively for all sub-blocks.
resumeFill() may be called repeatedly.
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 451 of file Xpetra_BlockedCrsMatrix.hpp.
◆ fillComplete() [1/2]
|
inlinevirtual |
Signal that data entry is complete.
Note: for blocked operators the specified domain and range maps have no meaning. We just call fillComplete for all underlying blocks
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 467 of file Xpetra_BlockedCrsMatrix.hpp.
◆ fillComplete() [2/2]
|
inlinevirtual |
Signal that data entry is complete.
Off-node entries are distributed (via globalAssemble()), repeated entries are summed, and global indices are transformed to local indices.
- Note
- This method calls fillComplete( getRowMap(), getRowMap(), os ).
- Precondition
isFillActive() == true-
isFillComplete()() == false
- Postcondition
isFillActive() == false-
isFillComplete() == true -
ifos == DoOptimizeStorage, thenisStorageOptimized() == true
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 490 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getGlobalNumRows()
|
inlinevirtual |
Returns the number of global rows.
Undefined if isFillActive().
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 550 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getGlobalNumCols()
|
inlinevirtual |
Returns the number of global columns in the matrix.
Undefined if isFillActive().
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 567 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getNodeNumRows()
|
inlinevirtual |
Returns the number of matrix rows owned on the calling node.
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 582 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getGlobalNumEntries()
|
inlinevirtual |
Returns the global number of entries in this matrix.
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 597 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getNodeNumEntries()
|
inlinevirtual |
Returns the local number of entries in this matrix.
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 610 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getNumEntriesInLocalRow()
|
inlinevirtual |
Returns the current number of entries on this node in the specified local row.
Returns OrdinalTraits<size_t>::invalid() if the specified local row is not valid for this matrix.
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 624 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getNumEntriesInGlobalRow()
|
inlinevirtual |
Returns the current number of entries in the specified (locally owned) global row.
Returns OrdinalTraits<size_t>::invalid() if the specified local row is not valid for this matrix.
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 638 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getGlobalMaxNumRowEntries()
|
inlinevirtual |
Returns the maximum number of entries across all rows/columns on all nodes.
Undefined if isFillActive().
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 651 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getNodeMaxNumRowEntries()
|
inlinevirtual |
Returns the maximum number of entries across all rows/columns on this node.
Undefined if isFillActive().
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 671 of file Xpetra_BlockedCrsMatrix.hpp.
◆ isLocallyIndexed()
|
inlinevirtual |
If matrix indices of all matrix blocks are in the local range, this function returns true. Otherwise, this function returns false.
if false, then this does not automatically mean that all blocks are globally indexed. The user has to make sure, that all matrix blocks are indexed in the same way (locally or globally). Otherwise the block matrix is not valid...
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 692 of file Xpetra_BlockedCrsMatrix.hpp.
◆ isGloballyIndexed()
|
inlinevirtual |
If matrix indices are in the global range, this function returns true. Otherwise, this function returns false.
if false, then this does not automatically mean that all blocks are locally indexed. The user has to make sure, that all matrix blocks are indexed in the same way (locally or globally). Otherwise the block matrix is not valid...
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 704 of file Xpetra_BlockedCrsMatrix.hpp.
◆ isFillComplete()
|
inlinevirtual |
Returns true if fillComplete() has been called and the matrix is in compute mode.
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 713 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getLocalRowCopy()
|
inlinevirtual |
Extract a list of entries in a specified local row of the matrix. Put into storage allocated by calling routine.
- Parameters
-
LocalRow - (In) Local row number for which indices are desired. Indices - (Out) Local column indices corresponding to values. Values - (Out) Matrix values. NumIndices - (Out) Number of indices.
Note: A std::runtime_error exception is thrown if either Indices or Values is not large enough to hold the data associated with row LocalRow. If LocalRow is not valid for this node, then Indices and Values are unchanged and NumIndices is returned as OrdinalTraits<size_t>::invalid().
- Precondition
isLocallyIndexed()==trueorhasColMap() == true
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 736 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getGlobalRowView()
|
inlinevirtual |
Extract a const, non-persisting view of global indices in a specified row of the matrix.
- Parameters
-
GlobalRow - (In) Global row number for which indices are desired. Indices - (Out) Global column indices corresponding to values. Values - (Out) Row values
- Precondition
isLocallyIndexed() == false
- Postcondition
indices.size() == getNumEntriesInGlobalRow(GlobalRow)
Note: If GlobalRow does not belong to this node, then indices is set to null.
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 758 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getLocalRowView()
|
inlinevirtual |
Extract a const, non-persisting view of local indices in a specified row of the matrix.
- Parameters
-
LocalRow - (In) Local row number for which indices are desired. Indices - (Out) Global column indices corresponding to values. Values - (Out) Row values
- Precondition
isGloballyIndexed() == false
- Postcondition
indices.size() == getNumEntriesInLocalRow(LocalRow)
Note: If LocalRow does not belong to this node, then indices is set to null.
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 777 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getLocalDiagCopy()
|
inline |
Get a copy of the diagonal entries owned by this node, with local row indices.
Returns a distributed Vector object partitioned according to this matrix's row map, containing the the zero and non-zero diagonals owned by this node.
Definition at line 796 of file Xpetra_BlockedCrsMatrix.hpp.
◆ leftScale()
|
inline |
Left scale matrix using the given vector entries.
Definition at line 831 of file Xpetra_BlockedCrsMatrix.hpp.
◆ rightScale()
|
inline |
Right scale matrix using the given vector entries.
Definition at line 869 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getFrobeniusNorm()
|
inlinevirtual |
Get Frobenius norm of the matrix.
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 908 of file Xpetra_BlockedCrsMatrix.hpp.
◆ haveGlobalConstants()
|
inlinevirtual |
Returns true if globalConstants have been computed; false otherwise.
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 924 of file Xpetra_BlockedCrsMatrix.hpp.
◆ apply() [1/2]
|
inlinevirtual |
sparse matrix-multivector multiplication for the region layout matrices (currently no blocked implementation)
Definition at line 958 of file Xpetra_BlockedCrsMatrix.hpp.
◆ apply() [2/2]
|
inlinevirtual |
Computes the sparse matrix-multivector multiplication.
Performs \(Y = \alpha A^{\textrm{mode}} X + \beta Y\), with one special exceptions:
- if
beta == 0, apply() overwritesY, so that any values inY(including NaNs) are ignored.
Implements Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Reimplemented in Xpetra::ReorderedBlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 967 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getFullDomainMap()
|
inline |
Returns the Map associated with the full domain of this operator.
Definition at line 1060 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getBlockedDomainMap()
|
inline |
Returns the BlockedMap associated with the domain of this operator.
Definition at line 1063 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getDomainMap() [1/3]
|
inlinevirtual |
Returns the Map associated with the domain of this operator.
Implements Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 1066 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getDomainMap() [2/3]
|
inline |
Returns the Map associated with the i'th block domain of this operator.
Definition at line 1069 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getDomainMap() [3/3]
|
inline |
Returns the Map associated with the i'th block domain of this operator.
Definition at line 1072 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getFullRangeMap()
|
inline |
Returns the Map associated with the full range of this operator.
Definition at line 1075 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getBlockedRangeMap()
|
inline |
Returns the BlockedMap associated with the range of this operator.
Definition at line 1078 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getRangeMap() [1/3]
|
inlinevirtual |
Returns the Map associated with the range of this operator.
Implements Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 1081 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getRangeMap() [2/3]
|
inline |
Returns the Map associated with the i'th block range of this operator.
Definition at line 1084 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getRangeMap() [3/3]
|
inline |
Returns the Map associated with the i'th block range of this operator.
Definition at line 1087 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getRangeMapExtractor()
|
inline |
Returns map extractor class for range map.
Definition at line 1090 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getDomainMapExtractor()
|
inline |
Returns map extractor for domain map.
Definition at line 1093 of file Xpetra_BlockedCrsMatrix.hpp.
◆ bgs_apply()
|
inlinevirtual |
Special multiplication routine (for BGS/Jacobi smoother)
Computes the sparse matrix-multivector multiplication (plus linear combination with input/result vector)
Performs \(Y = \alpha A^{\textrm{mode}} X + \beta Y\), with one special exception:
- if
beta == 0, apply() overwritesY, so that any values inY(including NaNs) are ignored. - calculates result only for blocked row "row"
- useful for BGS/Jacobi smoother in MueLu: there we have to calculate the residual for the current block row we can skip the MatVec calls in all other block rows
- Parameters
-
X Vector to be multiplied by matrix (input) Y result vector row Index of block row to be treated mode Transpose mode alpha scaling factor for result of matrix-vector product beta scaling factor for linear combination with result vector
Definition at line 1108 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getMap()
|
inlinevirtual |
Implements DistObject interface.
Access function for the Tpetra::Map this DistObject was constructed with.
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 1180 of file Xpetra_BlockedCrsMatrix.hpp.
◆ doImport() [1/2]
|
inline |
Definition at line 1189 of file Xpetra_BlockedCrsMatrix.hpp.
◆ doExport() [1/2]
|
inline |
Definition at line 1199 of file Xpetra_BlockedCrsMatrix.hpp.
◆ doImport() [2/2]
|
inline |
Import (using an Exporter).
Definition at line 1209 of file Xpetra_BlockedCrsMatrix.hpp.
◆ doExport() [2/2]
|
inline |
Export (using an Importer).
Definition at line 1219 of file Xpetra_BlockedCrsMatrix.hpp.
◆ description()
|
inlinevirtual |
Return a simple one-line description of this object.
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 1234 of file Xpetra_BlockedCrsMatrix.hpp.
◆ describe()
|
inlinevirtual |
Print the object with some verbosity level to an FancyOStream object.
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 1237 of file Xpetra_BlockedCrsMatrix.hpp.
◆ setObjectLabel()
|
inlinevirtual |
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 1268 of file Xpetra_BlockedCrsMatrix.hpp.
◆ hasCrsGraph()
|
inlinevirtual |
Supports the getCrsGraph() call.
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 1282 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getCrsGraph()
|
inlinevirtual |
Returns the CrsGraph associated with this matrix.
Implements Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 1288 of file Xpetra_BlockedCrsMatrix.hpp.
◆ isDiagonal()
|
inlinevirtual |
Definition at line 1301 of file Xpetra_BlockedCrsMatrix.hpp.
◆ Rows()
|
inlinevirtual |
number of row blocks
Definition at line 1304 of file Xpetra_BlockedCrsMatrix.hpp.
◆ Cols()
|
inlinevirtual |
number of column blocks
Definition at line 1307 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getCrsMatrix()
|
inline |
return unwrap 1x1 blocked operators
Definition at line 1310 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getInnermostCrsMatrix()
|
inline |
helper routine recursively returns the first inner-most non-null matrix block from a (nested) blocked operator
Definition at line 1322 of file Xpetra_BlockedCrsMatrix.hpp.
◆ getMatrix()
|
inline |
return block (r,c)
Definition at line 1340 of file Xpetra_BlockedCrsMatrix.hpp.
◆ setMatrix()
|
inline |
set matrix block
Definition at line 1354 of file Xpetra_BlockedCrsMatrix.hpp.
◆ Merge()
|
inline |
merge BlockedCrsMatrix blocks in a CrsMatrix
Definition at line 1368 of file Xpetra_BlockedCrsMatrix.hpp.
◆ residual()
|
inlinevirtual |
Compute a residual R = B - (*this) * X.
Implements Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, KokkosClassic::DefaultNode::DefaultNodeType >.
Definition at line 1526 of file Xpetra_BlockedCrsMatrix.hpp.
◆ Add()
|
inlineprivate |
Add a Xpetra::CrsMatrix to another: B = B*scalarB + A*scalarA.
Note, that this routine works only correctly if A only has entries which are empty (zero) in B. We use the insertGlobalValues routine for inserting the new values from A in B. The sumIntoGlobalValues routine is not implemented in Xpetra (and would not extend the graph of B for new entries). Here we need something to catch the exceptions of a future implementation of sumIntoGlobalValues that then adds the remaining new entries with insertGlobal Values.
This routine is private and used only by Merge. Since the blocks in BlockedCrsMatrix are seperated, this routine works for merging a BlockedCrsMatrix.
Definition at line 1550 of file Xpetra_BlockedCrsMatrix.hpp.
◆ CreateDefaultView()
|
inlineprivate |
Definition at line 1597 of file Xpetra_BlockedCrsMatrix.hpp.
Member Data Documentation
◆ is_diagonal_
|
private |
If we're diagonal, a bunch of the extraction stuff should work.
Definition at line 1609 of file Xpetra_BlockedCrsMatrix.hpp.
◆ domainmaps_
|
private |
full domain map together with all partial domain maps
Definition at line 1610 of file Xpetra_BlockedCrsMatrix.hpp.
◆ rangemaps_
|
private |
full range map together with all partial domain maps
Definition at line 1611 of file Xpetra_BlockedCrsMatrix.hpp.
◆ blocks_
|
private |
row major matrix block storage
Definition at line 1613 of file Xpetra_BlockedCrsMatrix.hpp.
◆ bRangeThyraMode_
|
private |
boolean flag, which is true, if BlockedCrsMatrix has been created using Thyra-style numbering for sub blocks, i.e. all GIDs of submaps are contiguous and start from 0.
Definition at line 1617 of file Xpetra_BlockedCrsMatrix.hpp.
◆ bDomainThyraMode_
|
private |
boolean flag, which is true, if BlockedCrsMatrix has been created using Thyra-style numbering for sub blocks, i.e. all GIDs of submaps are contiguous and start from 0.
Definition at line 1618 of file Xpetra_BlockedCrsMatrix.hpp.
The documentation for this class was generated from the following file:
