Dune Core Modules (unstable)

Provides methods for reading and writing matrices and vectors in various formats. More...

Files

file  io.hh
 Some generic functions for pretty printing vectors and matrices.
 
file  matrixmarket.hh
 Provides classes for reading and writing MatrixMarket Files with an extension for parallel matrices.
 

Classes

struct  Dune::DefaultSVGMatrixOptions
 Default options class to write SVG matrices. More...
 

Functions

template<class V >
void Dune::recursive_printvector (std::ostream &s, const V &v, std::string rowtext, int &counter, int columns, int width)
 Recursively print a vector. More...
 
template<class V >
void Dune::printvector (std::ostream &s, const V &v, std::string title, std::string rowtext, int columns=1, int width=10, int precision=2)
 Print an ISTL vector. More...
 
void Dune::fill_row (std::ostream &s, int m, int width, int precision)
 Print a row of zeros for a non-existing block. More...
 
template<class K >
void Dune::print_row (std::ostream &s, const K &value, typename FieldMatrix< K, 1, 1 >::size_type I, typename FieldMatrix< K, 1, 1 >::size_type J, typename FieldMatrix< K, 1, 1 >::size_type therow, int width, int precision, typename std::enable_if_t< Dune::IsNumber< K >::value > *sfinae=nullptr)
 Print one row of a matrix, specialization for number types. More...
 
template<class M >
void Dune::print_row (std::ostream &s, const M &A, typename M::size_type I, typename M::size_type J, typename M::size_type therow, int width, int precision, typename std::enable_if_t<!Dune::IsNumber< M >::value > *sfinae=nullptr)
 Print one row of a matrix. More...
 
template<class M >
void Dune::printmatrix (std::ostream &s, const M &A, std::string title, std::string rowtext, int width=10, int precision=2)
 Print a generic block matrix. More...
 
template<class A , class InnerMatrixType >
void Dune::printSparseMatrix (std::ostream &s, const BCRSMatrix< InnerMatrixType, A > &mat, std::string title, std::string rowtext, int width=3, int precision=2)
 Prints a BCRSMatrix with fixed sized blocks. More...
 
template<class FieldType >
void Dune::writeMatrixToMatlabHelper (const FieldType &value, int rowOffset, int colOffset, std::ostream &s, typename std::enable_if_t< Dune::IsNumber< FieldType >::value > *sfinae=nullptr)
 Helper method for the writeMatrixToMatlab routine. More...
 
template<class MatrixType >
void Dune::writeMatrixToMatlabHelper (const MatrixType &matrix, int externalRowOffset, int externalColOffset, std::ostream &s, typename std::enable_if_t<!Dune::IsNumber< MatrixType >::value > *sfinae=nullptr)
 Helper method for the writeMatrixToMatlab routine. More...
 
template<class MatrixType >
void Dune::writeMatrixToMatlab (const MatrixType &matrix, const std::string &filename, int outputPrecision=18)
 Writes sparse matrix in a Matlab-readable format. More...
 
template<class VectorType >
void Dune::writeVectorToMatlab (const VectorType &vector, const std::string &filename, int outputPrecision=18)
 Writes vectors in a Matlab-readable format. More...
 
template<class Mat , class SVGOptions = DefaultSVGMatrixOptions>
void Dune::writeSVGMatrix (std::ostream &out, const Mat &mat, SVGOptions opts={})
 Writes the visualization of matrix in the SVG format. More...
 
template<class Mat , class SVGOptions = DefaultSVGMatrixOptions>
void Dune::writeSVGMatrix (const Mat &mat, std::ostream &out, SVGOptions opts={})
 Writes the visualization of matrix in the SVG format. More...
 
template<typename T , typename A >
void Dune::readMatrixMarket (Dune::BlockVector< T, A > &vector, std::istream &istr)
 Reads a BlockVector from a matrix market file. More...
 
template<typename T , typename A >
void Dune::readMatrixMarket (Dune::BCRSMatrix< T, A > &matrix, std::istream &istr)
 Reads a sparse matrix from a matrix market file. More...
 
