Xpetra Version of the Day
Loading...
Searching...
No Matches
Xpetra::EpetraCrsMatrixT< int, EpetraNode > Class Reference

#include <Xpetra_EpetraCrsMatrix.hpp>

Inheritance diagram for Xpetra::EpetraCrsMatrixT< int, EpetraNode >:
Xpetra::CrsMatrix< double, int, int, EpetraNode > Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > Xpetra::DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > Teuchos::Describable Teuchos::LabeledObject

Private Types

typedef int GlobalOrdinal
 
typedef EpetraNode Node
 
typedef CrsMatrix< double, int, GlobalOrdinal, Node >::scalar_type Scalar
 
typedef CrsMatrix< double, int, GlobalOrdinal, Node >::local_ordinal_type LocalOrdinal
 
typedef Xpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_matrix_type local_matrix_type
 
typedef Xpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::node_type node_type
 

Xpetra specific

RCP< Epetra_CrsMatrixmtx_
 The underlying actual matrix object.
 
bool isFillResumed_
 Flag to keep track of fill status.
 
bool hasMatrix () const
 Does this have an underlying matrix.
 
 EpetraCrsMatrixT (const Teuchos::RCP< Epetra_CrsMatrix > &mtx)
 EpetraCrsMatrixT constructor to wrap a Epetra_CrsMatrix object.
 
RCP< const Epetra_CrsMatrixgetEpetra_CrsMatrix () const
 Get the underlying Epetra matrix.
 
RCP< Epetra_CrsMatrixgetEpetra_CrsMatrixNonConst () const
 Get the underlying Epetra matrix.
 
local_matrix_type getLocalMatrixDevice () const
 Compatibility layer for accessing the matrix data through a Kokkos interface.
 
local_matrix_type::HostMirror getLocalMatrixHost () const
 
void setAllValues (const typename local_matrix_type::row_map_type &ptr, const typename local_matrix_type::StaticCrsGraphType::entries_type::non_const_type &ind, const typename local_matrix_type::values_type &val)
 
LocalOrdinal GetStorageBlockSize () const
 Returns the block size of the storage mechanism, which is usually 1, except for Tpetra::BlockCrsMatrix.
 
void residual (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &R) const
 

Constructor/Destructor Methods

 EpetraCrsMatrixT (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rowMap)
 Constructor for empty DynamicProfile matrix (no space is preallocated).
 
 EpetraCrsMatrixT (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rowMap, size_t maxNumEntriesPerRow, const Teuchos::RCP< Teuchos::ParameterList > &=Teuchos::null)
 Constructor specifying fixed number of entries for each row.
 
 EpetraCrsMatrixT (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rowMap, const ArrayRCP< const size_t > &NumEntriesPerRowToAlloc, const Teuchos::RCP< Teuchos::ParameterList > &=Teuchos::null)
 Constructor specifying (possibly different) number of entries in each row.
 
 EpetraCrsMatrixT (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rowMap, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &colMap, size_t maxNumEntriesPerRow, const Teuchos::RCP< Teuchos::ParameterList > &=Teuchos::null)
 Constructor specifying column Map and fixed number of entries for each row.
 
 EpetraCrsMatrixT (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rowMap, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &colMap, const ArrayRCP< const size_t > &NumEntriesPerRowToAlloc, const Teuchos::RCP< Teuchos::ParameterList > &=Teuchos::null)
 Constructor specifying row and column Maps and number of entries in each row.
 
 EpetraCrsMatrixT (const Teuchos::RCP< const CrsGraph< LocalOrdinal, GlobalOrdinal, Node > > &graph, const Teuchos::RCP< Teuchos::ParameterList > &=Teuchos::null)
 Constructor specifying a previously constructed graph.
 
 EpetraCrsMatrixT (const Teuchos::RCP< const CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &sourceMatrix, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &domainMap=Teuchos::null, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rangeMap=Teuchos::null, const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null)
 Constructor for a fused import.
 
 EpetraCrsMatrixT (const Teuchos::RCP< const CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &sourceMatrix, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &domainMap=Teuchos::null, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rangeMap=Teuchos::null, const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null)
 Constructor for a fused export.
 
 EpetraCrsMatrixT (const Teuchos::RCP< const CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &sourceMatrix, const Import< LocalOrdinal, GlobalOrdinal, Node > &RowImporter, const Teuchos::RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > DomainImporter, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &domainMap, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rangeMap, const Teuchos::RCP< Teuchos::ParameterList > &params)
 
 EpetraCrsMatrixT (const Teuchos::RCP< const CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &sourceMatrix, const Export< LocalOrdinal, GlobalOrdinal, Node > &RowExporter, const Teuchos::RCP< const Export< LocalOrdinal, GlobalOrdinal, Node > > DomainExporter, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &domainMap, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rangeMap, const Teuchos::RCP< Teuchos::ParameterList > &params)
 
 EpetraCrsMatrixT (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rowMap, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &colMap, const local_matrix_type &lclMatrix, const Teuchos::RCP< Teuchos::ParameterList > &params=null)
 Constructor specifying column Map and a local matrix, which the resulting CrsMatrix views.
 
 EpetraCrsMatrixT (const local_matrix_type &lclMatrix, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rowMap, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &colMap, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &domainMap=Teuchos::null, const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rangeMap=Teuchos::null, const Teuchos::RCP< Teuchos::ParameterList > &params=null)
 
virtual ~EpetraCrsMatrixT ()
 Destructor.
 

Insertion/Removal Methods

void insertGlobalValues (GlobalOrdinal globalRow, const ArrayView< const GlobalOrdinal > &cols, const ArrayView< const Scalar > &vals)
 Insert matrix entries, using global IDs.
 
void insertLocalValues (LocalOrdinal localRow, const ArrayView< const LocalOrdinal > &cols, const ArrayView< const Scalar > &vals)
 Insert matrix entries, using local IDs.
 
void replaceGlobalValues (GlobalOrdinal globalRow, const ArrayView< const GlobalOrdinal > &indices, const ArrayView< const Scalar > &values)
 Replace matrix entries, using global IDs.
 
void replaceLocalValues (LocalOrdinal localRow, const ArrayView< const LocalOrdinal > &indices, const ArrayView< const Scalar > &values)
 Replace matrix entries, using local IDs.
 
void setAllToScalar (const Scalar &alpha)
 Set all matrix entries equal to scalarThis.
 
void scale (const Scalar &alpha)
 Scale the current values of a matrix, this = alpha*this.
 
void allocateAllValues (size_t numNonZeros, ArrayRCP< size_t > &rowptr, ArrayRCP< LocalOrdinal > &colind, ArrayRCP< Scalar > &values)
 Allocates and returns ArrayRCPs of the Crs arrays — This is an Xpetra-only routine.
 
