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

#include <Xpetra_IO_decl.hpp>

Static Public Member Functions
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.
static void	Write (const std::string &fileName, const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > &M)
	Read/Write methods.
static void	Write (const std::string &fileName, const Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &vec)
	Save multivector to file in Matrix Market format.
static void	WriteLOMV (const std::string &fileName, const Xpetra::MultiVector< LocalOrdinal, LocalOrdinal, GlobalOrdinal, Node > &vec)
	Save multivector with Scalar=LocalOrdinal to file in Matrix Market format.
static void	WriteGOMV (const std::string &fileName, const Xpetra::MultiVector< GlobalOrdinal, LocalOrdinal, GlobalOrdinal, Node > &vec)
	Save multivector with Scalar=GlobalOrdinal to file in Matrix Market format.
static void	Write (const std::string &fileName, const Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Op, const bool &writeAllMaps=false)
	Save matrix to file in Matrix Market format.
static void	WriteLocal (const std::string &fileName, const Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Op)
	Save local parts of matrix to files in Matrix Market format.
static void	WriteBlockedCrsMatrix (const std::string &fileName, const Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Op, const bool &writeAllMaps=false)
	Save block matrix to one file per block in Matrix Market format.
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.
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.
static Teuchos::RCP< Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	ReadLocal (const std::string &filename, const RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > rowMap, RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > colMap, 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 local files in Matrix Market or binary format.
static RCP< MultiVector >	ReadMultiVector (const std::string &fileName, const RCP< const Map > &map, const bool binary=false)
	Read a MultiVector from file in Matrix Matrix or binary format.
static RCP< Xpetra::MultiVector< LocalOrdinal, LocalOrdinal, GlobalOrdinal, Node > >	ReadMultiVectorLO (const std::string &fileName, const RCP< const Map > &map, const bool binary=false)
	Read a MultiVector with Scalar=LocalOrdinal from file in Matrix Matrix or binary format.
static RCP< const Map >	ReadMap (const std::string &fileName, Xpetra::UnderlyingLib lib, const RCP< const Teuchos::Comm< int > > &comm, const bool binary=false)
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 block matrix from one file per block in Matrix Market format.
template<class T>
static std::string	toString (const T &what)
	Little helper function to convert non-string types to strings.

Private Types
using	LO = LocalOrdinal
using	GO = GlobalOrdinal
using	NO = Node
using	SC = Scalar

Detailed Description

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

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

Definition at line 53 of file Xpetra_IO_decl.hpp.

Member Typedef Documentation

◆ LO

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

using Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node >::LO = LocalOrdinal

private

◆ GO

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

using Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GO = GlobalOrdinal

private

◆ NO

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

using Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node >::NO = Node

private

◆ SC

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

using Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SC = Scalar

private

Member Function Documentation

◆ Map2TpetraMap()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>

const RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Map2TpetraMap ( const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > & map )

static

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

Definition at line 42 of file Xpetra_IO_def.hpp.

◆ Write() [1/3]

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>

void Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Write	(	const std::string &	fileName,
		const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > &	M )

static

Read/Write methods.

Save map to file.

Definition at line 50 of file Xpetra_IO_def.hpp.

◆ Write() [2/3]

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>

void Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Write	(	const std::string &	fileName,
		const Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	vec )

static

Save multivector to file in Matrix Market format.

Definition at line 65 of file Xpetra_IO_def.hpp.

◆ WriteLOMV()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>

void Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node >::WriteLOMV	(	const std::string &	fileName,
		const Xpetra::MultiVector< LocalOrdinal, LocalOrdinal, GlobalOrdinal, Node > &	vec )

static

Save multivector with Scalar=LocalOrdinal to file in Matrix Market format.

Definition at line 83 of file Xpetra_IO_def.hpp.

◆ WriteGOMV()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>

void Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node >::WriteGOMV	(	const std::string &	fileName,
		const Xpetra::MultiVector< GlobalOrdinal, LocalOrdinal, GlobalOrdinal, Node > &	vec )

static

Save multivector with Scalar=GlobalOrdinal to file in Matrix Market format.

Definition at line 102 of file Xpetra_IO_def.hpp.

◆ Write() [3/3]

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>

void Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Write	(	const std::string &	fileName,
		const Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	Op,
		const bool &	writeAllMaps = false )

static

Save matrix to file in Matrix Market format.

Definition at line 121 of file Xpetra_IO_def.hpp.

◆ WriteLocal()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>

void Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node >::WriteLocal	(	const std::string &	fileName,
		const Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	Op )

static

Save local parts of matrix to files in Matrix Market format.

Definition at line 154 of file Xpetra_IO_def.hpp.

◆ WriteBlockedCrsMatrix()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>

void Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node >::WriteBlockedCrsMatrix	(	const std::string &	fileName,
		const Xpetra::BlockedCrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	Op,
		const bool &	writeAllMaps = false )

static

Save block matrix to one file per block in Matrix Market format.

We write one MatrixMarket file for each block of the given BlockedCrsMatrix. The block (row,col) indicators are included into the file name, such that filename02.m indicates the block in row = 0 and col = 2, for example.

While the user can enable/disable the output of all maps of each matrix block, we always write the range and domain maps of each block as well of the full blocked operator in order to enable reconstruction of the MapExtractor objects for range and domain maps.

Parameters

fileName	String to indicate file name of files to be written
Op	BlockedCrsMatrix to be written
writeAllMaps	Flag to control output of maps to separate files (defaults to `false` )

Definition at line 181 of file Xpetra_IO_def.hpp.

◆ Read() [1/2]

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>

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 )

