Tpetra parallel linear algebra  Version of the Day
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node > Class Template Referenceabstract

Constant block CRS matrix class. More...

#include <Tpetra_Experimental_BlockCrsMatrix_decl.hpp>

Inheritance diagram for Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >:
Inheritance graph
[legend]

Public Types

Public typedefs
typedef Scalar scalar_type
 The type of entries in the matrix. More...
 
typedef BlockMultiVector< Scalar, LO, GO, Node >::impl_scalar_type impl_scalar_type
 The implementation type of entries in the matrix. More...
 
typedef LO local_ordinal_type
 The type of local indices. More...
 
typedef GO global_ordinal_type
 The type of global indices. More...
 
typedef Node node_type
 The Kokkos Node type. More...
 
typedef Node::device_type device_type
 The Kokkos::Device specialization that this class uses. More...
 
typedef device_type::execution_space execution_space
 The Kokkos execution space that this class uses. More...
 
typedef device_type::memory_space memory_space
 The Kokkos memory space that this class uses. More...
 
typedef ::Tpetra::Map< LO, GO, node_typemap_type
 
typedef Tpetra::MultiVector< Scalar, LO, GO, node_typemv_type
 
typedef Tpetra::CrsGraph< LO, GO, node_typecrs_graph_type
 
typedef LittleBlock< impl_scalar_type, LO > little_block_type
 
typedef LittleBlock< const impl_scalar_type, LO > const_little_block_type
 
typedef LittleVector< impl_scalar_type, LO > little_vec_type
 
typedef LittleVector< const impl_scalar_type, LO > const_little_vec_type
 
Typedefs
typedef Tpetra::MultiVector< Scalar, LO, GO, Node >::mag_type mag_type
 Type of a norm result. More...
 

Public Member Functions

virtual Teuchos::RCP< const Teuchos::Comm< int > > getComm () const
 The communicator over which this matrix is distributed. More...
 
virtual Teuchos::RCP< Node > getNode () const
 The Kokkos Node instance. More...
 
virtual global_size_t getGlobalNumCols () const
 The global number of columns of this matrix. More...
 
virtual size_t getNodeNumCols () const
 The number of columns needed to apply the forward operator on this node. More...
 
virtual GO getIndexBase () const
 The index base for global indices in this matrix. More...
 
virtual global_size_t getGlobalNumEntries () const
 The global number of stored (structurally nonzero) entries. More...
 
virtual size_t getNodeNumEntries () const
 The local number of stored (structurally nonzero) entries. More...
 
virtual size_t getNumEntriesInGlobalRow (GO globalRow) const
 The current number of entries on the calling process in the specified global row. More...
 
virtual global_size_t getGlobalNumDiags () const
 The number of global diagonal entries, based on global row/column index comparisons. More...
 
virtual size_t getNodeNumDiags () const
 The number of local diagonal entries, based on global row/column index comparisons. More...
 
virtual size_t getGlobalMaxNumRowEntries () const
 The maximum number of entries across all rows/columns on all nodes. More...
 
virtual bool hasColMap () const
 Whether this matrix has a well-defined column map. More...
 
virtual bool isLowerTriangular () const
 Whether this matrix is lower triangular. More...
 
virtual bool isUpperTriangular () const
 Whether this matrix is upper triangular. More...
 
virtual bool isLocallyIndexed () const
 Whether matrix indices are locally indexed. More...
 
virtual bool isGloballyIndexed () const
 Whether matrix indices are globally indexed. More...
 
virtual bool isFillComplete () const
 Whether fillComplete() has been called. More...
 
virtual bool supportsRowViews () const
 Whether this object implements getLocalRowView() and getGlobalRowView(). More...
 
Constructors and destructor
 BlockCrsMatrix ()
 Default constructor: Makes an empty block matrix. More...
 
 BlockCrsMatrix (const crs_graph_type &graph, const LO blockSize)
 Constructor that takes a graph and a block size. More...
 
 BlockCrsMatrix (const crs_graph_type &graph, const map_type &domainPointMap, const map_type &rangePointMap, const LO blockSize)
 Constructor that takes a graph, domain and range point Maps, and a block size. More...
 
virtual ~BlockCrsMatrix ()
 Destructor (declared virtual for memory safety). More...
 
Implementation of Tpetra::Operator
Teuchos::RCP< const map_typegetDomainMap () const
 Get the (point) domain Map of this matrix. More...
 
Teuchos::RCP< const map_typegetRangeMap () const
 Get the (point) range Map of this matrix. More...
 
Teuchos::RCP< const map_typegetRowMap () const
 get the (mesh) map for the rows of this block matrix. More...
 
Teuchos::RCP< const map_typegetColMap () const
 get the (mesh) map for the columns of this block matrix. More...
 
global_size_t getGlobalNumRows () const
 get the global number of block rows More...
 
size_t getNodeNumRows () const
 get the local number of block rows More...
 
size_t getNodeMaxNumRowEntries () const
 The maximum number of entries across all rows/columns on this node. More...
 
void apply (const mv_type &X, mv_type &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, Scalar alpha=Teuchos::ScalarTraits< Scalar >::one(), Scalar beta=Teuchos::ScalarTraits< Scalar >::zero()) const
 For this matrix A, compute Y := beta * Y + alpha * Op(A) * X. More...
 
bool hasTransposeApply () const
 Whether it is valid to apply the transpose or conjugate transpose of this matrix. More...
 
void setAllToScalar (const Scalar &alpha)
 Set all matrix entries equal to alpha. More...
 
Implementation of Teuchos::Describable
std::string description () const
 One-line description of this object. More...
 
void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
 Print a description of this object to the given output stream. More...
 
Extraction Methods
virtual void getGlobalRowCopy (GO GlobalRow, const Teuchos::ArrayView< GO > &Indices, const Teuchos::ArrayView< Scalar > &Values, size_t &NumEntries) const
 Get a copy of the given global row's entries. More...
 
virtual void getGlobalRowView (GO GlobalRow, Teuchos::ArrayView< const GO > &indices, Teuchos::ArrayView< const Scalar > &values) const
 Get a constant, nonpersisting, globally indexed view of the given row of the matrix. More...
 
virtual void getLocalDiagCopy (Vector< Scalar, LO, GO, Node > &diag) const
 Get a copy of the diagonal entries, distributed by the row Map. More...
 
Mathematical methods
virtual void leftScale (const Vector< Scalar, LO, GO, Node > &x)
 Scale the RowMatrix on the left with the given Vector x. More...
 
virtual void rightScale (const Vector< Scalar, LO, GO, Node > &x)
 Scale the RowMatrix on the right with the given Vector x. More...
 
virtual Tpetra::RowMatrix< Scalar, LO, GO, Node >::mag_type getFrobeniusNorm () const
 The Frobenius norm of the matrix. More...
 
Extraction Methods
virtual void getGlobalRowView (GOGlobalRow, ArrayView< const GO > &indices, ArrayView< const Scalar > &values) const =0
 Get a constant, nonpersisting, globally indexed view of the given row of the matrix. More...
 
virtual void getLocalRowView (LOLocalRow, ArrayView< const LO > &indices, ArrayView< const Scalar > &values) const =0
 Get a constant, nonpersisting, locally indexed view of the given row of the matrix. More...
 
virtual void getLocalDiagCopy (Vector< Scalar, LO, GO, Node, Node::classic > &diag) const =0
 Get a copy of the diagonal entries, distributed by the row Map. More...
 
Mathematical methods
virtual void leftScale (const Vector< Scalar, LO, GO, Node, Node::classic > &x)=0
 Scale the RowMatrix on the left with the given Vector x. More...
 
virtual void rightScale (const Vector< Scalar, LO, GO, Node, Node::classic > &x)=0
 Scale the RowMatrix on the right with the given Vector x. More...
 
virtual Teuchos::RCP< RowMatrix< Scalar, LO, GO, Node > > add (const Scalar &alpha, const RowMatrix< Scalar, LO, GO, Node > &A, const Scalar &beta, const Teuchos::RCP< const Map< LO, GO, Node > > &domainMap=Teuchos::null, const Teuchos::RCP< const Map< LO, GO, Node > > &rangeMap=Teuchos::null, const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null) const
 Return a new RowMatrix which is the result of beta*this + alpha*A. More...
 
Implementation of Packable interface
virtual void pack (const Teuchos::ArrayView< const LO > &exportLIDs, Teuchos::Array< char > &exports, const Teuchos::ArrayView< size_t > &numPacketsPerLID, size_t &constantNumPackets, Distributor &distor) const
 Pack this object's data for an Import or Export. More...
 
Pure virtual functions to be overridden by subclasses.
virtual void apply (const MultiVector< Scalar, LO, GO, Node > &X, MultiVector< Scalar, LO, GO, Node > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, Scalar alpha=Teuchos::ScalarTraits< Scalar >::one(), Scalar beta=Teuchos::ScalarTraits< Scalar >::zero()) const =0
 Computes the operator-multivector application. More...
 
Public methods for redistributing data
void doImport (const SrcDistObject &source, const Import< LO, GO, Node > &importer, CombineMode CM)
 Import data into this object using an Import object ("forward mode"). More...
 
void doImport (const SrcDistObject &source, const Export< LO, GO, Node > &exporter, CombineMode CM)
 Import data into this object using an Export object ("reverse mode"). More...
 
void doExport (const SrcDistObject &source, const Export< LO, GO, Node > &exporter, CombineMode CM)
 Export data into this object using an Export object ("forward mode"). More...
 
void doExport (const SrcDistObject &source, const Import< LO, GO, Node > &importer, CombineMode CM)
 Export data into this object using an Import object ("reverse mode"). More...
 
Attribute accessor methods
bool isDistributed () const
 Whether this is a globally distributed object. More...
 