template<typename M >
void Dune::writeMatrixMarket (const M &matrix, std::ostream &ostr)
 writes a ISTL matrix or vector to a stream in matrix market format.
 
template<typename M >
void Dune::storeMatrixMarket (const M &matrix, std::string filename, int prec=default_precision)
 Stores a parallel matrix/vector in matrix market format in a file. More...
 
template<typename M , typename G , typename L >
void Dune::storeMatrixMarket (const M &matrix, std::string filename, const OwnerOverlapCopyCommunication< G, L > &comm, bool storeIndices=true, int prec=default_precision)
 Stores a parallel matrix/vector in matrix market format in a file. More...
 
template<typename M , typename G , typename L >
void Dune::loadMatrixMarket (M &matrix, const std::string &filename, OwnerOverlapCopyCommunication< G, L > &comm, bool readIndices=true)
 Load a parallel matrix/vector stored in matrix market format. More...
 
template<typename M >
void Dune::loadMatrixMarket (M &matrix, const std::string &filename)
 Load a matrix/vector stored in matrix market format. More...
 

Detailed Description

Provides methods for reading and writing matrices and vectors in various formats.

Routine printmatrix prints a (sparse matrix with all entries (even zeroes). Function printvector prints a vector to a stream. PrintSparseMatrix prints a sparse matrix omitting all nonzeroes. With writeMatrixToMatlab one can write a matrix in a Matlab readable format. Using storeMartrixMarket and loadMatrixMarket one can store and load a parallel ISTL matrix in MatrixMarket format. The latter can even read a matrix written with writeMatrixToMatlab.

Function Documentation

◆ fill_row()

void Dune::fill_row ( std::ostream &  s,
int  m,
int  width,
int  precision 
)
inline

Print a row of zeros for a non-existing block.

#include <dune/istl/io.hh>
Some generic functions for pretty printing vectors and matrices.

◆ loadMatrixMarket() [1/2]

template<typename M >
void Dune::loadMatrixMarket ( M &  matrix,
const std::string &  filename 
)

Load a matrix/vector stored in matrix market format.

More about the matrix market exchange format can be found here.

Parameters
matrixWhere to store the matrix/vector.
filenamethe name of the filename (without suffix and rank!) rank i will read the file filename_i.mm

◆ loadMatrixMarket() [2/2]

template<typename M , typename G , typename L >
void Dune::loadMatrixMarket ( M &  matrix,
const std::string &  filename,
OwnerOverlapCopyCommunication< G, L > &  comm,
bool  readIndices = true 
)

Load a parallel matrix/vector stored in matrix market format.

More about the matrix market exchange format can be found here.

Parameters
matrixWhere to store the matrix/vector.
filenamethe name of the filename (without suffix and rank!) rank i will read the file filename_i.mm
commThe information about the data distribution.
readIndicesWhether to read the parallel index information. If true rank i reads the index information form file filename_i.idx And builds the remote indices information.

◆ print_row() [1/2]

template<class K >
void Dune::print_row ( std::ostream &  s,
const K &  value,
typename FieldMatrix< K, 1, 1 >::size_type  I,
typename FieldMatrix< K, 1, 1 >::size_type  J,
typename FieldMatrix< K, 1, 1 >::size_type  therow,
int  width,
int  precision,
typename std::enable_if_t< Dune::IsNumber< K >::value > *  sfinae = nullptr 
)

Print one row of a matrix, specialization for number types.

#include <dune/istl/io.hh>

◆ print_row() [2/2]

template<class M >
void Dune::print_row ( std::ostream &  s,
const M &  A,
typename M::size_type  I,
typename M::size_type  J,
typename M::size_type  therow,
int  width,
int  precision,
typename std::enable_if_t<!Dune::IsNumber< M >::value > *  sfinae = nullptr 
)

Print one row of a matrix.

#include <dune/istl/io.hh>

◆ printmatrix()

template<class M >
void Dune::printmatrix ( std::ostream &  s,
const M &  A,
std::string  title,
std::string  rowtext,
int  width = 10,
int  precision = 2 
)

Print a generic block matrix.

#include <dune/istl/io.hh>
Bug:
Empty rows and columns are omitted by this method. (FlySpray #7)

◆ printSparseMatrix()

template<class A , class InnerMatrixType >
void Dune::printSparseMatrix ( std::ostream &  s,
const BCRSMatrix< InnerMatrixType, A > &  mat,
std::string  title,
std::string  rowtext,
int  width = 3,
int  precision = 2 
)

Prints a BCRSMatrix with fixed sized blocks.

#include <dune/istl/io.hh>

Only the nonzero entries will be printed as matrix blocks together with their corresponding column index and all others will be omitted.

This might be preferable over printmatrix in the case of big sparse matrices with nonscalar blocks.

Parameters
sThe ostream to print to.
matThe matrix to print.
titleThe title for the matrix.
rowtextThe text to prepend to each print out of a matrix row.
widthThe number of nonzero blocks to print in one line.
precisionThe precision to use when printing the numbers.

◆ printvector()

template<class V >
void Dune::printvector ( std::ostream &  s,
const V &  v,
std::string  title,
std::string  rowtext,
int  columns = 1,
int  width = 10,
int  precision = 2 
)

Print an ISTL vector.

#include <dune/istl/io.hh>

References Dune::recursive_printvector().

◆ readMatrixMarket() [1/2]

template<typename T , typename A >
void Dune::readMatrixMarket ( Dune::BCRSMatrix< T, A > &  matrix,
std::istream &  istr 
)

Reads a sparse matrix from a matrix market file.

Parameters
matrixThe matrix to store the data in.
istrThe input stream to read the data from.
Warning
Not all formats are supported!

◆ readMatrixMarket() [2/2]

template<typename T , typename A >
void Dune::readMatrixMarket ( Dune::BlockVector< T, A > &  vector,
std::istream &  istr 
)

Reads a BlockVector from a matrix market file.

Parameters
vectorThe vector to store the data in.
istrThe input stream to read the data from.
Warning
Not all formats are supported!

References DUNE_THROW.

◆ recursive_printvector()

template<class V >
void Dune::recursive_printvector ( std::ostream &  s,
const V &  v,
std::string  rowtext,
int &  counter,
int  columns,
int  width 
)

Recursively print a vector.

#include <dune/istl/io.hh>

References Dune::recursive_printvector().

Referenced by Dune::printvector(), and Dune::recursive_printvector().

◆ storeMatrixMarket() [1/2]

template<typename M , typename G , typename L >
void Dune::storeMatrixMarket ( const M &  matrix,
std::string  filename,
const OwnerOverlapCopyCommunication< G, L > &  comm,
bool  storeIndices = true,
int  prec = default_precision 
)

Stores a parallel matrix/vector in matrix market format in a file.

More about the matrix market exchange format can be found here.

Parameters
matrixThe matrix/vector to store.
filenamethe name of the filename (without suffix and rank!) rank i will write the file filename_i.mm
commThe information about the data distribution.
storeIndicesWhether to store the parallel index information. If true rank i writes the index information to file filename_i.idx.
precSet the decimal precision to be used

References Dune::Communication< MPI_Comm >::rank().

◆ storeMatrixMarket() [2/2]

template<typename M >
void Dune::storeMatrixMarket ( const M &  matrix,
std::string  filename,
int  prec = default_precision 
)

Stores a parallel matrix/vector in matrix market format in a file.

More about the matrix market exchange format can be found here.

Parameters
matrixThe matrix/vector to store.
filenamethe name of the filename (without suffix and rank!) rank i will write the file filename_i.mm
precSet the decimal precision to be used

◆ writeMatrixToMatlab()

template<class MatrixType >
void Dune::writeMatrixToMatlab ( const MatrixType &  matrix,
const std::string &  filename,
int  outputPrecision = 18 
)

Writes sparse matrix in a Matlab-readable format.

#include <dune/istl/io.hh>

This routine writes the argument BCRSMatrix to a file with the name given by the filename argument. The file format is ASCII, with no header, and three data columns. Each row describes a scalar matrix entry and consists of the matrix row and column numbers (both counted starting from 1), and the matrix entry. Such a file can be read from Matlab using the command

new_mat = spconvert(load('filename'));
Parameters
matrixreference to matrix
filename
outputPrecision(number of digits) which is used to write the output file

References Dune::writeMatrixToMatlabHelper().

◆ writeMatrixToMatlabHelper() [1/2]

template<class FieldType >
void Dune::writeMatrixToMatlabHelper ( const FieldType &  value,
int  rowOffset,
int  colOffset,
std::ostream &  s,
typename std::enable_if_t< Dune::IsNumber< FieldType >::value > *  sfinae = nullptr 
)

Helper method for the writeMatrixToMatlab routine.

#include <dune/istl/io.hh>

This specialization for numbers ends the recursion

Referenced by Dune::writeMatrixToMatlab(), and Dune::writeMatrixToMatlabHelper().

◆ writeMatrixToMatlabHelper() [2/2]

template<class MatrixType >
void Dune::writeMatrixToMatlabHelper ( const MatrixType &  matrix,
int  externalRowOffset,
int  externalColOffset,
std::ostream &  s,
typename std::enable_if_t<!Dune::IsNumber< MatrixType >::value > *  sfinae = nullptr 
)

Helper method for the writeMatrixToMatlab routine.

#include <dune/istl/io.hh>

References Dune::writeMatrixToMatlabHelper().

◆ writeSVGMatrix() [1/2]

template<class Mat , class SVGOptions = DefaultSVGMatrixOptions>
void Dune::writeSVGMatrix ( const Mat &  mat,
std::ostream &  out,
SVGOptions  opts = {} 
)

Writes the visualization of matrix in the SVG format.

The default visualization writes a rectangle for every block bounding box. This is enough to visualize patterns. If you need a more advance SVG object in each matrix block (e.g. color scale, or write the value in text), just provide a custom SVGOptions that fulfills the DefaultSVGMatrixOptions interface.

Template Parameters
MatMatrix type to write
SVGOptionsOptions object type (see DefaultSVGMatrixOptions)
Parameters
matThe matrix to write
outA output stream to write SVG to
optsSVG Options object
Deprecated:
Use signature where std::stream is the first argument. This method will be removed after Dune 2.10.

◆ writeSVGMatrix() [2/2]

template<class Mat , class SVGOptions = DefaultSVGMatrixOptions>
void Dune::writeSVGMatrix ( std::ostream &  out,
const Mat &  mat,
SVGOptions  opts = {} 
)

Writes the visualization of matrix in the SVG format.

The default visualization writes a rectangle for every block bounding box. This is enough to visualize patterns. If you need a more advance SVG object in each matrix block (e.g. color scale, or write the value in text), just provide a custom SVGOptions that fulfills the DefaultSVGMatrixOptions interface.

Template Parameters
MatMatrix type to write
SVGOptionsOptions object type (see DefaultSVGMatrixOptions)
Parameters
matThe matrix to write
outA output stream to write SVG to
optsSVG Options object

◆ writeVectorToMatlab()

template<class VectorType >
void Dune::writeVectorToMatlab ( const VectorType &  vector,
const std::string &  filename,
int  outputPrecision = 18 
)

Writes vectors in a Matlab-readable format.

#include <dune/istl/io.hh>

This routine writes the argument block vector to a file with the name given by the filename argument. The file format is ASCII, with no header, and a single data column. Such a file can be read from Matlab using the command

new_vec = load('filename');
Parameters
vectorreference to vector to be printed to output file
filenamefilename of output file
outputPrecision(number of digits) which is used to write the output file
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.111.3 (Jul 17, 22:30, 2024)