static

Read matrix from file in Matrix Market or binary format.

Definition at line 212 of file Xpetra_IO_def.hpp.

◆ Read() [2/2]

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>

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 )

static

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 313 of file Xpetra_IO_def.hpp.

◆ ReadLocal()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>

Teuchos::RCP< Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ReadLocal	(	const std::string &	filename,
		const RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > >	rowMap,
		RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > >	colMap,
		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 )

static

Read matrix from local files in Matrix Market or binary format.

The file name format is filename.SIZE.RANK, where SIZE is the size of the communicator of the rowMap and RANK is the MPI ranks of the calling process.

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

Definition at line 369 of file Xpetra_IO_def.hpp.

◆ ReadMultiVector()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>

RCP< Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ReadMultiVector	(	const std::string &	fileName,
		const RCP< const Map > &	map,
		const bool	binary = false )

static

Read a MultiVector from file in Matrix Matrix or binary format.

Definition at line 506 of file Xpetra_IO_def.hpp.

◆ ReadMultiVectorLO()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>

RCP< Xpetra::MultiVector< LocalOrdinal, LocalOrdinal, GlobalOrdinal, Node > > Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ReadMultiVectorLO	(	const std::string &	fileName,
		const RCP< const Map > &	map,
		const bool	binary = false )

static

Read a MultiVector with Scalar=LocalOrdinal from file in Matrix Matrix or binary format.

Definition at line 529 of file Xpetra_IO_def.hpp.

◆ ReadMap()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>

RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ReadMap	(	const std::string &	fileName,
		Xpetra::UnderlyingLib	lib,
		const RCP< const Teuchos::Comm< int > > &	comm,
		const bool	binary = false )

static

Definition at line 552 of file Xpetra_IO_def.hpp.

◆ ReadBlockedCrsMatrix()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>

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 )

static

Read block matrix from one file per block in Matrix Market format.

We read one MatrixMarket file for each block of the desired BlockedCrsMatrix. The block (row,col) indicators are included into the file name, such that filename02.m indicates the block in row = 0 and col = 2, for example.

We also read the range and domain maps of each block as well of the full blocked operator in order to enable reconstruction of the MapExtractor objects for range and domain maps.

Parameters

fileName	String to indicate file name of files to be written
lib	Underlying type of linear algebra package
comm	Communicator

Definition at line 573 of file Xpetra_IO_def.hpp.

◆ toString()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>

template<class T>

std::string Xpetra::IO< Scalar, LocalOrdinal, GlobalOrdinal, Node >::toString ( const T & what )

static

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

Definition at line 646 of file Xpetra_IO_def.hpp.

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

Static Public Member Functions

Private Types

Detailed Description

Member Typedef Documentation

◆ LO

◆ GO

◆ NO

◆ SC

Member Function Documentation

◆ Map2TpetraMap()

◆ Write() [1/3]

◆ Write() [2/3]

◆ WriteLOMV()

◆ WriteGOMV()

◆ Write() [3/3]

◆ WriteLocal()

◆ WriteBlockedCrsMatrix()

◆ Read() [1/2]

◆ Read() [2/2]

◆ ReadLocal()

◆ ReadMultiVector()

◆ ReadMultiVectorLO()

◆ ReadMap()

◆ ReadBlockedCrsMatrix()

◆ toString()