virtual Teuchos::RCP< const map_typegetMap () const
 The Map describing the parallel distribution of this object. More...
 
I/O methods
void print (std::ostream &os) const
 Print this object to the given output stream. More...
 
Methods for use only by experts
virtual void removeEmptyProcessesInPlace (const Teuchos::RCP< const map_type > &newMap)
 Remove processes which contain no elements in this object's Map. More...
 

Protected Member Functions

virtual size_t constantNumberOfPackets () const
 Whether the implementation's instance promises always to have a constant number of packets per LID, and if so, how many packets per LID there are. More...
 
virtual void doTransfer (const SrcDistObject &src, CombineMode CM, size_t numSameIDs, const Teuchos::ArrayView< const local_ordinal_type > &permuteToLIDs, const Teuchos::ArrayView< const local_ordinal_type > &permuteFromLIDs, const Teuchos::ArrayView< const local_ordinal_type > &remoteLIDs, const Teuchos::ArrayView< const local_ordinal_type > &exportLIDs, Distributor &distor, ReverseOption revOp)
 Redistribute data across memory images. More...
 
virtual void createViews () const
 Hook for creating a const view. More...
 
virtual void createViewsNonConst (KokkosClassic::ReadWriteOption rwo)
 Hook for creating a nonconst view. More...
 
virtual void releaseViews () const
 Hook for releasing views. More...
 
Implementation of DistObject (or DistObjectKA).

The methods here implement Tpetra::DistObject or Tpetra::DistObjectKA, depending on a configure-time option. They let BlockMultiVector participate in Import and Export operations. Users don't have to worry about these methods.

virtual bool checkSizes (const Tpetra::SrcDistObject &source)
 Compare the source and target (this) objects for compatibility. More...
 
virtual void copyAndPermute (const Tpetra::SrcDistObject &source, size_t numSameIDs, const Teuchos::ArrayView< const LO > &permuteToLIDs, const Teuchos::ArrayView< const LO > &permuteFromLIDs)
 Perform copies and permutations that are local to this process. More...
 
virtual void packAndPrepare (const Tpetra::SrcDistObject &source, const Teuchos::ArrayView< const LO > &exportLIDs, Teuchos::Array< packet_type > &exports, const Teuchos::ArrayView< size_t > &numPacketsPerLID, size_t &constantNumPackets, Tpetra::Distributor &distor)
 
virtual void unpackAndCombine (const Teuchos::ArrayView< const LO > &importLIDs, const Teuchos::ArrayView< const packet_type > &imports, const Teuchos::ArrayView< size_t > &numPacketsPerLID, size_t constantNumPackets, Tpetra::Distributor &distor, Tpetra::CombineMode CM)
 
Methods implemented by subclasses and used by doTransfer().

The doTransfer() method uses the subclass' implementations of these methods to implement data transfer. Subclasses of DistObject must implement these methods. This is an instance of the Template Method Pattern. ("Template" here doesn't mean "C++ template"; it means "pattern with holes that are filled in by the subclass' method implementations.")

virtual bool useNewInterface ()
 Whether lass (???) implements old or new interface. More...
 
virtual void copyAndPermuteNew (const SrcDistObject &source, size_t numSameIDs, const Kokkos::View< const local_ordinal_type *, execution_space > &permuteToLIDs, const Kokkos::View< const local_ordinal_type *, execution_space > &permuteFromLIDs)
 
virtual void packAndPrepare (const SrcDistObject &source, const Teuchos::ArrayView< const local_ordinal_type > &exportLIDs, Teuchos::Array< packet_type > &exports, const Teuchos::ArrayView< size_t > &numPacketsPerLID, size_t &constantNumPackets, Distributor &distor)
 Perform any packing or preparation required for communication. More...
 
virtual void packAndPrepareNew (const SrcDistObject &source, const Kokkos::View< const local_ordinal_type *, execution_space > &exportLIDs, Kokkos::View< packet_type *, execution_space > &exports, const Kokkos::View< size_t *, execution_space > &numPacketsPerLID, size_t &constantNumPackets, Distributor &distor)
 
virtual void unpackAndCombine (const Teuchos::ArrayView< const local_ordinal_type > &importLIDs, const Teuchos::ArrayView< const packet_type > &imports, const Teuchos::ArrayView< size_t > &numPacketsPerLID, size_t constantNumPackets, Distributor &distor, CombineMode CM)
 Perform any unpacking and combining after communication. More...
 
virtual void unpackAndCombineNew (const Kokkos::View< const local_ordinal_type *, execution_space > &importLIDs, const Kokkos::View< const packet_type *, execution_space > &imports, const Kokkos::View< size_t *, execution_space > &numPacketsPerLID, size_t constantNumPackets, Distributor &distor, CombineMode CM)
 

Protected Attributes

Teuchos::RCP< const map_typemap_
 The Map over which this object is distributed. More...
 

Block operations

LO getBlockSize () const
 The number of degrees of freedom per mesh point. More...
 
virtual Teuchos::RCP< const Tpetra::RowGraph< LO, GO, Node > > getGraph () const
 Get the (mesh) graph. More...
 
const crs_graph_typegetCrsGraph () const
 
void applyBlock (const BlockMultiVector< Scalar, LO, GO, Node > &X, BlockMultiVector< Scalar, LO, GO, Node > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, const Scalar alpha=Teuchos::ScalarTraits< Scalar >::one(), const Scalar beta=Teuchos::ScalarTraits< Scalar >::zero())
 Version of apply() that takes BlockMultiVector input and output. More...
 
void gaussSeidelCopy (MultiVector< Scalar, LO, GO, Node > &X, const MultiVector< Scalar, LO, GO, Node > &B, const MultiVector< Scalar, LO, GO, Node > &D, const Scalar &dampingFactor, const ESweepDirection direction, const int numSweeps, const bool zeroInitialGuess) const
 Version of gaussSeidel(), with fewer requirements on X. More...
 
void reorderedGaussSeidelCopy (MultiVector< Scalar, LO, GO, Node > &X, const MultiVector< Scalar, LO, GO, Node > &B, const MultiVector< Scalar, LO, GO, Node > &D, const ArrayView< LO > &rowIndices, const Scalar &dampingFactor, const ESweepDirection direction, const int numSweeps, const bool zeroInitialGuess) const
 Version of reorderedGaussSeidel(), with fewer requirements on X. More...
 
void localGaussSeidel (const BlockMultiVector< Scalar, LO, GO, Node > &Residual, BlockMultiVector< Scalar, LO, GO, Node > &Solution, const Kokkos::View< impl_scalar_type ***, device_type, Kokkos::MemoryUnmanaged > &factoredDiagonal, const Kokkos::View< int **, device_type, Kokkos::MemoryUnmanaged > &factorizationPivots, const Scalar &omega, const ESweepDirection direction) const
 Local Gauss-Seidel solve, given a factorized diagonal. More...
 
LO replaceLocalValues (const LO localRowInd, const LO colInds[], const Scalar vals[], const LO numColInds) const
 Replace values at the given (mesh, i.e., block) column indices, in the given (mesh, i.e., block) row. More...
 
LO sumIntoLocalValues (const LO localRowInd, const LO colInds[], const Scalar vals[], const LO numColInds) const
 Sum into values at the given (mesh, i.e., block) column indices, in the given (mesh, i.e., block) row. More...
 
LO getLocalRowView (const LO localRowInd, const LO *&colInds, Scalar *&vals, LO &numInds) const
 Get a view of the (mesh, i.e., block) row, using local (mesh, i.e., block) indices. More...
 
void getLocalRowView (LO LocalRow, Teuchos::ArrayView< const LO > &indices, Teuchos::ArrayView< const Scalar > &values) const
 Not implemented. More...
 
void getLocalRowCopy (LO LocalRow, const Teuchos::ArrayView< LO > &Indices, const Teuchos::ArrayView< Scalar > &Values, size_t &NumEntries) const
 Not implemented. More...
 
little_block_type getLocalBlock (const LO localRowInd, const LO localColInd) const
 
LO getLocalRowOffsets (const LO localRowInd, ptrdiff_t offsets[], const LO colInds[], const LO numColInds) const
 Get relative offsets corresponding to the given rows, given by local row index. More...
 
LO replaceLocalValuesByOffsets (const LO localRowInd, const ptrdiff_t offsets[], const Scalar vals[], const LO numOffsets) const
 Like replaceLocalValues, but avoids computing row offsets. More...
 
LO sumIntoLocalValuesByOffsets (const LO localRowInd, const ptrdiff_t offsets[], const Scalar vals[], const LO numOffsets) const
 Like sumIntoLocalValues, but avoids computing row offsets. More...
 
size_t getNumEntriesInLocalRow (const LO localRowInd) const
 Return the number of entries in the given row on the calling process. More...
 
bool localError () const
 Whether this object had an error on the calling process. More...
 
std::string errorMessages () const
 The current stream of error messages. More...
 
void getLocalDiagOffsets (Teuchos::ArrayRCP< size_t > &offsets) const
 Get offsets of the diagonal entries in the matrix. More...
 
void getLocalDiagCopy (BlockCrsMatrix< Scalar, LO, GO, Node > &diag, const Teuchos::ArrayView< const size_t > &offsets) const
 Variant of getLocalDiagCopy() that uses precomputed offsets. More...
 
void getLocalDiagCopy (const Kokkos::View< impl_scalar_type ***, device_type, Kokkos::MemoryUnmanaged > &diag, const Teuchos::ArrayView< const size_t > &offsets) const
 Variant of getLocalDiagCopy() that uses precomputed offsets and puts diagonal blocks in a 3-D Kokkos::View. More...
 
LO absMaxLocalValues (const LO localRowInd, const LO colInds[], const Scalar vals[], const LO numColInds) const
 Like sumIntoLocalValues, but for the ABSMAX combine mode. More...
 