void setAllValues (const ArrayRCP< size_t > &rowptr, const ArrayRCP< LocalOrdinal > &colind, const ArrayRCP< Scalar > &values)
 Sets the 1D pointer arrays of the graph.
 
void getAllValues (ArrayRCP< const size_t > &rowptr, ArrayRCP< const LocalOrdinal > &colind, ArrayRCP< const Scalar > &values) const
 Gets the 1D pointer arrays of the graph.
 
void getAllValues (ArrayRCP< Scalar > &values)
 Gets the 1D pointer arrays of the graph.
 
bool haveGlobalConstants () const
 Returns true if globalConstants have been computed; false otherwise.
 
void expertStaticFillComplete (const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &domainMap, const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rangeMap, const RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > &importer=Teuchos::null, const RCP< const Export< LocalOrdinal, GlobalOrdinal, Node > > &exporter=Teuchos::null, const RCP< ParameterList > &=Teuchos::null)
 Expert static fill complete.
 

Transformational Methods

void resumeFill (const RCP< ParameterList > &=Teuchos::null)
 
void fillComplete (const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &domainMap, const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &rangeMap, const RCP< ParameterList > &params=Teuchos::null)
 Signal that data entry is complete, specifying domain and range maps.
 
void fillComplete (const RCP< ParameterList > &params=Teuchos::null)
 Signal that data entry is complete.
 
void replaceDomainMapAndImporter (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &newDomainMap, Teuchos::RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > &newImporter)
 Replaces the current domainMap and importer with the user-specified objects.
 

Methods implementing RowMatrix

const RCP< const Comm< int > > getComm () const
 Returns the communicator.
 
const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getRowMap () const
 Returns the Map that describes the row distribution in this matrix.
 
const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getColMap () const
 Returns the Map that describes the column distribution in this matrix.
 
RCP< const CrsGraph< LocalOrdinal, GlobalOrdinal, Node > > getCrsGraph () const
 Returns the CrsGraph associated with this matrix.
 
global_size_t getGlobalNumRows () const
 Number of global elements in the row map of this matrix.
 
global_size_t getGlobalNumCols () const
 Number of global columns in the matrix.
 
size_t getLocalNumRows () const
 Returns the number of matrix rows owned on the calling node.
 
size_t getLocalNumCols () const
 Returns the number of columns connected to the locally owned rows of this matrix.
 
global_size_t getGlobalNumEntries () const
 Returns the global number of entries in this matrix.
 
size_t getLocalNumEntries () const
 Returns the local number of entries in this matrix.
 
size_t getNumEntriesInLocalRow (LocalOrdinal localRow) const
 Returns the current number of entries on this node in the specified local row.
 
size_t getNumEntriesInGlobalRow (GlobalOrdinal globalRow) const
 Returns the current number of entries on this node in the specified (locally owned) global row.
 
size_t getGlobalMaxNumRowEntries () const
 Returns the maximum number of entries across all rows/columns on all nodes.
 
size_t getLocalMaxNumRowEntries () const
 Returns the maximum number of entries across all rows/columns on this node.
 
bool isLocallyIndexed () const
 If matrix indices are in the local range, this function returns true. Otherwise, this function returns false.
 
bool isGloballyIndexed () const
 If matrix indices are in the global range, this function returns true. Otherwise, this function returns false.
 
bool isFillComplete () const
 Returns true if the matrix is in compute mode, i.e. if fillComplete() has been called.
 
bool isFillActive () const
 Returns true if the matrix is in edit mode.
 
ScalarTraits< Scalar >::magnitudeType getFrobeniusNorm () const
 Returns the Frobenius norm of the matrix.
 
bool supportsRowViews () const
 Returns true if getLocalRowView() and getGlobalRowView() are valid for this class.
 
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.
 
void getGlobalRowCopy (GlobalOrdinal GlobalRow, const ArrayView< GlobalOrdinal > &Indices, const ArrayView< Scalar > &Values, size_t &NumEntries) const
 Extract a list of entries in a specified global row of this matrix. Put into pre-allocated storage.
 
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.
 
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.
 
void getLocalDiagCopy (Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &diag) const
 Get a copy of the diagonal entries owned by this node, with local row indices.
 
void getLocalDiagOffsets (Teuchos::ArrayRCP< size_t > &) const
 Get offsets of the diagonal entries in the matrix.
 
void getLocalDiagCopy (Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &, const Teuchos::ArrayView< const size_t > &) const
 Get a copy of the diagonal entries owned by this node, with local row indices, using row offsets.
 
void replaceDiag (const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &diag)
 Replace the diagonal entries of the matrix.
 
void leftScale (const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x)
 
void rightScale (const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x)
 

Methods implementing Operator

void apply (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, Scalar alpha=ScalarTraits< Scalar >::one(), Scalar beta=ScalarTraits< Scalar >::zero()) const
 Computes the sparse matrix-multivector multiplication.
 
void apply (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Y, Teuchos::ETransp mode, Scalar alpha, Scalar beta, bool sumInterfaceValues, const RCP< Import< LocalOrdinal, GlobalOrdinal, Node > > &regionInterfaceImporter, const Teuchos::ArrayRCP< LocalOrdinal > &regionInterfaceLIDs) const
 
const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getDomainMap () const
 Returns the Map associated with the domain of this operator. This will be null until fillComplete() is called.
 
const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getRangeMap () const
 Returns the Map associated with the range of this operator, which must be compatible with Y.getMap().
 

Overridden from Teuchos::Describable

std::string description () const
 A simple one-line description of this object.
 
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.
 
void setObjectLabel (const std::string &objectLabel)
 
 EpetraCrsMatrixT (const EpetraCrsMatrixT &matrix)
 Deep copy constructor.
 
Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > getMap () const
 Implements DistObject interface.
 
void doImport (const DistObject< char, LocalOrdinal, GlobalOrdinal, Node > &source, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)
 Import.
 
void doExport (const DistObject< char, LocalOrdinal, GlobalOrdinal, Node > &dest, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)
 Export.
 
void doImport (const DistObject< char, LocalOrdinal, GlobalOrdinal, Node > &source, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM)
 Import (using an Exporter).
 
void doExport (const DistObject< char, LocalOrdinal, GlobalOrdinal, Node > &dest, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM)
 Export (using an Importer).
 
void removeEmptyProcessesInPlace (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &newMap)
 

Additional Inherited Members

- Public Types inherited from Xpetra::CrsMatrix< double, int, int, EpetraNode >
typedef double scalar_type
 
typedef int local_ordinal_type
 
typedef int global_ordinal_type
 
typedef EpetraNode node_type
 
using impl_scalar_type = typename Kokkos::Details::ArithTraits< double >::val_type
 
using execution_space = typename node_type::device_type
 
using local_graph_type = Kokkos::StaticCrsGraph< int, Kokkos::LayoutLeft, execution_space, void, size_t >
 
