Static Public Member Functions | List of all members
Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

Xpetra utility class containing IO routines to read/write vectors, matrices etc... More...

#include <Xpetra_IO.hpp>

Static Public Member Functions

static RCP< MultiVectorReadMultiVector (const std::string &fileName, const RCP< const Map > &map)
 
static RCP< const MapReadMap (const std::string &fileName, Xpetra::UnderlyingLib lib, const RCP< const Teuchos::Comm< int > > &comm)
 
static RCP< const Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > ReadBlockedCrsMatrix (const std::string &fileName, Xpetra::UnderlyingLib lib, const RCP< const Teuchos::Comm< int > > &comm)
 Read matrix to file in Matrix Market format. More...
 
template<class T >
static std::string toString (const T &what)
 Little helper function to convert non-string types to strings. More...
 
static const Epetra_Map & Map2EpetraMap (const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > &map)
 Helper utility to pull out the underlying Epetra objects from an Xpetra object. More...
 
static const RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > Map2TpetraMap (const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > &map)
 Helper utility to pull out the underlying Tpetra objects from an Xpetra object. More...
 
static void Write (const std::string &fileName, const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > &M)
 Read/Write methods. More...
 
static void Write (const std::string &fileName, const Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &vec)
 Save vector to file in Matrix Market format. More...
 
static void Write (const std::string &fileName, const Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Op)
 Save matrix to file in Matrix Market format. More...
 
static void WriteBlockedCrsMatrix (const std::string &fileName, const Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Op)
 Save matrix to file in Matrix Market format. More...
 
static Teuchos::RCP< Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Read (const std::string &fileName, Xpetra::UnderlyingLib lib, const RCP< const Teuchos::Comm< int > > &comm, bool binary=false)
 Read matrix from file in Matrix Market or binary format. More...
 
static Teuchos::RCP< Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Read (const std::string &filename, const RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > rowMap, RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > colMap=Teuchos::null, const RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > domainMap=Teuchos::null, const RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > rangeMap=Teuchos::null, const bool callFillComplete=true, const bool binary=false, const bool tolerant=false, const bool debug=false)
 Read matrix from file in Matrix Market or binary format. More...
 

Detailed Description

template<class Scalar, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
class Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Xpetra utility class containing IO routines to read/write vectors, matrices etc...

Xpetra utility class containing IO routines to read/write vectors, matrices.

Specialization for LO=GO=int

TODO: do we need specialization for SC=double and std::complex<>??? TODO: need specialization for <int, long long>

Definition at line 134 of file Xpetra_IO.hpp.

Member Function Documentation

◆ Map2EpetraMap()

template<class Scalar , class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
static const Epetra_Map& Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Map2EpetraMap ( const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > &  map)
inlinestatic

Helper utility to pull out the underlying Epetra objects from an Xpetra object.

Definition at line 157 of file Xpetra_IO.hpp.

◆ Map2TpetraMap()

template<class Scalar , class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
static const RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> > Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Map2TpetraMap ( const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > &  map)
inlinestatic

Helper utility to pull out the underlying Tpetra objects from an Xpetra object.

Definition at line 186 of file Xpetra_IO.hpp.

◆ Write() [1/3]

template<class Scalar , class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
static void Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Write ( const std::string &  fileName,
const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > &  M 
)
inlinestatic

Read/Write methods.

Save map to file.

Definition at line 198 of file Xpetra_IO.hpp.

◆ Write() [2/3]

template<class Scalar , class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
static void Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Write ( const std::string &  fileName,
const Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  vec 
)
inlinestatic

Save vector to file in Matrix Market format.

Definition at line 225 of file Xpetra_IO.hpp.

◆ Write() [3/3]

template<class Scalar , class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
static void Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Write ( const std::string &  fileName,
const Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  Op 
)
inlinestatic

Save matrix to file in Matrix Market format.

Definition at line 256 of file Xpetra_IO.hpp.

◆ WriteBlockedCrsMatrix()

template<class Scalar , class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
static void Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node >::WriteBlockedCrsMatrix ( const std::string &  fileName,
const Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  Op 
)
inlinestatic

Save matrix to file in Matrix Market format.

Definition at line 291 of file Xpetra_IO.hpp.

◆ Read() [1/2]

template<class Scalar , class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
static Teuchos::RCP<Xpetra::Matrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> > Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Read ( const std::string &  fileName,
Xpetra::UnderlyingLib  lib,
const RCP< const Teuchos::Comm< int > > &  comm,
bool  binary = false 
)
inlinestatic

Read matrix from file in Matrix Market or binary format.

Definition at line 329 of file Xpetra_IO.hpp.

◆ Read() [2/2]

template<class Scalar , class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
static Teuchos::RCP<Xpetra::Matrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> > Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Read ( const std::string &  filename,
const RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > >  rowMap,
RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > >  colMap = Teuchos::null,
const RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > >  domainMap = Teuchos::null,
const RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > >  rangeMap = Teuchos::null,
const bool  callFillComplete = true,
const bool  binary = false,
const bool  tolerant = false,
const bool  debug = false 
)
inlinestatic

Read matrix from file in Matrix Market or binary format.

If only rowMap is specified, then it is used for the domainMap and rangeMap, as well.

Definition at line 431 of file Xpetra_IO.hpp.

◆ ReadMultiVector()

template<class Scalar , class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
static RCP<MultiVector> Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ReadMultiVector ( const std::string &  fileName,
const RCP< const Map > &  map 
)
inlinestatic

Definition at line 546 of file Xpetra_IO.hpp.

◆ ReadMap()

template<class Scalar , class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
static RCP<const Map> Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ReadMap ( const std::string &  fileName,
Xpetra::UnderlyingLib  lib,
const RCP< const Teuchos::Comm< int > > &  comm 
)
inlinestatic

Definition at line 573 of file Xpetra_IO.hpp.

◆ ReadBlockedCrsMatrix()

template<class Scalar , class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
static RCP<const Xpetra::BlockedCrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> > Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ReadBlockedCrsMatrix ( const std::string &  fileName,
Xpetra::UnderlyingLib  lib,
const RCP< const Teuchos::Comm< int > > &  comm 
)
inlinestatic

Read matrix to file in Matrix Market format.

Definition at line 600 of file Xpetra_IO.hpp.

◆ toString()

template<class Scalar , class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
template<class T >
static std::string Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node >::toString ( const T &  what)
inlinestatic

Little helper function to convert non-string types to strings.

Definition at line 684 of file Xpetra_IO.hpp.


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