LO absMaxLocalValuesByOffsets (const LO localRowInd, const ptrdiff_t offsets[], const Scalar vals[], const LO numOffsets) const
 Like sumIntoLocalValuesByOffsets, but for the ABSMAX combine mode. More...
 

Detailed Description

template<class Scalar = Details::DefaultTypes::scalar_type, class LO = Details::DefaultTypes::local_ordinal_type, class GO = Details::DefaultTypes::global_ordinal_type, class Node = Details::DefaultTypes::node_type>
class Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >

Constant block CRS matrix class.

Author
Mark Hoemmen
Date
13 Feb 2014, 24 Feb 2014
Template Parameters
ScalarThe type of the numerical entries of the matrix. (You can use real-valued or complex-valued types here, unlike in Epetra, where the scalar type is always double.)
LOThe type of local indices. See the documentation of the first template parameter of Map for requirements.
GOThe type of global indices. See the documentation of the second template parameter of Map for requirements.
NodeThe Kokkos Node type. See the documentation of the third template parameter of Map for requirements.

Please read the documentation of BlockMultiVector first.

This class stores values associated with the degrees of freedom of a single mesh point contiguously, in a getBlockSize() by getBlockSize() block, in row-major format.

Since this class requires a fill-complete Tpetra::CrsGraph for construction, it has a row and column Map already. This means that it only needs to provide access using local indices. Users are responsible for converting from global to local indices if necessary. Please be aware that the row Map and column Map may differ, so you may not use local row and column indices interchangeably.

For simplicity, this object only supports local indexing. It can do so because both of its constructors require a fill-complete Tpetra::CrsGraph, which therefore has both a row Map and a column Map.

Here is an example of how to fill into this object using direct views.

int err = 0;
// At least one entry, so &offsets[0] always makes sense.
Teuchos::Array<ptrdiff_t> offsets (1);
for (LO localRowInd = 0; localRowInd < localNumRows; ++localRowInd) {
// Get a view of the current row.
// You may modify the values, but not the column indices.
const LO* localColInds;
Scalar* vals;
LO numEntries;
err = A.getLocalRowView (localRowInd, localColInds, vals, numEntries);
if (err != 0) {
break;
}
// Modify the entries in the current row.
for (LO k = 0; k < numEntries; ++k) {
Scalar* const curBlock = vals[blockSize * blockSize * k];
// Blocks are stored in row-major format.
for (LO j = 0; j < blockSize; ++j) {
for (LO i = 0; i < blockSize; ++i) {
const Scalar curVal = curBlock[i + j * blockSize];
// Some function f of the current value and mesh point
curBlock[i + j * blockSize] = f (curVal, localColInds[k], ...);
}
}
}
}

Definition at line 127 of file Tpetra_Experimental_BlockCrsMatrix_decl.hpp.

Member Typedef Documentation

template<class Scalar = Details::DefaultTypes::scalar_type, class LO = Details::DefaultTypes::local_ordinal_type, class GO = Details::DefaultTypes::global_ordinal_type, class Node = Details::DefaultTypes::node_type>
typedef Scalar Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::scalar_type

The type of entries in the matrix.

Definition at line 144 of file Tpetra_Experimental_BlockCrsMatrix_decl.hpp.

template<class Scalar = Details::DefaultTypes::scalar_type, class LO = Details::DefaultTypes::local_ordinal_type, class GO = Details::DefaultTypes::global_ordinal_type, class Node = Details::DefaultTypes::node_type>
typedef BlockMultiVector<Scalar, LO, GO, Node>::impl_scalar_type Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::impl_scalar_type

The implementation type of entries in the matrix.

Letting scalar_type and impl_scalar_type differ addresses a work-around that the new ("Kokkos refactor," as opposed to "classic") version of Tpetra uses, to deal with missing device macros and volatile overloads in types like std::complex<T>.

Definition at line 152 of file Tpetra_Experimental_BlockCrsMatrix_decl.hpp.

template<class Scalar = Details::DefaultTypes::scalar_type, class LO = Details::DefaultTypes::local_ordinal_type, class GO = Details::DefaultTypes::global_ordinal_type, class Node = Details::DefaultTypes::node_type>
typedef LO Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::local_ordinal_type

The type of local indices.

Definition at line 155 of file Tpetra_Experimental_BlockCrsMatrix_decl.hpp.

template<class Scalar = Details::DefaultTypes::scalar_type, class LO = Details::DefaultTypes::local_ordinal_type, class GO = Details::DefaultTypes::global_ordinal_type, class Node = Details::DefaultTypes::node_type>
typedef GO Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::global_ordinal_type

The type of global indices.

Definition at line 157 of file Tpetra_Experimental_BlockCrsMatrix_decl.hpp.

template<class Scalar = Details::DefaultTypes::scalar_type, class LO = Details::DefaultTypes::local_ordinal_type, class GO = Details::DefaultTypes::global_ordinal_type, class Node = Details::DefaultTypes::node_type>
typedef Node Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::node_type

The Kokkos Node type.

Definition at line 159 of file Tpetra_Experimental_BlockCrsMatrix_decl.hpp.

template<class Scalar = Details::DefaultTypes::scalar_type, class LO = Details::DefaultTypes::local_ordinal_type, class GO = Details::DefaultTypes::global_ordinal_type, class Node = Details::DefaultTypes::node_type>
typedef Node::device_type Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::device_type

The Kokkos::Device specialization that this class uses.

Definition at line 162 of file Tpetra_Experimental_BlockCrsMatrix_decl.hpp.

template<class Scalar = Details::DefaultTypes::scalar_type, class LO = Details::DefaultTypes::local_ordinal_type, class GO = Details::DefaultTypes::global_ordinal_type, class Node = Details::DefaultTypes::node_type>
typedef device_type::execution_space Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::execution_space

The Kokkos execution space that this class uses.

Definition at line 164 of file Tpetra_Experimental_BlockCrsMatrix_decl.hpp.

template<class Scalar = Details::DefaultTypes::scalar_type, class LO = Details::DefaultTypes::local_ordinal_type, class GO = Details::DefaultTypes::global_ordinal_type, class Node = Details::DefaultTypes::node_type>
typedef device_type::memory_space Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::memory_space

The Kokkos memory space that this class uses.

Definition at line 166 of file Tpetra_Experimental_BlockCrsMatrix_decl.hpp.

typedef Tpetra::MultiVector<Scalar, LO , GO , Node>::mag_type Tpetra::RowMatrix< Scalar, LO , GO , Node >::mag_type
inherited

Type of a norm result.

This is usually the same as the type of the magnitude (absolute value) of Scalar, but may differ for certain Scalar types.

Definition at line 117 of file Tpetra_RowMatrix_decl.hpp.

Member Enumeration Documentation

enum Tpetra::DistObject::ReverseOption
protectedinherited

Whether the data transfer should be performed in forward or reverse mode.

"Reverse mode" means calling doExport() with an Import object, or calling doImport() with an Export object. "Forward mode" means calling doExport() with an Export object, or calling doImport() with an Import object.

Definition at line 449 of file Tpetra_DistObject_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar , class LO , class GO , class Node >
Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::BlockCrsMatrix ( )

Default constructor: Makes an empty block matrix.

Definition at line 69 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO, class GO , class Node >
Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::BlockCrsMatrix ( const crs_graph_type graph,
const LO  blockSize 
)

Constructor that takes a graph and a block size.

The graph represents the mesh. This constructor computes the point Maps corresponding to the given graph's domain and range Maps. If you already have those point Maps, it is better to call the four-argument constructor.

Parameters
graph[in] A fill-complete graph.
blockSize[in] Number of degrees of freedom per mesh point.

Definition at line 84 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO, class GO , class Node >
Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::BlockCrsMatrix ( const crs_graph_type graph,
const map_type domainPointMap,
const map_type rangePointMap,
const LO  blockSize 
)

Constructor that takes a graph, domain and range point Maps, and a block size.

The graph represents the mesh. This constructor uses the given domain and range point Maps, rather than computing them. The given point Maps must be the same as the above two-argument constructor would have computed.

Definition at line 139 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar = Details::DefaultTypes::scalar_type, class LO = Details::DefaultTypes::local_ordinal_type, class GO = Details::DefaultTypes::global_ordinal_type, class Node = Details::DefaultTypes::node_type>
virtual Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::~BlockCrsMatrix ( )
inlinevirtual

Destructor (declared virtual for memory safety).

Definition at line 208 of file Tpetra_Experimental_BlockCrsMatrix_decl.hpp.

Member Function Documentation

template<class Scalar , class LO , class GO , class Node >
Teuchos::RCP< const typename BlockCrsMatrix< Scalar, LO, GO, Node >::map_type > Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getDomainMap ( ) const
virtual

Get the (point) domain Map of this matrix.

Implements Tpetra::Operator< Scalar, LO, GO, Node >.

Definition at line 195 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO , class GO , class Node >
Teuchos::RCP< const typename BlockCrsMatrix< Scalar, LO, GO, Node >::map_type > Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getRangeMap ( ) const
virtual

Get the (point) range Map of this matrix.

Implements Tpetra::Operator< Scalar, LO, GO, Node >.

Definition at line 204 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO , class GO , class Node >
Teuchos::RCP< const typename BlockCrsMatrix< Scalar, LO, GO, Node >::map_type > Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getRowMap ( ) const
virtual

get the (mesh) map for the rows of this block matrix.

Implements Tpetra::RowMatrix< Scalar, LO, GO, Node >.

Definition at line 213 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO , class GO , class Node >
Teuchos::RCP< const typename BlockCrsMatrix< Scalar, LO, GO, Node >::map_type > Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getColMap ( ) const
virtual

get the (mesh) map for the columns of this block matrix.