using local_matrix_type = KokkosSparse::CrsMatrix< impl_scalar_type, int, execution_space, void, typename local_graph_type::size_type >
 The specialization of Kokkos::CrsMatrix that represents the part of the sparse matrix on each MPI process. The same as for Tpetra.
 
- Public Types inherited from Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >
typedef Scalar scalar_type
 
typedef LocalOrdinal local_ordinal_type
 
typedef GlobalOrdinal global_ordinal_type
 
typedef Node node_type
 
- Public Member Functions inherited from Xpetra::CrsMatrix< double, int, int, EpetraNode >
virtual void setAllValues (const typename local_matrix_type::row_map_type &ptr, const typename local_graph_type::entries_type::non_const_type &ind, const typename local_matrix_type::values_type &val)=0
 
virtual void getLocalRowCopy (int LocalRow, const ArrayView< int > &Indices, const ArrayView< double > &Values, size_t &NumEntries) const=0
 Extract a list of entries in a specified local row of the matrix. Put into storage allocated by calling routine.
 
virtual void residual (const MultiVector< double, int, int, EpetraNode > &X, const MultiVector< double, int, int, EpetraNode > &B, MultiVector< double, int, int, EpetraNode > &R) const=0
 Compute a residual R = B - (*this) * X.
 
virtual ~CrsMatrix ()
 Destructor.
 
virtual void insertGlobalValues (int globalRow, const ArrayView< const int > &cols, const ArrayView< const double > &vals)=0
 Insert matrix entries, using global IDs.
 
virtual void insertLocalValues (int localRow, const ArrayView< const int > &cols, const ArrayView< const double > &vals)=0
 Insert matrix entries, using local IDs.
 
virtual void replaceGlobalValues (int globalRow, const ArrayView< const int > &cols, const ArrayView< const double > &vals)=0
 Replace matrix entries, using global IDs.
 
virtual void replaceLocalValues (int localRow, const ArrayView< const int > &cols, const ArrayView< const double > &vals)=0
 Replace matrix entries, using local IDs.
 
virtual void setAllToScalar (const double &alpha)=0
 Set all matrix entries equal to scalarThis.
 
virtual void scale (const double &alpha)=0
 Scale the current values of a matrix, this = alpha*this.
 
virtual void allocateAllValues (size_t numNonZeros, ArrayRCP< size_t > &rowptr, ArrayRCP< int > &colind, ArrayRCP< double > &values)=0
 Allocates and returns ArrayRCPs of the Crs arrays — This is an Xpetra-only routine.
 
virtual void setAllValues (const ArrayRCP< size_t > &rowptr, const ArrayRCP< int > &colind, const ArrayRCP< double > &values)=0
 Sets the 1D pointer arrays of the graph.
 
virtual void getAllValues (ArrayRCP< const size_t > &rowptr, ArrayRCP< const int > &colind, ArrayRCP< const double > &values) const=0
 Gets the 1D pointer arrays of the graph.
 
virtual void getAllValues (ArrayRCP< double > &values)=0
 Gets the 1D pointer arrays of the graph.
 
virtual void fillComplete (const RCP< const Map< int, int, EpetraNode > > &domainMap, const RCP< const Map< int, int, EpetraNode > > &rangeMap, const RCP< ParameterList > &params=null)=0
 Signal that data entry is complete, specifying domain and range maps.
 
virtual void replaceDomainMapAndImporter (const Teuchos::RCP< const Map< int, int, EpetraNode > > &newDomainMap, Teuchos::RCP< const Import< int, int, EpetraNode > > &newImporter)=0
 Replaces the current domainMap and importer with the user-specified objects.
 
virtual void expertStaticFillComplete (const RCP< const Map< int, int, EpetraNode > > &domainMap, const RCP< const Map< int, int, EpetraNode > > &rangeMap, const RCP< const Import< int, int, EpetraNode > > &importer=Teuchos::null, const RCP< const Export< int, int, EpetraNode > > &exporter=Teuchos::null, const RCP< ParameterList > &params=Teuchos::null)=0
 Expert static fill complete.
 
virtual size_t getNumEntriesInLocalRow (int localRow) const=0
 Returns the current number of entries on this node in the specified local row.
 
virtual void getGlobalRowView (int GlobalRow, ArrayView< const int > &indices, ArrayView< const double > &values) const=0
 Extract a const, non-persisting view of global indices in a specified row of the matrix.
 
virtual void getGlobalRowCopy (int GlobalRow, const ArrayView< int > &indices, const ArrayView< double > &values, size_t &numEntries) const=0
 Extract a list of entries in a specified global row of this matrix. Put into pre-allocated storage.
 
virtual void getLocalRowView (int LocalRow, ArrayView< const int > &indices, ArrayView< const double > &values) const=0
 Extract a const, non-persisting view of local indices in a specified row of the matrix.
 
virtual void getLocalDiagCopy (Vector< double, int, int, EpetraNode > &diag) const=0
 Get a copy of the diagonal entries owned by this node, with local row indices.
 
virtual void getLocalDiagCopy (Vector< double, int, int, EpetraNode > &diag, const Teuchos::ArrayView< const size_t > &offsets) const=0
 Get a copy of the diagonal entries owned by this node, with local row indices, using row offsets.
 
virtual void replaceDiag (const Vector< double, int, int, EpetraNode > &diag)=0
 Replace the diagonal entries of the matrix.
 
virtual void leftScale (const Vector< double, int, int, EpetraNode > &x)=0
 Left scale matrix using the given vector entries.
 
virtual void rightScale (const Vector< double, int, int, EpetraNode > &x)=0
 Right scale matrix using the given vector entries.
 
virtual void removeEmptyProcessesInPlace (const RCP< const Map< int, int, EpetraNode > > &newMap)=0
 
virtual void apply (const MultiVector< double, int, int, EpetraNode > &X, MultiVector< double, int, int, EpetraNode > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, double alpha=ScalarTraits< double >::one(), double beta=ScalarTraits< double >::zero()) const=0
 Computes the sparse matrix-multivector multiplication.
 
virtual void apply (const MultiVector< double, int, int, EpetraNode > &X, MultiVector< double, int, int, EpetraNode > &Y, Teuchos::ETransp mode, double alpha, double beta, bool sumInterfaceValues, const RCP< Import< int, int, EpetraNode > > &regionInterfaceImporter, const Teuchos::ArrayRCP< int > &regionInterfaceLIDs) const=0
 Computes the sparse matrix-multivector multiplication for region layout matrices.
 
- Public Member Functions inherited from Xpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >
virtual ~RowMatrix ()
 Destructor.
 
virtual size_t getNumEntriesInLocalRow (LocalOrdinal localRow) const =0
 Returns the current number of entries on this node in the specified local row.
 