Implements Tpetra::RowMatrix< Scalar, LO, GO, Node >.

Definition at line 221 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO , class GO , class Node >
global_size_t Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getGlobalNumRows ( ) const
virtual

get the global number of block rows

Implements Tpetra::RowMatrix< Scalar, LO, GO, Node >.

Definition at line 229 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO , class GO , class Node >
size_t Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getNodeNumRows ( ) const
virtual

get the local number of block rows

Implements Tpetra::RowMatrix< Scalar, LO, GO, Node >.

Definition at line 237 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO , class GO , class Node >
size_t Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getNodeMaxNumRowEntries ( ) const
virtual

The maximum number of entries across all rows/columns on this node.

Implements Tpetra::RowMatrix< Scalar, LO, GO, Node >.

Definition at line 245 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar, class LO , class GO , class Node >
void Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::apply ( const mv_type X,
mv_type Y,
Teuchos::ETransp  mode = Teuchos::NO_TRANS,
Scalar  alpha = Teuchos::ScalarTraits<Scalar>::one (),
Scalar  beta = Teuchos::ScalarTraits<Scalar>::zero () 
) const

For this matrix A, compute Y := beta * Y + alpha * Op(A) * X.

Op(A) is A if mode is Teuchos::NO_TRANS, the transpose of A if mode is Teuchos::TRANS, and the conjugate transpose of A if mode is Teuchos::CONJ_TRANS.

If alpha is zero, ignore X's entries on input; if beta is zero, ignore Y's entries on input. This follows the BLAS convention, and only matters if X resp. Y have Inf or NaN entries.

Definition at line 253 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar = Details::DefaultTypes::scalar_type, class LO = Details::DefaultTypes::local_ordinal_type, class GO = Details::DefaultTypes::global_ordinal_type, class Node = Details::DefaultTypes::node_type>
bool Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::hasTransposeApply ( ) const
inlinevirtual

Whether it is valid to apply the transpose or conjugate transpose of this matrix.

Reimplemented from Tpetra::Operator< Scalar, LO, GO, Node >.

Definition at line 252 of file Tpetra_Experimental_BlockCrsMatrix_decl.hpp.

template<class Scalar, class LO , class GO , class Node >
void Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::setAllToScalar ( const Scalar &  alpha)

Set all matrix entries equal to alpha.

Definition at line 346 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO , class GO , class Node >
std::string Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::description ( ) const
virtual

One-line description of this object.

Reimplemented from Tpetra::DistObject< char, LO, GO, Node >.

Definition at line 2613 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO , class GO , class Node >
void Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::describe ( Teuchos::FancyOStream &  out,
const Teuchos::EVerbosityLevel  verbLevel 
) const
virtual

Print a description of this object to the given output stream.

Parameters
out[out] Output stream to which to print. Valid values include Teuchos::VERB_DEFAULT, Teuchos::VERB_NONE, Teuchos::VERB_LOW, Teuchos::VERB_MEDIUM, Teuchos::VERB_HIGH, and Teuchos::VERB_EXTREME.
verbLevel[in] Verbosity level at which to print.
Warning
If verbLevel is Teuchos::VERB_EXTREME, this method has collective semantics over the matrix's communicator.

The following pseudocode shows how to wrap your std::ostream object in a Teuchos::FancyOStream, and pass it into this method:

// ...
std::ostream& yourObject = ...;
Teuchos::RCP<Teuchos::FancyOStream> wrappedStream =
Teuchos::getFancyOStream (Teuchos::rcpFromRef (yourObject));
const Teuchos::EVerbosityLevel verbLevel = ...;
A.describe (*wrappedStream, verbLevel);

Reimplemented from Tpetra::DistObject< char, LO, GO, Node >.

Definition at line 2637 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar = Details::DefaultTypes::scalar_type, class LO = Details::DefaultTypes::local_ordinal_type, class GO = Details::DefaultTypes::global_ordinal_type, class Node = Details::DefaultTypes::node_type>
LO Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getBlockSize ( ) const
inline

The number of degrees of freedom per mesh point.

Definition at line 300 of file Tpetra_Experimental_BlockCrsMatrix_decl.hpp.

template<class Scalar , class LO , class GO , class Node >
Teuchos::RCP< const Tpetra::RowGraph< LO, GO, Node > > Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getGraph ( ) const
virtual

Get the (mesh) graph.

Implements Tpetra::RowMatrix< Scalar, LO, GO, Node >.

Definition at line 3117 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar, class LO, class GO, class Node>
void Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::applyBlock ( const BlockMultiVector< Scalar, LO, GO, Node > &  X,
BlockMultiVector< Scalar, LO, GO, Node > &  Y,
Teuchos::ETransp  mode = Teuchos::NO_TRANS,
const Scalar  alpha = Teuchos::ScalarTraits<Scalar>::one (),
const Scalar  beta = Teuchos::ScalarTraits<Scalar>::zero () 
)

Version of apply() that takes BlockMultiVector input and output.

This method is deliberately not marked const, because it may do lazy initialization of temporary internal block multivectors.

Definition at line 318 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar, class LO, class GO, class Node>
void Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::gaussSeidelCopy ( MultiVector< Scalar, LO, GO, Node > &  X,
const MultiVector< Scalar, LO, GO, Node > &  B,
const MultiVector< Scalar, LO, GO, Node > &  D,
const Scalar &  dampingFactor,
const ESweepDirection  direction,
const int  numSweeps,
const bool  zeroInitialGuess 
) const

Version of gaussSeidel(), with fewer requirements on X.

Not Implemented

Definition at line 700 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar = Details::DefaultTypes::scalar_type, class LO = Details::DefaultTypes::local_ordinal_type, class GO = Details::DefaultTypes::global_ordinal_type, class Node = Details::DefaultTypes::node_type>
void Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::reorderedGaussSeidelCopy ( MultiVector< Scalar, LO, GO, Node > &  X,
const MultiVector< Scalar, LO, GO, Node > &  B,
const MultiVector< Scalar, LO, GO, Node > &  D,
const ArrayView< LO > &  rowIndices,
const Scalar &  dampingFactor,
const ESweepDirection  direction,
const int  numSweeps,
const bool  zeroInitialGuess 
) const

Version of reorderedGaussSeidel(), with fewer requirements on X.

Not Implemented

Definition at line 718 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar, class LO, class GO, class Node>
void Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::localGaussSeidel ( const BlockMultiVector< Scalar, LO, GO, Node > &  Residual,
BlockMultiVector< Scalar, LO, GO, Node > &  Solution,
const Kokkos::View< impl_scalar_type ***, device_type, Kokkos::MemoryUnmanaged > &  factoredDiagonal,
const Kokkos::View< int **, device_type, Kokkos::MemoryUnmanaged > &  factorizationPivots,
const Scalar &  omega,
const ESweepDirection  direction 
) const

Local Gauss-Seidel solve, given a factorized diagonal.

Parameters
Residual[in] The "residual" (right-hand side) block (multi)vector
Solution[in/out] On input: the initial guess / current approximate solution. On output: the new approximate solution.
factoredDiagonal[in] Block diagonal, whose blocks have been factored using LU with partial pivoting, and have the same format as that produced by LAPACK's _GETRF routine.
factorizationPivots[in] Pivots from the block factorizations
omega[in] (S)SOR relaxation coefficient
direction[in] Forward, Backward, or Symmetric.

One may access block i in factoredDiagonal using the following code:

auto D_ii = Kokkos::subview(factoredDiagonal, j, Kokkos::ALL(), Kokkos::ALL());

The resulting block is b x b, where b = this->getBlockSize().

Definition at line 576 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar, class LO, class GO , class Node >
LO Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::replaceLocalValues ( const LO  localRowInd,
const LO  colInds[],
const Scalar  vals[],
const LO  numColInds 
) const

Replace values at the given (mesh, i.e., block) column indices, in the given (mesh, i.e., block) row.

Parameters
localRowInd[in] Local mesh (i.e., block) index of the row in which to replace.
colInds[in] Local mesh (i.e., block) column ind{ex,ices} at which to replace values. colInds[k] is the local column index whose new values start at vals[getBlockSize() * getBlockSize() * k], and colInds has length at least numColInds. This method will only access the first numColInds entries of colInds.
vals[in] The new values to use at the given column indices. Values for each block are stored contiguously, in row major layout, with no padding between rows or between blocks. Thus, if b = getBlockSize(), then vals[k*b*b] .. vals[(k+1)*b*b-1] are the values to use for block colInds[k].
numColInds[in] The number of entries of colInds.
Returns
The number of valid entries of colInds. colInds[k] is valid if and only if it is a valid local mesh (i.e., block) column index. This method succeeded if and only if the return value equals the input argument numColInds.

Definition at line 362 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar, class LO, class GO , class Node >
LO Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::sumIntoLocalValues ( const LO  localRowInd,
const LO  colInds[],
const Scalar  vals[],
const LO  numColInds 
) const

Sum into values at the given (mesh, i.e., block) column indices, in the given (mesh, i.e., block) row.

Parameters
localRowInd[in] Local mesh (i.e., block) index of the row in which to sum.
colInds[in] Local mesh (i.e., block) column ind{ex,ices} at which to sum. colInds[k] is the local column index whose new values start at vals[getBlockSize() * getBlockSize() * k], and colInds has length at least numColInds. This method will only access the first numColInds entries of colInds.
vals[in] The new values to sum in at the given column indices. Values for each block are stored contiguously, in row major layout, with no padding between rows or between blocks. Thus, if b = getBlockSize(), then vals[k*b*b] .. vals[(k+1)*b*b-1] are the values to use for block colInds[k].
numColInds[in] The number of entries of colInds.
Returns
The number of valid entries of colInds. colInds[k] is valid if and only if it is a valid local mesh (i.e., block) column index. This method succeeded if and only if the return value equals the input argument numColInds.

Definition at line 848 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar, class LO, class GO , class Node >
LO Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getLocalRowView ( const LO  localRowInd,
const LO *&  colInds,
Scalar *&  vals,
LO &  numInds 
) const

Get a view of the (mesh, i.e., block) row, using local (mesh, i.e., block) indices.

This matrix has a graph, and we assume that the graph is fill complete on input to the matrix's constructor. Thus, the matrix has a column Map, and it stores column indices as local indices. This means you can view the column indices as local indices directly. However, you may not view them as global indices directly, since the column indices are not stored as global indices in the graph.

Parameters
localRowInd[in] Local (mesh, i.e., block) row index.
colInds[out] If localRowInd is valid on the calling process, then on output, this is a pointer to the local (mesh, i.e., block) column indices in the given (mesh, i.e., block) row. If localRowInd is not valid, then this is undefined. (Please check the return value of this method.)
vals[out] If localRowInd is valid on the calling process, then on output, this is a pointer to the row's values. If localRowInd is not valid, then this is undefined. (Please check the return value of this method.)
numInds[in] The number of (mesh, i.e., block) indices in colInds on output.
Returns
0 if localRowInd is valid, else Teuchos::OrdinalTraits<LO>::invalid().

Definition at line 903 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar, class LO, class GO , class Node >
void Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getLocalRowView ( LO  LocalRow,
Teuchos::ArrayView< const LO > &  indices,
Teuchos::ArrayView< const Scalar > &  values 
) const

Not implemented.

Definition at line 3046 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar, class LO, class GO , class Node >
void Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getLocalRowCopy ( LO  LocalRow,
const Teuchos::ArrayView< LO > &  Indices,
const Teuchos::ArrayView< Scalar > &  Values,
size_t &  NumEntries 
) const
virtual

Not implemented.

Implements Tpetra::RowMatrix< Scalar, LO, GO, Node >.

Definition at line 929 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO, class GO , class Node >
LO Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getLocalRowOffsets ( const LO  localRowInd,
ptrdiff_t  offsets[],
const LO  colInds[],
const LO  numColInds 
) const

Get relative offsets corresponding to the given rows, given by local row index.

The point of this method is to precompute the results of searching for the offsets corresponding to the given column indices. You may then reuse these search results in replaceLocalValuesByOffsets or sumIntoLocalValuesByOffsets.

Offsets are block offsets; they are for column indices, not for values.

Parameters
localRowInd[in] Local index of the row.
offsets[out] On output: relative offsets corresponding to the given column indices. Must have at least numColInds entries.
colInds[in] The local column indices for which to compute offsets. Must have at least numColInds entries. This method will only read the first numColsInds entries.
numColInds[in] Number of entries in colInds to read.
Returns
The number of valid column indices in colInds. This method succeeded if and only if the return value equals the input argument numColInds.

Definition at line 955 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar, class LO, class GO , class Node >
LO Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::replaceLocalValuesByOffsets ( const LO  localRowInd,
const ptrdiff_t  offsets[],
const Scalar  vals[],
const LO  numOffsets 
) const

Like replaceLocalValues, but avoids computing row offsets.

Returns
The number of valid column indices in colInds. This method succeeded if and only if the return value equals the input argument numColInds.

Definition at line 988 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar, class LO, class GO , class Node >
LO Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::sumIntoLocalValuesByOffsets ( const LO  localRowInd,
const ptrdiff_t  offsets[],
const Scalar  vals[],
const LO  numOffsets 
) const

Like sumIntoLocalValues, but avoids computing row offsets.

Returns
The number of valid column indices in colInds. This method succeeded if and only if the return value equals the input argument numColInds.

Definition at line 1066 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO, class GO , class Node >
size_t Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getNumEntriesInLocalRow ( const LO  localRowInd) const
virtual

Return the number of entries in the given row on the calling process.

If the given local row index is invalid, this method (sensibly) returns zero, since the calling process trivially does not own any entries in that row.

Implements Tpetra::RowMatrix< Scalar, LO, GO, Node >.

Definition at line 1107 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar = Details::DefaultTypes::scalar_type, class LO = Details::DefaultTypes::local_ordinal_type, class GO = Details::DefaultTypes::global_ordinal_type, class Node = Details::DefaultTypes::node_type>
bool Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::localError ( ) const
inline

Whether this object had an error on the calling process.

Import and Export operations using this object as the target of the Import or Export may incur local errors, if some process encounters an LID in its list which is not a valid mesh row local index on that process. In that case, we don't want to throw an exception, because not all processes may throw an exception; this can result in deadlock or put Tpetra in an incorrect state, due to lack of consistency across processes. Instead, we set a local error flag and ignore the incorrect data. When unpacking, we do the same with invalid column indices. If you want to check whether some process experienced an error, you must do a reduction or all-reduce over this flag. Every time you initiate a new Import or Export with this object as the target, we clear this flag. (Note to developers: we clear it at the beginning of checkSizes().)

Definition at line 564 of file Tpetra_Experimental_BlockCrsMatrix_decl.hpp.

template<class Scalar = Details::DefaultTypes::scalar_type, class LO = Details::DefaultTypes::local_ordinal_type, class GO = Details::DefaultTypes::global_ordinal_type, class Node = Details::DefaultTypes::node_type>
std::string Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::errorMessages ( ) const
inline

The current stream of error messages.

This is only nonempty on the calling process if localError() returns true. In that case, it stores a stream of human-readable, endline-separated error messages encountered during an Import or Export cycle. Every time you initiate a new Import or Export with this object as the target, we clear this stream. (Note to developers: we clear it at the beginning of checkSizes().)

If you want to print this, you are responsible for ensuring that it is valid for the calling MPI process to print to whatever output stream you use. On some MPI implementations, you may need to send the string to Process 0 for printing.

Definition at line 582 of file Tpetra_Experimental_BlockCrsMatrix_decl.hpp.

template<class Scalar , class LO , class GO , class Node >
void Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getLocalDiagOffsets ( Teuchos::ArrayRCP< size_t > &  offsets) const

Get offsets of the diagonal entries in the matrix.

Warning
This method is only for expert users.
We make no promises about backwards compatibility for this method. It may disappear or change at any time.
This method must be called collectively. We reserve the right to do extra checking in a debug build that will require collectives.
Precondition
The matrix must be locally indexed (which means that it has a column Map).
All diagonal entries of the matrix's graph must be populated on this process. Results are undefined otherwise.
Postcondition
offsets.size() == getNodeNumRows()

This method creates an array of offsets of the local diagonal entries in the matrix. This array is suitable for use in the two-argument version of getLocalDiagCopy(). However, its contents are not defined in any other context. For example, you should not rely on offsets[i] being the index of the diagonal entry in the views returned by getLocalRowView(). This may be the case, but it need not be. (For example, we may choose to optimize the lookups down to the optimized storage level, in which case the offsets will be computed with respect to the underlying storage format, rather than with respect to the views.)

If the matrix has a const ("static") graph, and if that graph is fill complete, then the offsets array remains valid through calls to fillComplete() and resumeFill(). "Invalidates" means that you must call this method again to recompute the offsets.

Definition at line 416 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar, class LO, class GO, class Node>
void Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getLocalDiagCopy ( BlockCrsMatrix< Scalar, LO, GO, Node > &  diag,
const Teuchos::ArrayView< const size_t > &  offsets 
) const

Variant of getLocalDiagCopy() that uses precomputed offsets.

This method uses the offsets of the diagonal entries, as precomputed by getLocalDiagOffsets(), to speed up copying the diagonal of the matrix.

If the matrix has a const ("static") graph, and if that graph is fill complete, then the offsets array remains valid through calls to fillComplete() and resumeFill().

Definition at line 737 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar, class LO, class GO, class Node>
void Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getLocalDiagCopy ( const Kokkos::View< impl_scalar_type ***, device_type, Kokkos::MemoryUnmanaged > &  diag,
const Teuchos::ArrayView< const size_t > &  offsets 
) const

Variant of getLocalDiagCopy() that uses precomputed offsets and puts diagonal blocks in a 3-D Kokkos::View.

Parameters
diag[out] On input: Must be preallocated, with dimensions at least (number of diagonal blocks on the calling process) x getBlockSize() x getBlockSize(). On output: the diagonal blocks. Leftmost index is "which block," then the row index within a block, then the column index within a block.

This method uses the offsets of the diagonal entries, as precomputed by getLocalDiagOffsets(), to speed up copying the diagonal of the matrix.

Definition at line 768 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar, class LO, class GO , class Node >
LO Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::absMaxLocalValues ( const LO  localRowInd,
const LO  colInds[],
const Scalar  vals[],
const LO  numColInds 
) const
protected

Like sumIntoLocalValues, but for the ABSMAX combine mode.

Definition at line 805 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar, class LO, class GO , class Node >
LO Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::absMaxLocalValuesByOffsets ( const LO  localRowInd,
const ptrdiff_t  offsets[],
const Scalar  vals[],
const LO  numOffsets 
) const
protected

Like sumIntoLocalValuesByOffsets, but for the ABSMAX combine mode.

Definition at line 1027 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO , class GO , class Node >
bool Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::checkSizes ( const Tpetra::SrcDistObject source)
protectedvirtual

Compare the source and target (this) objects for compatibility.

Returns
True if they are compatible, else false.

Implements Tpetra::DistObject< char, LO, GO, Node >.

Definition at line 1493 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO, class GO , class Node >
void Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::copyAndPermute ( const Tpetra::SrcDistObject source,
size_t  numSameIDs,
const Teuchos::ArrayView< const LO > &  permuteToLIDs,
const Teuchos::ArrayView< const LO > &  permuteFromLIDs 
)
protectedvirtual