virtual void getLocalRowCopy (LocalOrdinal LocalRow, const Teuchos::ArrayView< LocalOrdinal > &Indices, const Teuchos::ArrayView< Scalar > &Values, size_t &NumEntries) const =0
 Extract a list of entries in a specified local row of the graph. Put into storage allocated by calling routine.
 
virtual void getGlobalRowView (GlobalOrdinal GlobalRow, ArrayView< const GlobalOrdinal > &indices, ArrayView< const Scalar > &values) const =0
 Extract a const, non-persisting view of global indices in a specified row of the matrix.
 
virtual void getLocalRowView (LocalOrdinal LocalRow, ArrayView< const LocalOrdinal > &indices, ArrayView< const Scalar > &values) const =0
 Extract a const, non-persisting view of local indices in a specified row of the matrix.
 
virtual void getLocalDiagCopy (Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &diag) const =0
 Get a copy of the diagonal entries owned by this node, with local row indices.
 
virtual void apply (const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, 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.
 
- Public Member Functions inherited from Xpetra::DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node >
virtual ~DistObject ()
 Destructor.
 
virtual void doImport (const DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > &source, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)=0
 Import data into this object using an Import object ("forward mode").
 
virtual void beginImport (const DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > &source, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)
 Import data into this object using an Import object ("forward mode").
 
virtual void endImport (const DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > &source, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)
 Import data into this object using an Import object ("forward mode").
 
virtual void doExport (const DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > &source, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM)=0
 Export data into this object using an Export object ("forward mode").
 
virtual void beginExport (const DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > &source, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM)
 Export data into this object using an Export object ("forward mode").
 
virtual void endExport (const DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > &source, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM)
 Export data into this object using an Export object ("forward mode").
 
virtual void doImport (const DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > &source, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM)=0
 Import data into this object using an Export object ("reverse mode").
 
virtual void beginImport (const DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > &source, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM)
 Import data into this object using an Export object ("reverse mode").
 
virtual void endImport (const DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > &source, const Export< LocalOrdinal, GlobalOrdinal, Node > &exporter, CombineMode CM)
 Import data into this object using an Export object ("reverse mode").
 
virtual void doExport (const DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > &source, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)=0
 Export data into this object using an Import object ("reverse mode").
 
virtual void beginExport (const DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > &source, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)
 Export data into this object using an Import object ("reverse mode").
 
virtual void endExport (const DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node > &source, const Import< LocalOrdinal, GlobalOrdinal, Node > &importer, CombineMode CM)
 Export data into this object using an Import object ("reverse mode").
 
- 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
 

Detailed Description

Definition at line 276 of file Xpetra_EpetraCrsMatrix.hpp.

Member Typedef Documentation

◆ GlobalOrdinal

typedef int Xpetra::EpetraCrsMatrixT< int, EpetraNode >::GlobalOrdinal
private

Definition at line 279 of file Xpetra_EpetraCrsMatrix.hpp.

◆ Node

typedef EpetraNode Xpetra::EpetraCrsMatrixT< int, EpetraNode >::Node
private

Definition at line 280 of file Xpetra_EpetraCrsMatrix.hpp.

◆ Scalar

typedef CrsMatrix<double,int,GlobalOrdinal,Node>::scalar_type Xpetra::EpetraCrsMatrixT< int, EpetraNode >::Scalar
private

Definition at line 281 of file Xpetra_EpetraCrsMatrix.hpp.

◆ LocalOrdinal

typedef CrsMatrix<double,int,GlobalOrdinal,Node>::local_ordinal_type Xpetra::EpetraCrsMatrixT< int, EpetraNode >::LocalOrdinal
private

Definition at line 282 of file Xpetra_EpetraCrsMatrix.hpp.

◆ local_matrix_type

typedef Xpetra::CrsMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node>::local_matrix_type Xpetra::EpetraCrsMatrixT< int, EpetraNode >::local_matrix_type
private

Definition at line 287 of file Xpetra_EpetraCrsMatrix.hpp.

◆ node_type

Definition at line 288 of file Xpetra_EpetraCrsMatrix.hpp.

Constructor & Destructor Documentation

◆ EpetraCrsMatrixT() [1/14]

Xpetra::EpetraCrsMatrixT< int, EpetraNode >::EpetraCrsMatrixT ( const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  rowMap)
inline

Constructor for empty DynamicProfile matrix (no space is preallocated).

Definition at line 297 of file Xpetra_EpetraCrsMatrix.hpp.

◆ EpetraCrsMatrixT() [2/14]

Xpetra::EpetraCrsMatrixT< int, EpetraNode >::EpetraCrsMatrixT ( const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  rowMap,
size_t  maxNumEntriesPerRow,
const Teuchos::RCP< Teuchos::ParameterList > &  = Teuchos::null 
)
inline

Constructor specifying fixed number of entries for each row.

Definition at line 302 of file Xpetra_EpetraCrsMatrix.hpp.

◆ EpetraCrsMatrixT() [3/14]

Xpetra::EpetraCrsMatrixT< int, EpetraNode >::EpetraCrsMatrixT ( const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  rowMap,
const ArrayRCP< const size_t > &  NumEntriesPerRowToAlloc,
const Teuchos::RCP< Teuchos::ParameterList > &  = Teuchos::null 
)
inline

Constructor specifying (possibly different) number of entries in each row.

Definition at line 308 of file Xpetra_EpetraCrsMatrix.hpp.

◆ EpetraCrsMatrixT() [4/14]

Xpetra::EpetraCrsMatrixT< int, EpetraNode >::EpetraCrsMatrixT ( const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  rowMap,
const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  colMap,
size_t  maxNumEntriesPerRow,
const Teuchos::RCP< Teuchos::ParameterList > &  = Teuchos::null 
)
inline

Constructor specifying column Map and fixed number of entries for each row.

Definition at line 317 of file Xpetra_EpetraCrsMatrix.hpp.

◆ EpetraCrsMatrixT() [5/14]

Xpetra::EpetraCrsMatrixT< int, EpetraNode >::EpetraCrsMatrixT ( const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  rowMap,
const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  colMap,
const ArrayRCP< const size_t > &  NumEntriesPerRowToAlloc,
const Teuchos::RCP< Teuchos::ParameterList > &  = Teuchos::null 
)
inline

Constructor specifying row and column Maps and number of entries in each row.

Definition at line 323 of file Xpetra_EpetraCrsMatrix.hpp.

◆ EpetraCrsMatrixT() [6/14]

Xpetra::EpetraCrsMatrixT< int, EpetraNode >::EpetraCrsMatrixT ( const Teuchos::RCP< const CrsGraph< LocalOrdinal, GlobalOrdinal, Node > > &  graph,
const Teuchos::RCP< Teuchos::ParameterList > &  = Teuchos::null 
)
inline

Constructor specifying a previously constructed graph.

Definition at line 332 of file Xpetra_EpetraCrsMatrix.hpp.

◆ EpetraCrsMatrixT() [7/14]

Xpetra::EpetraCrsMatrixT< int, EpetraNode >::EpetraCrsMatrixT ( const Teuchos::RCP< const CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &  sourceMatrix,
const Import< LocalOrdinal, GlobalOrdinal, Node > &  importer,
const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  domainMap = Teuchos::null,
const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  rangeMap = Teuchos::null,
const Teuchos::RCP< Teuchos::ParameterList > &  params = Teuchos::null 
)
inline

Constructor for a fused import.

Definition at line 338 of file Xpetra_EpetraCrsMatrix.hpp.

◆ EpetraCrsMatrixT() [8/14]

Xpetra::EpetraCrsMatrixT< int, EpetraNode >::EpetraCrsMatrixT ( const Teuchos::RCP< const CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &  sourceMatrix,
const Export< LocalOrdinal, GlobalOrdinal, Node > &  exporter,
const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  domainMap = Teuchos::null,
const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  rangeMap = Teuchos::null,
const Teuchos::RCP< Teuchos::ParameterList > &  params = Teuchos::null 
)
inline

Constructor for a fused export.

Definition at line 362 of file Xpetra_EpetraCrsMatrix.hpp.

◆ EpetraCrsMatrixT() [9/14]

Xpetra::EpetraCrsMatrixT< int, EpetraNode >::EpetraCrsMatrixT ( const Teuchos::RCP< const CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &  sourceMatrix,
const Import< LocalOrdinal, GlobalOrdinal, Node > &  RowImporter,
const Teuchos::RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > >  DomainImporter,
const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  domainMap,
const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  rangeMap,
const Teuchos::RCP< Teuchos::ParameterList > &  params 
)
inline

Definition at line 382 of file Xpetra_EpetraCrsMatrix.hpp.

◆ EpetraCrsMatrixT() [10/14]

Xpetra::EpetraCrsMatrixT< int, EpetraNode >::EpetraCrsMatrixT ( const Teuchos::RCP< const CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &  sourceMatrix,
const Export< LocalOrdinal, GlobalOrdinal, Node > &  RowExporter,
const Teuchos::RCP< const Export< LocalOrdinal, GlobalOrdinal, Node > >  DomainExporter,
const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  domainMap,
const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  rangeMap,
const Teuchos::RCP< Teuchos::ParameterList > &  params 
)
inline

Definition at line 405 of file Xpetra_EpetraCrsMatrix.hpp.

◆ EpetraCrsMatrixT() [11/14]

Xpetra::EpetraCrsMatrixT< int, EpetraNode >::EpetraCrsMatrixT ( const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  rowMap,
const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  colMap,
const local_matrix_type lclMatrix,
const Teuchos::RCP< Teuchos::ParameterList > &  params = null 
)
inline

Constructor specifying column Map and a local matrix, which the resulting CrsMatrix views.

Unlike most other CrsMatrix constructors, successful completion of this constructor will result in a fill-complete matrix.

Parameters
rowMap[in] Distribution of rows of the matrix.
colMap[in] Distribution of columns of the matrix.
lclMatrix[in] A local CrsMatrix containing all local matrix values as well as a local graph. The graph's local row indices must come from the specified row Map, and its local column indices must come from the specified column Map.
params[in/out] Optional list of parameters. If not null, any missing parameters will be filled in with their default values.

Definition at line 450 of file Xpetra_EpetraCrsMatrix.hpp.

◆ EpetraCrsMatrixT() [12/14]

Xpetra::EpetraCrsMatrixT< int, EpetraNode >::EpetraCrsMatrixT ( const local_matrix_type lclMatrix,
const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  rowMap,
const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  colMap,
const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  domainMap = Teuchos::null,
const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  rangeMap = Teuchos::null,
const Teuchos::RCP< Teuchos::ParameterList > &  params = null 
)
inline

Definition at line 458 of file Xpetra_EpetraCrsMatrix.hpp.

◆ ~EpetraCrsMatrixT()

virtual Xpetra::EpetraCrsMatrixT< int, EpetraNode >::~EpetraCrsMatrixT ( )
inlinevirtual

Destructor.

Definition at line 524 of file Xpetra_EpetraCrsMatrix.hpp.

◆ EpetraCrsMatrixT() [13/14]

Xpetra::EpetraCrsMatrixT< int, EpetraNode >::EpetraCrsMatrixT ( const EpetraCrsMatrixT< int, EpetraNode > &  matrix)
inline

Deep copy constructor.

Definition at line 1139 of file Xpetra_EpetraCrsMatrix.hpp.

◆ EpetraCrsMatrixT() [14/14]

Xpetra::EpetraCrsMatrixT< int, EpetraNode >::EpetraCrsMatrixT ( const Teuchos::RCP< Epetra_CrsMatrix > &  mtx)
inline

EpetraCrsMatrixT constructor to wrap a Epetra_CrsMatrix object.

Definition at line 1219 of file Xpetra_EpetraCrsMatrix.hpp.

Member Function Documentation

◆ insertGlobalValues()

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::insertGlobalValues ( GlobalOrdinal  globalRow,
const ArrayView< const GlobalOrdinal > &  cols,
const ArrayView< const Scalar > &  vals 
)
inline

Insert matrix entries, using global IDs.

Definition at line 532 of file Xpetra_EpetraCrsMatrix.hpp.

◆ insertLocalValues()

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::insertLocalValues ( LocalOrdinal  localRow,
const ArrayView< const LocalOrdinal > &  cols,
const ArrayView< const Scalar > &  vals 
)
inline

Insert matrix entries, using local IDs.

Definition at line 539 of file Xpetra_EpetraCrsMatrix.hpp.

◆ replaceGlobalValues()

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::replaceGlobalValues ( GlobalOrdinal  globalRow,
const ArrayView< const GlobalOrdinal > &  indices,
const ArrayView< const Scalar > &  values 
)
inline

Replace matrix entries, using global IDs.

Definition at line 545 of file Xpetra_EpetraCrsMatrix.hpp.

◆ replaceLocalValues()

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::replaceLocalValues ( LocalOrdinal  localRow,
const ArrayView< const LocalOrdinal > &  indices,
const ArrayView< const Scalar > &  values 
)
inline

Replace matrix entries, using local IDs.

Definition at line 564 of file Xpetra_EpetraCrsMatrix.hpp.

◆ setAllToScalar()

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::setAllToScalar ( const Scalar alpha)
inline

Set all matrix entries equal to scalarThis.

Definition at line 584 of file Xpetra_EpetraCrsMatrix.hpp.

◆ scale()

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::scale ( const Scalar alpha)
inline

Scale the current values of a matrix, this = alpha*this.

Definition at line 587 of file Xpetra_EpetraCrsMatrix.hpp.

◆ allocateAllValues()

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::allocateAllValues ( size_t  numNonZeros,
ArrayRCP< size_t > &  rowptr,
ArrayRCP< LocalOrdinal > &  colind,
ArrayRCP< Scalar > &  values 
)
inline

Allocates and returns ArrayRCPs of the Crs arrays — This is an Xpetra-only routine.

Definition at line 591 of file Xpetra_EpetraCrsMatrix.hpp.

◆ setAllValues() [1/2]

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::setAllValues ( const ArrayRCP< size_t > &  rowptr,
const ArrayRCP< LocalOrdinal > &  colind,
const ArrayRCP< Scalar > &  values 
)
inline

Sets the 1D pointer arrays of the graph.

Definition at line 619 of file Xpetra_EpetraCrsMatrix.hpp.

◆ getAllValues() [1/2]

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getAllValues ( ArrayRCP< const size_t > &  rowptr,
ArrayRCP< const LocalOrdinal > &  colind,
ArrayRCP< const Scalar > &  values 
) const
inline

Gets the 1D pointer arrays of the graph.

Definition at line 648 of file Xpetra_EpetraCrsMatrix.hpp.

◆ getAllValues() [2/2]

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getAllValues ( ArrayRCP< Scalar > &  values)
inline

Gets the 1D pointer arrays of the graph.

Definition at line 672 of file Xpetra_EpetraCrsMatrix.hpp.

◆ haveGlobalConstants()

bool Xpetra::EpetraCrsMatrixT< int, EpetraNode >::haveGlobalConstants ( ) const
inlinevirtual

Returns true if globalConstants have been computed; false otherwise.

Implements Xpetra::CrsMatrix< double, int, int, EpetraNode >.

Definition at line 684 of file Xpetra_EpetraCrsMatrix.hpp.

◆ expertStaticFillComplete()

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::expertStaticFillComplete ( const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  domainMap,
const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  rangeMap,
const RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > &  importer = Teuchos::null,
const RCP< const Export< LocalOrdinal, GlobalOrdinal, Node > > &  exporter = Teuchos::null,
const RCP< ParameterList > &  = Teuchos::null 
)
inline

Expert static fill complete.

Definition at line 687 of file Xpetra_EpetraCrsMatrix.hpp.

◆ resumeFill()

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::resumeFill ( const RCP< ParameterList > &  = Teuchos::null)
inlinevirtual

◆ fillComplete() [1/2]

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::fillComplete ( const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  domainMap,
const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  rangeMap,
const RCP< ParameterList > &  params = Teuchos::null 
)
inline

Signal that data entry is complete, specifying domain and range maps.

Definition at line 728 of file Xpetra_EpetraCrsMatrix.hpp.

◆ fillComplete() [2/2]

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::fillComplete ( const RCP< ParameterList > &  params = Teuchos::null)
inlinevirtual

Signal that data entry is complete.

Implements Xpetra::CrsMatrix< double, int, int, EpetraNode >.

Definition at line 741 of file Xpetra_EpetraCrsMatrix.hpp.

◆ replaceDomainMapAndImporter()

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::replaceDomainMapAndImporter ( const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  newDomainMap,
Teuchos::RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > &  newImporter 
)
inline

Replaces the current domainMap and importer with the user-specified objects.

Definition at line 754 of file Xpetra_EpetraCrsMatrix.hpp.

◆ getComm()

const RCP< const Comm< int > > Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getComm ( ) const
inline

Returns the communicator.

Definition at line 773 of file Xpetra_EpetraCrsMatrix.hpp.

◆ getRowMap()

const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getRowMap ( ) const
inlinevirtual

Returns the Map that describes the row distribution in this matrix.

Implements Xpetra::CrsMatrix< double, int, int, EpetraNode >.

Definition at line 776 of file Xpetra_EpetraCrsMatrix.hpp.

◆ getColMap()

const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getColMap ( ) const
inlinevirtual

Returns the Map that describes the column distribution in this matrix.

Implements Xpetra::CrsMatrix< double, int, int, EpetraNode >.

Definition at line 779 of file Xpetra_EpetraCrsMatrix.hpp.

◆ getCrsGraph()

RCP< const CrsGraph< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getCrsGraph ( ) const
inlinevirtual

Returns the CrsGraph associated with this matrix.

Implements Xpetra::CrsMatrix< double, int, int, EpetraNode >.

Definition at line 782 of file Xpetra_EpetraCrsMatrix.hpp.

◆ getGlobalNumRows()

global_size_t Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getGlobalNumRows ( ) const
inlinevirtual

Number of global elements in the row map of this matrix.

Implements Xpetra::CrsMatrix< double, int, int, EpetraNode >.

Definition at line 785 of file Xpetra_EpetraCrsMatrix.hpp.

◆ getGlobalNumCols()

global_size_t Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getGlobalNumCols ( ) const
inlinevirtual

Number of global columns in the matrix.

Implements Xpetra::CrsMatrix< double, int, int, EpetraNode >.

Definition at line 788 of file Xpetra_EpetraCrsMatrix.hpp.

◆ getLocalNumRows()

size_t Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getLocalNumRows ( ) const
inlinevirtual

Returns the number of matrix rows owned on the calling node.

Implements Xpetra::CrsMatrix< double, int, int, EpetraNode >.

Definition at line 791 of file Xpetra_EpetraCrsMatrix.hpp.

◆ getLocalNumCols()

size_t Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getLocalNumCols ( ) const
inlinevirtual

Returns the number of columns connected to the locally owned rows of this matrix.

Implements Xpetra::CrsMatrix< double, int, int, EpetraNode >.

Definition at line 794 of file Xpetra_EpetraCrsMatrix.hpp.

◆ getGlobalNumEntries()

global_size_t Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getGlobalNumEntries ( ) const
inlinevirtual

Returns the global number of entries in this matrix.

Implements Xpetra::CrsMatrix< double, int, int, EpetraNode >.

Definition at line 797 of file Xpetra_EpetraCrsMatrix.hpp.

◆ getLocalNumEntries()

size_t Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getLocalNumEntries ( ) const
inlinevirtual

Returns the local number of entries in this matrix.

Implements Xpetra::CrsMatrix< double, int, int, EpetraNode >.

Definition at line 800 of file Xpetra_EpetraCrsMatrix.hpp.

◆ getNumEntriesInLocalRow()

size_t Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getNumEntriesInLocalRow ( LocalOrdinal  localRow) const
inline

Returns the current number of entries on this node in the specified local row.

Definition at line 803 of file Xpetra_EpetraCrsMatrix.hpp.

◆ getNumEntriesInGlobalRow()

size_t Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getNumEntriesInGlobalRow ( GlobalOrdinal  globalRow) const
inlinevirtual

Returns the current number of entries on this node in the specified (locally owned) global row.

Implements Xpetra::CrsMatrix< double, int, int, EpetraNode >.

Definition at line 806 of file Xpetra_EpetraCrsMatrix.hpp.

◆ getGlobalMaxNumRowEntries()

size_t Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getGlobalMaxNumRowEntries ( ) const
inlinevirtual

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

Implements Xpetra::CrsMatrix< double, int, int, EpetraNode >.

Definition at line 809 of file Xpetra_EpetraCrsMatrix.hpp.

◆ getLocalMaxNumRowEntries()

size_t Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getLocalMaxNumRowEntries ( ) const
inlinevirtual

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

Implements Xpetra::CrsMatrix< double, int, int, EpetraNode >.

Definition at line 812 of file Xpetra_EpetraCrsMatrix.hpp.

◆ isLocallyIndexed()

bool Xpetra::EpetraCrsMatrixT< int, EpetraNode >::isLocallyIndexed ( ) const
inlinevirtual

If matrix indices are in the local range, this function returns true. Otherwise, this function returns false.

Implements Xpetra::CrsMatrix< double, int, int, EpetraNode >.

Definition at line 815 of file Xpetra_EpetraCrsMatrix.hpp.

◆ isGloballyIndexed()

bool Xpetra::EpetraCrsMatrixT< int, EpetraNode >::isGloballyIndexed ( ) const
inlinevirtual

If matrix indices are in the global range, this function returns true. Otherwise, this function returns false.

Implements Xpetra::CrsMatrix< double, int, int, EpetraNode >.

Definition at line 818 of file Xpetra_EpetraCrsMatrix.hpp.

◆ isFillComplete()

bool Xpetra::EpetraCrsMatrixT< int, EpetraNode >::isFillComplete ( ) const
inlinevirtual

Returns true if the matrix is in compute mode, i.e. if fillComplete() has been called.

Implements Xpetra::CrsMatrix< double, int, int, EpetraNode >.

Definition at line 821 of file Xpetra_EpetraCrsMatrix.hpp.

◆ isFillActive()

bool Xpetra::EpetraCrsMatrixT< int, EpetraNode >::isFillActive ( ) const
inlinevirtual

Returns true if the matrix is in edit mode.

Implements Xpetra::CrsMatrix< double, int, int, EpetraNode >.

Definition at line 824 of file Xpetra_EpetraCrsMatrix.hpp.

◆ getFrobeniusNorm()

ScalarTraits< Scalar >::magnitudeType Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getFrobeniusNorm ( ) const
inlinevirtual

Returns the Frobenius norm of the matrix.

Implements Xpetra::CrsMatrix< double, int, int, EpetraNode >.

Definition at line 827 of file Xpetra_EpetraCrsMatrix.hpp.

◆ supportsRowViews()

bool Xpetra::EpetraCrsMatrixT< int, EpetraNode >::supportsRowViews ( ) const
inlinevirtual

Returns true if getLocalRowView() and getGlobalRowView() are valid for this class.

Implements Xpetra::CrsMatrix< double, int, int, EpetraNode >.

Definition at line 830 of file Xpetra_EpetraCrsMatrix.hpp.

◆ getLocalRowCopy()

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getLocalRowCopy ( LocalOrdinal  LocalRow,
const ArrayView< LocalOrdinal > &  Indices,
const ArrayView< Scalar > &  Values,
size_t &  NumEntries 
) const
inline

Extract a list of entries in a specified local row of the matrix. Put into storage allocated by calling routine.

Definition at line 833 of file Xpetra_EpetraCrsMatrix.hpp.

◆ getGlobalRowCopy()

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getGlobalRowCopy ( GlobalOrdinal  GlobalRow,
const ArrayView< GlobalOrdinal > &  Indices,
const ArrayView< Scalar > &  Values,
size_t &  NumEntries 
) const
inline

Extract a list of entries in a specified global row of this matrix. Put into pre-allocated storage.

Definition at line 842 of file Xpetra_EpetraCrsMatrix.hpp.

◆ getGlobalRowView()

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getGlobalRowView ( GlobalOrdinal  GlobalRow,
ArrayView< const GlobalOrdinal > &  indices,
ArrayView< const Scalar > &  values 
) const
inline

Extract a const, non-persisting view of global indices in a specified row of the matrix.

Definition at line 851 of file Xpetra_EpetraCrsMatrix.hpp.

◆ getLocalRowView()

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getLocalRowView ( LocalOrdinal  LocalRow,
ArrayView< const LocalOrdinal > &  indices,
ArrayView< const Scalar > &  values 
) const
inline

Extract a const, non-persisting view of local indices in a specified row of the matrix.

Definition at line 866 of file Xpetra_EpetraCrsMatrix.hpp.

◆ getLocalDiagCopy() [1/2]

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getLocalDiagCopy ( Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  diag) const
inline

Get a copy of the diagonal entries owned by this node, with local row indices.

Definition at line 881 of file Xpetra_EpetraCrsMatrix.hpp.

◆ getLocalDiagOffsets()

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getLocalDiagOffsets ( Teuchos::ArrayRCP< size_t > &  ) const
inlinevirtual

Get offsets of the diagonal entries in the matrix.

Implements Xpetra::CrsMatrix< double, int, int, EpetraNode >.

Definition at line 887 of file Xpetra_EpetraCrsMatrix.hpp.

◆ getLocalDiagCopy() [2/2]

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getLocalDiagCopy ( Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  ,
const Teuchos::ArrayView< const size_t > &   
) const
inline

Get a copy of the diagonal entries owned by this node, with local row indices, using row offsets.

Definition at line 892 of file Xpetra_EpetraCrsMatrix.hpp.

◆ replaceDiag()

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::replaceDiag ( const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  diag)
inline

Replace the diagonal entries of the matrix.

Definition at line 897 of file Xpetra_EpetraCrsMatrix.hpp.

◆ leftScale()

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::leftScale ( const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  x)
inline

Definition at line 901 of file Xpetra_EpetraCrsMatrix.hpp.

◆ rightScale()

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::rightScale ( const Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  x)
inline

Definition at line 904 of file Xpetra_EpetraCrsMatrix.hpp.

◆ apply() [1/2]

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::apply ( const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  X,
MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  Y,
Teuchos::ETransp  mode = Teuchos::NO_TRANS,
Scalar  alpha = ScalarTraitsScalar >::one(),
Scalar  beta = ScalarTraitsScalar >::zero() 
) const
inline

Computes the sparse matrix-multivector multiplication.

Definition at line 914 of file Xpetra_EpetraCrsMatrix.hpp.

◆ apply() [2/2]

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::apply ( const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  X,
MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  Y,
Teuchos::ETransp  mode,
Scalar  alpha,
Scalar  beta,
bool  sumInterfaceValues,
const RCP< Import< LocalOrdinal, GlobalOrdinal, Node > > &  regionInterfaceImporter,
const Teuchos::ArrayRCP< LocalOrdinal > &  regionInterfaceLIDs 
) const
inline

Definition at line 940 of file Xpetra_EpetraCrsMatrix.hpp.

◆ getDomainMap()

const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getDomainMap ( ) const
inlinevirtual

Returns the Map associated with the domain of this operator. This will be null until fillComplete() is called.

Implements Xpetra::CrsMatrix< double, int, int, EpetraNode >.

Definition at line 945 of file Xpetra_EpetraCrsMatrix.hpp.

◆ getRangeMap()

const RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getRangeMap ( ) const
inlinevirtual

Returns the Map associated with the range of this operator, which must be compatible with Y.getMap().

Implements Xpetra::CrsMatrix< double, int, int, EpetraNode >.

Definition at line 948 of file Xpetra_EpetraCrsMatrix.hpp.

◆ description()

std::string Xpetra::EpetraCrsMatrixT< int, EpetraNode >::description ( ) const
inlinevirtual

A simple one-line description of this object.

Implements Xpetra::CrsMatrix< double, int, int, EpetraNode >.

Definition at line 956 of file Xpetra_EpetraCrsMatrix.hpp.

◆ describe()

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::describe ( Teuchos::FancyOStream out,
const Teuchos::EVerbosityLevel  verbLevel = Teuchos::Describable::verbLevel_default 
) const
inlinevirtual

Print the object with some verbosity level to an FancyOStream object.

Implements Xpetra::CrsMatrix< double, int, int, EpetraNode >.

Definition at line 980 of file Xpetra_EpetraCrsMatrix.hpp.

◆ setObjectLabel()

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::setObjectLabel ( const std::string &  objectLabel)
inlinevirtual

◆ getMap()

Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getMap ( ) const
inlinevirtual

Implements DistObject interface.

Access function for the Tpetra::Map this DistObject was constructed with.

Implements Xpetra::DistObject< Packet, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 1148 of file Xpetra_EpetraCrsMatrix.hpp.

◆ doImport() [1/2]

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::doImport ( const DistObject< char, LocalOrdinal, GlobalOrdinal, Node > &  source,
const Import< LocalOrdinal, GlobalOrdinal, Node > &  importer,
CombineMode  CM 
)
inline

Import.

Definition at line 1151 of file Xpetra_EpetraCrsMatrix.hpp.

◆ doExport() [1/2]

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::doExport ( const DistObject< char, LocalOrdinal, GlobalOrdinal, Node > &  dest,
const Import< LocalOrdinal, GlobalOrdinal, Node > &  importer,
CombineMode  CM 
)
inline

Export.

Definition at line 1164 of file Xpetra_EpetraCrsMatrix.hpp.

◆ doImport() [2/2]

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::doImport ( const DistObject< char, LocalOrdinal, GlobalOrdinal, Node > &  source,
const Export< LocalOrdinal, GlobalOrdinal, Node > &  exporter,
CombineMode  CM 
)
inline

Import (using an Exporter).

Definition at line 1177 of file Xpetra_EpetraCrsMatrix.hpp.

◆ doExport() [2/2]

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::doExport ( const DistObject< char, LocalOrdinal, GlobalOrdinal, Node > &  dest,
const Export< LocalOrdinal, GlobalOrdinal, Node > &  exporter,
CombineMode  CM 
)
inline

Export (using an Importer).

Definition at line 1191 of file Xpetra_EpetraCrsMatrix.hpp.

◆ removeEmptyProcessesInPlace()

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::removeEmptyProcessesInPlace ( const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  newMap)
inline

Definition at line 1203 of file Xpetra_EpetraCrsMatrix.hpp.

◆ hasMatrix()

bool Xpetra::EpetraCrsMatrixT< int, EpetraNode >::hasMatrix ( ) const
inlinevirtual

Does this have an underlying matrix.

Implements Xpetra::CrsMatrix< double, int, int, EpetraNode >.

Definition at line 1216 of file Xpetra_EpetraCrsMatrix.hpp.

◆ getEpetra_CrsMatrix()

RCP< const Epetra_CrsMatrix > Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getEpetra_CrsMatrix ( ) const
inline

Get the underlying Epetra matrix.

Definition at line 1222 of file Xpetra_EpetraCrsMatrix.hpp.

◆ getEpetra_CrsMatrixNonConst()

RCP< Epetra_CrsMatrix > Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getEpetra_CrsMatrixNonConst ( ) const
inline

Get the underlying Epetra matrix.

Definition at line 1225 of file Xpetra_EpetraCrsMatrix.hpp.

◆ getLocalMatrixDevice()

local_matrix_type Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getLocalMatrixDevice ( ) const
inlinevirtual

Compatibility layer for accessing the matrix data through a Kokkos interface.

Implements Xpetra::CrsMatrix< double, int, int, EpetraNode >.

Definition at line 1230 of file Xpetra_EpetraCrsMatrix.hpp.

◆ getLocalMatrixHost()

local_matrix_type::HostMirror Xpetra::EpetraCrsMatrixT< int, EpetraNode >::getLocalMatrixHost ( ) const
inlinevirtual

◆ setAllValues() [2/2]

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::setAllValues ( const typename local_matrix_type::row_map_type &  ptr,
const typename local_matrix_type::StaticCrsGraphType::entries_type::non_const_type &  ind,
const typename local_matrix_type::values_type &  val 
)
inline

Definition at line 1267 of file Xpetra_EpetraCrsMatrix.hpp.

◆ GetStorageBlockSize()

LocalOrdinal Xpetra::EpetraCrsMatrixT< int, EpetraNode >::GetStorageBlockSize ( ) const
inlinevirtual

Returns the block size of the storage mechanism, which is usually 1, except for Tpetra::BlockCrsMatrix.

Implements Xpetra::CrsMatrix< double, int, int, EpetraNode >.

Definition at line 1299 of file Xpetra_EpetraCrsMatrix.hpp.

◆ residual()

void Xpetra::EpetraCrsMatrixT< int, EpetraNode >::residual ( const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  X,
const MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  B,
MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  R 
) const
inlineprivate

Definition at line 1311 of file Xpetra_EpetraCrsMatrix.hpp.

Member Data Documentation

◆ mtx_

The underlying actual matrix object.

Definition at line 1322 of file Xpetra_EpetraCrsMatrix.hpp.

◆ isFillResumed_

bool Xpetra::EpetraCrsMatrixT< int, EpetraNode >::isFillResumed_
private

Flag to keep track of fill status.

For Epetra, fillResume() is a fictitious operation but we need to keep track of it. This boolean is true only is resumeFill() have been called and fillComplete() have not been called afterward.

Definition at line 1330 of file Xpetra_EpetraCrsMatrix.hpp.


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