Perform copies and permutations that are local to this process.

Parameters
source[in] On entry, the source object, from which we are distributing. We distribute to the destination object, which is *this object.
numSameIDs[in] The umber of elements that are the same on the source and destination (this) objects. These elements are owned by the same process in both the source and destination objects. No permutation occurs.
numPermuteIDs[in] The number of elements that are locally permuted between the source and destination objects.
permuteToLIDs[in] List of the elements that are permuted. They are listed by their LID in the destination object.
permuteFromLIDs[in] List of the elements that are permuted. They are listed by their LID in the source object.

Reimplemented from Tpetra::DistObject< char, LO, GO, Node >.

Definition at line 1547 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO , class GO , class Node >
Teuchos::RCP< const Teuchos::Comm< int > > Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getComm ( ) const
virtual

The communicator over which this matrix is distributed.

Implements Tpetra::RowMatrix< Scalar, LO, GO, Node >.

Definition at line 2873 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO , class GO , class Node >
Teuchos::RCP< Node > Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getNode ( ) const
virtual

The Kokkos Node instance.

Implements Tpetra::RowMatrix< Scalar, LO, GO, Node >.

Definition at line 2881 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO , class GO , class Node >
global_size_t Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getGlobalNumCols ( ) const
virtual

The global number of columns of this matrix.

Implements Tpetra::RowMatrix< Scalar, LO, GO, Node >.

Definition at line 2890 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO , class GO , class Node >
size_t Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getNodeNumCols ( ) const
virtual

The number of columns needed to apply the forward operator on this node.

This is the same as the number of elements listed in the column Map. It is not necessarily the same as the number of domain Map elements owned by the calling process.

Implements Tpetra::RowMatrix< Scalar, LO, GO, Node >.

Definition at line 2898 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO , class GO , class Node >
GO Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getIndexBase ( ) const
virtual

The index base for global indices in this matrix.

Implements Tpetra::RowMatrix< Scalar, LO, GO, Node >.

Definition at line 2906 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO , class GO , class Node >
global_size_t Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getGlobalNumEntries ( ) const
virtual

The global number of stored (structurally nonzero) entries.

Implements Tpetra::RowMatrix< Scalar, LO, GO, Node >.

Definition at line 2914 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO , class GO , class Node >
size_t Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getNodeNumEntries ( ) const
virtual

The local number of stored (structurally nonzero) entries.

Implements Tpetra::RowMatrix< Scalar, LO, GO, Node >.

Definition at line 2922 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO , class GO, class Node >
size_t Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getNumEntriesInGlobalRow ( GO  globalRow) const
virtual

The current number of entries on the calling process in the specified global row.

Note that if the row Map is overlapping, then the calling process might not necessarily store all the entries in the row. Some other process might have the rest of the entries.

Returns
Teuchos::OrdinalTraits<size_t>::invalid() if the specified global row does not belong to this graph, else the number of entries.

Implements Tpetra::RowMatrix< Scalar, LO, GO, Node >.

Definition at line 2930 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO , class GO , class Node >
global_size_t Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getGlobalNumDiags ( ) const
virtual

The number of global diagonal entries, based on global row/column index comparisons.

Implements Tpetra::RowMatrix< Scalar, LO, GO, Node >.

Definition at line 2938 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO , class GO , class Node >
size_t Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getNodeNumDiags ( ) const
virtual

The number of local diagonal entries, based on global row/column index comparisons.

Implements Tpetra::RowMatrix< Scalar, LO, GO, Node >.

Definition at line 2946 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO , class GO , class Node >
size_t Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getGlobalMaxNumRowEntries ( ) const
virtual

The maximum number of entries across all rows/columns on all nodes.

Implements Tpetra::RowMatrix< Scalar, LO, GO, Node >.

Definition at line 2954 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO , class GO , class Node >
bool Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::hasColMap ( ) const
virtual

Whether this matrix has a well-defined column map.

Implements Tpetra::RowMatrix< Scalar, LO, GO, Node >.

Definition at line 2962 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO , class GO , class Node >
bool Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::isLowerTriangular ( ) const
virtual

Whether this matrix is lower triangular.

Implements Tpetra::RowMatrix< Scalar, LO, GO, Node >.

Definition at line 2970 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO , class GO , class Node >
bool Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::isUpperTriangular ( ) const
virtual

Whether this matrix is upper triangular.

Implements Tpetra::RowMatrix< Scalar, LO, GO, Node >.

Definition at line 2978 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO , class GO , class Node >
bool Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::isLocallyIndexed ( ) const
virtual

Whether matrix indices are locally indexed.

A RowMatrix may store column indices either as global indices (of type GO), or as local indices (of type LO). In some cases (for example, if the column Map has not been computed), it is not possible to switch from global to local indices without extra work. Furthermore, some operations only work for one or the other case.

Implements Tpetra::RowMatrix< Scalar, LO, GO, Node >.

Definition at line 2986 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO , class GO , class Node >
bool Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::isGloballyIndexed ( ) const
virtual

Whether matrix indices are globally indexed.

A RowMatrix may store column indices either as global indices (of type GO), or as local indices (of type LO). In some cases (for example, if the column Map has not been computed), it is not possible to switch from global to local indices without extra work. Furthermore, some operations only work for one or the other case.

Implements Tpetra::RowMatrix< Scalar, LO, GO, Node >.

Definition at line 2994 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO , class GO , class Node >
bool Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::isFillComplete ( ) const
virtual

Whether fillComplete() has been called.

Implements Tpetra::RowMatrix< Scalar, LO, GO, Node >.

Definition at line 3002 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO , class GO , class Node >
bool Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::supportsRowViews ( ) const
virtual

Whether this object implements getLocalRowView() and getGlobalRowView().

Implements Tpetra::RowMatrix< Scalar, LO, GO, Node >.

Definition at line 3010 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar, class LO , class GO, class Node >
void Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getGlobalRowCopy ( GO  GlobalRow,
const Teuchos::ArrayView< GO > &  Indices,
const Teuchos::ArrayView< Scalar > &  Values,
size_t &  NumEntries 
) const
virtual

Get a copy of the given global row's entries.

This method only gets the entries in the given row that are stored on the calling process. Note that if the matrix has an overlapping row Map, it is possible that the calling process does not store all the entries in that row.

Parameters
GlobalRow[in] Global index of the row.
Indices[out] Global indices of the columns corresponding to values.
Values[out] Matrix values.
NumEntries[out] Number of stored entries on the calling process; length of Indices and Values.

This method throws std::runtime_error if either Indices or Values is not large enough to hold the data associated with row GlobalRow. If GlobalRow does not belong to the calling process, then the method sets NumIndices to Teuchos::OrdinalTraits<size_t>::invalid(), and does not modify Indices or Values.

Implements Tpetra::RowMatrix< Scalar, LO, GO, Node >.

Definition at line 3019 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar, class LO , class GO, class Node >
void Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getGlobalRowView ( GO  GlobalRow,
Teuchos::ArrayView< const GO > &  indices,
Teuchos::ArrayView< const Scalar > &  values 
) const
virtual

Get a constant, nonpersisting, globally indexed view of the given row of the matrix.

The returned views of the column indices and values are not guaranteed to persist beyond the lifetime of this. Furthermore, some RowMatrix implementations allow changing the values, or the indices and values. Any such changes invalidate the returned views.

This method only gets the entries in the given row that are stored on the calling process. Note that if the matrix has an overlapping row Map, it is possible that the calling process does not store all the entries in that row.

Precondition
isGloballyIndexed () && supportsRowViews ()
Postcondition
indices.size () == getNumEntriesInGlobalRow (GlobalRow)
Parameters
GlobalRow[in] Global index of the row.
Indices[out] Global indices of the columns corresponding to values.
Values[out] Matrix values.

If GlobalRow does not belong to this node, then indices is set to null.

Definition at line 3033 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar, class LO, class GO, class Node>
void Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getLocalDiagCopy ( Tpetra::Vector< Scalar, LO, GO, Node > &  diag) const
virtual

Get a copy of the diagonal entries, distributed by the row Map.

On input, the Vector's Map must be the same as the row Map of the matrix. (That is, this->getRowMap ()->isSameAs (* (diag.getMap ())) == true.)

On return, the entries of diag are filled with the diagonal entries of the matrix stored on this process. Note that if the row Map is overlapping, multiple processes may own the same diagonal element. You may combine these overlapping diagonal elements by doing an Export from the row Map Vector to a range Map Vector.

Definition at line 3060 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar, class LO, class GO, class Node>
void Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::leftScale ( const Vector< Scalar, LO, GO, Node > &  x)
virtual

Scale the RowMatrix on the left with the given Vector x.

On return, for all entries i,j in the matrix, $A(i,j) = x(i)*A(i,j)$.

Definition at line 3095 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar, class LO, class GO, class Node>
void Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::rightScale ( const Vector< Scalar, LO, GO, Node > &  x)
virtual

Scale the RowMatrix on the right with the given Vector x.

On return, for all entries i,j in the matrix, $A(i,j) = x(j)*A(i,j)$.

Definition at line 3106 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

template<class Scalar , class LO , class GO , class Node >
Tpetra::RowMatrix< Scalar, LO, GO, Node >::mag_type Tpetra::Experimental::BlockCrsMatrix< Scalar, LO, GO, Node >::getFrobeniusNorm ( ) const
virtual

The Frobenius norm of the matrix.

This method computes and returns the Frobenius norm of the matrix. The Frobenius norm $\|A\|_F$ for the matrix $A$ is defined as $\|A\|_F = \sqrt{ \sum_{i,j} |A(i,j)|^2 }$. It has the same value as the Euclidean norm of a vector made by stacking the columns of $A$.

Implements Tpetra::RowMatrix< Scalar, LO, GO, Node >.

Definition at line 3125 of file Tpetra_Experimental_BlockCrsMatrix_def.hpp.

virtual void Tpetra::RowMatrix< Scalar, LO , GO , Node >::getGlobalRowView ( GO  GlobalRow,
ArrayView< const GO > &  indices,
ArrayView< const Scalar > &  values 
) const
pure virtualinherited

Get a constant, nonpersisting, globally indexed view of the given row of the matrix.

The returned views of the column indices and values are not guaranteed to persist beyond the lifetime of this. Furthermore, some RowMatrix implementations allow changing the values, or the indices and values. Any such changes invalidate the returned views.

This method only gets the entries in the given row that are stored on the calling process. Note that if the matrix has an overlapping row Map, it is possible that the calling process does not store all the entries in that row.

Precondition
isGloballyIndexed () && supportsRowViews ()
Postcondition
indices.size () == getNumEntriesInGlobalRow (GlobalRow)
Parameters
GlobalRow[in] Global index of the row.
Indices[out] Global indices of the columns corresponding to values.
Values[out] Matrix values.

If GlobalRow does not belong to this node, then indices is set to null.

virtual void Tpetra::RowMatrix< Scalar, LO , GO , Node >::getLocalRowView ( LO  LocalRow,
ArrayView< const LO > &  indices,
ArrayView< const Scalar > &  values 
) const
pure virtualinherited

Get a constant, nonpersisting, locally indexed view of the given row of the matrix.

The returned views of the column indices and values are not guaranteed to persist beyond the lifetime of this. Furthermore, some RowMatrix implementations allow changing the values, or the indices and values. Any such changes invalidate the returned views.

This method only gets the entries in the given row that are stored on the calling process. Note that if the matrix has an overlapping row Map, it is possible that the calling process does not store all the entries in that row.

Precondition
isLocallyIndexed () && supportsRowViews ()
Postcondition
indices.size () == getNumEntriesInGlobalRow (LocalRow)
Parameters
LocalRow[in] Local index of the row.
Indices[out] Local indices of the columns corresponding to values.
Values[out] Matrix values.

If LocalRow does not belong to this node, then indices is set to null.

virtual void Tpetra::RowMatrix< Scalar, LO , GO , Node >::getLocalDiagCopy ( Vector< Scalar, LO , GO , Node, Node::classic > &  diag) const
pure virtualinherited

Get a copy of the diagonal entries, distributed by the row Map.

On input, the Vector's Map must be the same as the row Map of the matrix. (That is, this->getRowMap ()->isSameAs (* (diag.getMap ())) == true.)

On return, the entries of diag are filled with the diagonal entries of the matrix stored on this process. Note that if the row Map is overlapping, multiple processes may own the same diagonal element. You may combine these overlapping diagonal elements by doing an Export from the row Map Vector to a range Map Vector.

virtual void Tpetra::RowMatrix< Scalar, LO , GO , Node >::leftScale ( const Vector< Scalar, LO , GO , Node, Node::classic > &  x)
pure virtualinherited

Scale the RowMatrix on the left with the given Vector x.

On return, for all entries i,j in the matrix, $A(i,j) = x(i)*A(i,j)$.

virtual void Tpetra::RowMatrix< Scalar, LO , GO , Node >::rightScale ( const Vector< Scalar, LO , GO , Node, Node::classic > &  x)
pure virtualinherited

Scale the RowMatrix on the right with the given Vector x.

On return, for all entries i,j in the matrix, $A(i,j) = x(j)*A(i,j)$.

virtual Teuchos::RCP<RowMatrix<Scalar, LO , GO , Node> > Tpetra::RowMatrix< Scalar, LO , GO , Node >::add ( const Scalar &  alpha,
const RowMatrix< Scalar, LO , GO , Node > &  A,
const Scalar &  beta,
const Teuchos::RCP< const Map< LO , GO , Node > > &  domainMap = Teuchos::null,
const Teuchos::RCP< const Map< LO , GO , Node > > &  rangeMap = Teuchos::null,
const Teuchos::RCP< Teuchos::ParameterList > &  params = Teuchos::null 
) const
virtualinherited

Return a new RowMatrix which is the result of beta*this + alpha*A.

The new RowMatrix is actually a CrsMatrix (which see). Note that RowMatrix is a read-only interface (not counting the left and right scale methods), so it is impossible to implement an in-place add using just that interface.

For brevity, call this matrix B, and the result matrix C. C's row Map will be identical to B's row Map. It is correct, though less efficient, for A and B not to have the same row Maps. We could make C's row Map the union of the two row Maps in that case. However, we don't want row Maps to grow for a repeated sequence of additions with matrices with different row Maps. Furthermore, the fact that the user called this method on B, rather than on A, suggests a preference for using B's distribution. The most reasonable thing to do, then, is to use B's row Map for C.

A and B must have identical or congruent communicators. This method must be called as a collective over B's communicator.

The parameters are optional and may be null. Here are the parameters that this function accepts:

  • "Call fillComplete" (bool): If true, call fillComplete on the result matrix C. This is true by default.
  • "Constructor parameters" (sublist): If provided, give these parameters to C's constructor.
  • "fillComplete parameters" (sublist): If provided, and if "Call fillComplete" is true, then give these parameters to C's fillComplete call.

It is not strictly necessary that a RowMatrix always have a domain and range Map. For example, a CrsMatrix does not have a domain and range Map until after its first fillComplete call. Neither A nor B need to have a domain and range Map in order to call add(). If at least one of them has a domain and range Map, you need not supply a domain and range Map to this method. If you ask this method to call fillComplete on C (it does by default), it will supply the any missing domain or range Maps from either B's or A's (in that order) domain and range Maps. If neither A nor B have a domain and range Map, and if you ask this method to call fillComplete, then you must supply both a domain Map and a range Map to this method.

This method comes with a default implementation, since the RowMatrix interface suffices for implementing it. Subclasses (like CrsMatrix) may override this implementation, for example to improve its performance, given additional knowledge about the subclass. Subclass implementations may need to do a dynamic cast on A in order to know its type.

virtual void Tpetra::RowMatrix< Scalar, LO , GO , Node >::pack ( const Teuchos::ArrayView< const LO > &  exportLIDs,
Teuchos::Array< char > &  exports,
const Teuchos::ArrayView< size_t > &  numPacketsPerLID,
size_t &  constantNumPackets,
Distributor distor 
) const
virtualinherited

Pack this object's data for an Import or Export.

Warning
To be called only by the packAndPrepare method of appropriate classes of DistObject.

Subclasses may override this method to speed up or otherwise improve the implementation by exploiting more specific details of the subclass.

Implements Tpetra::Packable< char, LO >.

virtual void Tpetra::Operator< Scalar, LO , GO , Node >::apply ( const MultiVector< Scalar, LO , GO , Node > &  X,
MultiVector< Scalar, LO , GO , Node > &  Y,
Teuchos::ETransp  mode = Teuchos::NO_TRANS,
Scalar  alpha = Teuchos::ScalarTraits<Scalar>::one(),
Scalar  beta = Teuchos::ScalarTraits<Scalar>::zero() 
) const
pure virtualinherited

Computes the operator-multivector application.

Loosely, performs $Y = \alpha \cdot A^{\textrm{mode}} \cdot X + \beta \cdot Y$. However, the details of operation vary according to the values of alpha and beta. Specifically

  • if beta == 0, apply() must overwrite Y, so that any values in Y (including NaNs) are ignored.
  • if alpha == 0, apply() may short-circuit the operator, so that any values in X (including NaNs) are ignored.
void Tpetra::DistObject< char , LO , GO , Node, Node::classic >::doImport ( const SrcDistObject< char, LO, GO, Node > &  source,
const Import< LO , GO , Node > &  importer,
CombineMode  CM 
)
inherited

Import data into this object using an Import object ("forward mode").

The input DistObject is always the source of the data redistribution operation, and the *this object is always the target.

If you don't know the difference between forward and reverse mode, then you probably want forward mode. Use this method with your precomputed Import object if you want to do an Import, else use doExport() with a precomputed Export object.

Parameters
source[in] The "source" object for redistribution.
importer[in] Precomputed data redistribution plan. Its source Map must be the same as the input DistObject's Map, and its target Map must be the same as this->getMap().
CM[in] How to combine incoming data with the same global index.
void Tpetra::DistObject< char , LO , GO , Node, Node::classic >::doImport ( const SrcDistObject< char, LO, GO, Node > &  source,
const Export< LO , GO , Node > &  exporter,
CombineMode  CM 
)
inherited

Import data into this object using an Export object ("reverse mode").

The input DistObject is always the source of the data redistribution operation, and the *this object is always the target.

If you don't know the difference between forward and reverse mode, then you probably want forward mode. Use the version of doImport() that takes a precomputed Import object in that case.

Parameters
source[in] The "source" object for redistribution.
exporter[in] Precomputed data redistribution plan. Its target Map must be the same as the input DistObject's Map, and its source Map must be the same as this->getMap(). (Note the difference from forward mode.)
CM[in] How to combine incoming data with the same global index.
void Tpetra::DistObject< char , LO , GO , Node, Node::classic >::doExport ( const SrcDistObject< char, LO, GO, Node > &  source,
const Export< LO , GO , Node > &  exporter,
CombineMode  CM 
)
inherited

Export data into this object using an Export object ("forward mode").

The input DistObject is always the source of the data redistribution operation, and the *this object is always the target.

If you don't know the difference between forward and reverse mode, then you probably want forward mode. Use this method with your precomputed Export object if you want to do an Export, else use doImport() with a precomputed Import object.

Parameters
source[in] The "source" object for redistribution.
exporter[in] Precomputed data redistribution plan. Its source Map must be the same as the input DistObject's Map, and its target Map must be the same as this->getMap().
CM[in] How to combine incoming data with the same global index.
void Tpetra::DistObject< char , LO , GO , Node, Node::classic >::doExport ( const SrcDistObject< char, LO, GO, Node > &  source,
const Import< LO , GO , Node > &  importer,
CombineMode  CM 
)
inherited

Export data into this object using an Import object ("reverse mode").

The input DistObject is always the source of the data redistribution operation, and the *this object is always the target.

If you don't know the difference between forward and reverse mode, then you probably want forward mode. Use the version of doExport() that takes a precomputed Export object in that case.

Parameters
source[in] The "source" object for redistribution.
importer[in] Precomputed data redistribution plan. Its target Map must be the same as the input DistObject's Map, and its source Map must be the same as this->getMap(). (Note the difference from forward mode.)
CM[in] How to combine incoming data with the same global index.
bool Tpetra::DistObject< char , LO , GO , Node, Node::classic >::isDistributed ( ) const
inherited

Whether this is a globally distributed object.

For a definition of "globally distributed" (and its opposite, "locally replicated"), see the documentation of Map's isDistributed() method.

virtual Teuchos::RCP<const map_type> Tpetra::DistObject< char , LO , GO , Node, Node::classic >::getMap ( ) const
inlinevirtualinherited

The Map describing the parallel distribution of this object.

Note that some Tpetra objects might be distributed using multiple Map objects. For example, CrsMatrix has both a row Map and a column Map. It is up to the subclass to decide which Map to use when invoking the DistObject constructor.

Definition at line 347 of file Tpetra_DistObject_decl.hpp.

void Tpetra::DistObject< char , LO , GO , Node, Node::classic >::print ( std::ostream &  os) const
inherited

Print this object to the given output stream.

We generally assume that all MPI processes can print to the given stream.

virtual void Tpetra::DistObject< char , LO , GO , Node, Node::classic >::removeEmptyProcessesInPlace ( const Teuchos::RCP< const map_type > &  newMap)
virtualinherited

Remove processes which contain no elements in this object's Map.

Warning
This method is ONLY for use by experts. We highly recommend using the nonmember function of the same name defined in this file.
We make NO promises of backwards compatibility. This method may change or disappear at any time.

On input, this object is distributed over the Map returned by getMap() (the "original Map," with its communicator, the "original communicator"). The input newMap of this method must be the same as the result of calling getMap()->removeEmptyProcesses(). On processes in the original communicator which contain zero elements ("excluded processes," as opposed to "included processes"), the input newMap must be Teuchos::null (which is what getMap()->removeEmptyProcesses() returns anyway).

On included processes, reassign this object's Map (that would be returned by getMap()) to the input newMap, and do any work that needs to be done to restore correct semantics. On excluded processes, free any data that needs freeing, and do any other work that needs to be done to restore correct semantics.

This method has collective semantics over the original communicator. On exit, the only method of this object which is safe to call on excluded processes is the destructor. This implies that subclasses' destructors must not contain communication operations.

Returns
The object's new Map. Its communicator is a new communicator, distinct from the old Map's communicator, which contains a subset of the processes in the old communicator.
Note
The name differs from Map's method removeEmptyProcesses(), in order to emphasize that the operation on DistObject happens in place, modifying the input, whereas the operation removeEmptyProcess() on Map does not modify the input.
To implementers of DistObject subclasses: The default implementation of this class throws std::logic_error.
virtual size_t Tpetra::DistObject< char , LO , GO , Node, Node::classic >::constantNumberOfPackets ( ) const
protectedvirtualinherited

Whether the implementation's instance promises always to have a constant number of packets per LID, and if so, how many packets per LID there are.

If this method returns zero, the instance says that it might possibly have a different number of packets for each LID to send or receive. If it returns nonzero, the instance promises that the number of packets is the same for all LIDs, and that the return value is this number of packets per LID.

The default implementation of this method returns zero. This does not affect the behavior of doTransfer() in any way. If a nondefault implementation returns nonzero, doTransfer() will use this information to avoid unnecessary allocation and / or resizing of arrays.

virtual void Tpetra::DistObject< char , LO , GO , Node, Node::classic >::doTransfer ( const SrcDistObject< char, LO, GO, Node > &  src,
CombineMode  CM,
size_t  numSameIDs,
const Teuchos::ArrayView< const local_ordinal_type > &  permuteToLIDs,
const Teuchos::ArrayView< const local_ordinal_type > &  permuteFromLIDs,
const Teuchos::ArrayView< const local_ordinal_type > &  remoteLIDs,
const Teuchos::ArrayView< const local_ordinal_type > &  exportLIDs,
Distributor distor,
ReverseOption  revOp 
)
protectedvirtualinherited

Redistribute data across memory images.

Parameters
src[in] The source object, to redistribute into the target object, which is *this object.
CM[in] The combine mode that describes how to combine values that map to the same global ID on the same process.
permuteToLIDs[in] See copyAndPermute().
permuteFromLIDs[in] See copyAndPermute().
remoteLIDs[in] List of entries (as local IDs) in the destination object to receive from other processes.
exportLIDs[in] See packAndPrepare().
distor[in/out] The Distributor object that knows how to redistribute data.
revOp[in] Whether to do a forward or reverse mode redistribution.
virtual bool Tpetra::DistObject< char , LO , GO , Node, Node::classic >::useNewInterface ( )
inlineprotectedvirtualinherited

Whether lass (???) implements old or new interface.

Definition at line 545 of file Tpetra_DistObject_decl.hpp.

virtual void Tpetra::DistObject< char , LO , GO , Node, Node::classic >::packAndPrepare ( const SrcDistObject< char, LO, GO, Node > &  source,
const Teuchos::ArrayView< const local_ordinal_type > &  exportLIDs,
Teuchos::Array< packet_type > &  exports,
const Teuchos::ArrayView< size_t > &  numPacketsPerLID,
size_t &  constantNumPackets,
Distributor distor 
)
inlineprotectedvirtualinherited

Perform any packing or preparation required for communication.

Parameters
source[in] Source object for the redistribution.
exportLIDs[in] List of the entries (as local IDs in the source object) we will be sending to other images.
exports[out] On exit, the buffer for data to send.
numPacketsPerLID[out] On exit, the implementation of this method must do one of two things: set numPacketsPerLID[i] to contain the number of packets to be exported for exportLIDs[i] and set constantNumPackets to zero, or set constantNumPackets to a nonzero value. If the latter, the implementation need not fill numPacketsPerLID.
constantNumPackets[out] On exit, 0 if numPacketsPerLID has variable contents (different size for each LID). If nonzero, then it is expected that the number of packets per LID is constant, and that constantNumPackets is that value.
distor[in] The Distributor object we are using.

Definition at line 600 of file Tpetra_DistObject_decl.hpp.

virtual void Tpetra::DistObject< char , LO , GO , Node, Node::classic >::unpackAndCombine ( const Teuchos::ArrayView< const local_ordinal_type > &  importLIDs,
const Teuchos::ArrayView< const packet_type > &  imports,
const Teuchos::ArrayView< size_t > &  numPacketsPerLID,
size_t  constantNumPackets,
Distributor distor,
CombineMode  CM 
)
inlineprotectedvirtualinherited

Perform any unpacking and combining after communication.

Parameters
importLIDs[in] List of the entries (as LIDs in the destination object) we received from other images.
imports[in] Buffer containing data we received.
numPacketsPerLID[in] If constantNumPackets is zero, then numPacketsPerLID[i] contains the number of packets imported for importLIDs[i].
constantNumPackets[in] If nonzero, then numPacketsPerLID is constant (same value in all entries) and constantNumPackets is that value. If zero, then numPacketsPerLID[i] is the number of packets imported for importLIDs[i].
distor[in] The Distributor object we are using.
CM[in] The combine mode to use when combining the imported entries with existing entries.

Definition at line 638 of file Tpetra_DistObject_decl.hpp.

virtual void Tpetra::DistObject< char , LO , GO , Node, Node::classic >::createViews ( ) const
protectedvirtualinherited

Hook for creating a const view.

doTransfer() calls this on the source object. By default, it does nothing, but the source object can use this as a hint to fetch data from a compute buffer on an off-CPU device (such as a GPU) into host memory.

virtual void Tpetra::DistObject< char , LO , GO , Node, Node::classic >::createViewsNonConst ( KokkosClassic::ReadWriteOption  rwo)
protectedvirtualinherited

Hook for creating a nonconst view.

doTransfer() calls this on the destination (*this) object. By default, it does nothing, but the destination object can use this as a hint to fetch data from a compute buffer on an off-CPU device (such as a GPU) into host memory.

Parameters
rwo[in] Whether to create a write-only or a read-and-write view. For Kokkos Node types where compute buffers live in a separate memory space (e.g., in the device memory of a discrete accelerator like a GPU), a write-only view only requires copying from host memory to the compute buffer, whereas a read-and-write view requires copying both ways (once to read, from the compute buffer to host memory, and once to write, back to the compute buffer).
virtual void Tpetra::DistObject< char , LO , GO , Node, Node::classic >::releaseViews ( ) const
protectedvirtualinherited

Hook for releasing views.

doTransfer() calls this on both the source and destination objects, once it no longer needs to access that object's data. By default, this method does nothing. Implementations may use this as a hint to free host memory which is a view of a compute buffer, once the host memory view is no longer needed. Some implementations may prefer to mirror compute buffers in host memory; for these implementations, releaseViews() may do nothing.

Member Data Documentation

Teuchos::RCP<const map_type> Tpetra::DistObject< char , LO , GO , Node, Node::classic >::map_
protectedinherited

The Map over which this object is distributed.

Definition at line 695 of file Tpetra_DistObject_decl.hpp.


The documentation for this class was generated from the following files: