dune-istl 2.8.0
|
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. | |
Namespaces | |
namespace | Dune::MatrixMarketImpl |
Classes | |
class | Dune::MatrixMarketFormatError |
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 B , int n, int m, class A > | |
void | Dune::printSparseMatrix (std::ostream &s, const BCRSMatrix< FieldMatrix< B, n, m >, 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 V > | |
void | Dune::writeVectorToMatlabHelper (const V &v, std::ostream &stream) |
template<class VectorType > | |
void | Dune::writeVectorToMatlab (const VectorType &vector, const std::string &filename, int outputPrecision=18) |
Writes vectors in a Matlab-readable format. More... | |
void | Dune::mm_read_header (std::size_t &rows, std::size_t &cols, MatrixMarketImpl::MMHeader &header, std::istream &istr, bool isVector) |
template<typename T , typename A > | |
void | Dune::mm_read_vector_entries (Dune::BlockVector< T, A > &vector, std::size_t size, std::istream &istr, size_t lane) |
template<typename T , typename A , int entries> | |
void | Dune::mm_read_vector_entries (Dune::BlockVector< Dune::FieldVector< T, entries >, A > &vector, std::size_t size, std::istream &istr, size_t lane) |
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 B > | |
void | Dune::mm_print_entry (const B &entry, std::size_t rowidx, std::size_t colidx, std::ostream &ostr) |
template<typename V > | |
void | Dune::mm_print_vector_entry (const V &entry, std::ostream &ostr, const std::integral_constant< int, 1 > &, size_t lane) |
template<typename V > | |
void | Dune::mm_print_vector_entry (const V &vector, std::ostream &ostr, const std::integral_constant< int, 0 > &, size_t lane) |
template<typename T , typename A > | |
std::size_t | Dune::countEntries (const BlockVector< T, A > &vector) |
template<typename T , typename A , int i> | |
std::size_t | Dune::countEntries (const BlockVector< FieldVector< T, i >, A > &vector) |
template<typename V > | |
void | Dune::writeMatrixMarket (const V &vector, std::ostream &ostr, const std::integral_constant< int, 0 > &) |
template<typename M > | |
void | Dune::writeMatrixMarket (const M &matrix, std::ostream &ostr, const std::integral_constant< int, 1 > &) |
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. More... | |
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... | |
Variables | |
static const int | Dune::default_precision = -1 |
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.
std::size_t Dune::countEntries | ( | const BlockVector< FieldVector< T, i >, A > & | vector | ) |
std::size_t Dune::countEntries | ( | const BlockVector< T, A > & | vector | ) |
|
inline |
Print a row of zeros for a non-existing block.
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.
matrix | Where to store the matrix/vector. |
filename | the name of the filename (without suffix and rank!) rank i will read the file filename_i.mm |
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.
matrix | Where to store the matrix/vector. |
filename | the name of the filename (without suffix and rank!) rank i will read the file filename_i.mm |
comm | The information about the data distribution. |
readIndices | Whether 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. |
void Dune::mm_print_entry | ( | const B & | entry, |
std::size_t | rowidx, | ||
std::size_t | colidx, | ||
std::ostream & | ostr | ||
) |
void Dune::mm_print_vector_entry | ( | const V & | entry, |
std::ostream & | ostr, | ||
const std::integral_constant< int, 1 > & | , | ||
size_t | lane | ||
) |
void Dune::mm_print_vector_entry | ( | const V & | vector, |
std::ostream & | ostr, | ||
const std::integral_constant< int, 0 > & | , | ||
size_t | lane | ||
) |
|
inline |
void Dune::mm_read_vector_entries | ( | Dune::BlockVector< Dune::FieldVector< T, entries >, A > & | vector, |
std::size_t | size, | ||
std::istream & | istr, | ||
size_t | lane | ||
) |
void Dune::mm_read_vector_entries | ( | Dune::BlockVector< T, A > & | vector, |
std::size_t | size, | ||
std::istream & | istr, | ||
size_t | lane | ||
) |
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.
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.
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.
void Dune::printSparseMatrix | ( | std::ostream & | s, |
const BCRSMatrix< FieldMatrix< B, n, m >, A > & | mat, | ||
std::string | title, | ||
std::string | rowtext, | ||
int | width = 3 , |
||
int | precision = 2 |
||
) |
Prints a BCRSMatrix with fixed sized blocks.
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.
s | The ostream to print to. |
mat | The matrix to print. |
title | The title for the matrix. |
rowtext | The text to prepend to each print out of a matrix row. |
width | The number of nonzero blocks to print in one line. |
precision | The precision to use when printing the numbers. |
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.
void Dune::readMatrixMarket | ( | Dune::BCRSMatrix< T, A > & | matrix, |
std::istream & | istr | ||
) |
Reads a sparse matrix from a matrix market file.
matrix | The matrix to store the data in. |
istr | The input stream to read the data from. |
void Dune::readMatrixMarket | ( | Dune::BlockVector< T, A > & | vector, |
std::istream & | istr | ||
) |
Reads a BlockVector from a matrix market file.
vector | The vector to store the data in. |
istr | The input stream to read the data from. |
void Dune::recursive_printvector | ( | std::ostream & | s, |
const V & | v, | ||
std::string | rowtext, | ||
int & | counter, | ||
int | columns, | ||
int | width | ||
) |
Recursively print a vector.
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.
matrix | The matrix/vector to store. |
filename | the name of the filename (without suffix and rank!) rank i will write the file filename_i.mm |
comm | The information about the data distribution. |
storeIndices | Whether to store the parallel index information. If true rank i writes the index information to file filename_i.idx. |
prec | Set the decimal precision to be used |
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.
matrix | The matrix/vector to store. |
filename | the name of the filename (without suffix and rank!) rank i will write the file filename_i.mm |
prec | Set the decimal precision to be used |
void Dune::writeMatrixMarket | ( | const M & | matrix, |
std::ostream & | ostr | ||
) |
writes a ISTL matrix or vector to a stream in matrix market format.
void Dune::writeMatrixMarket | ( | const M & | matrix, |
std::ostream & | ostr, | ||
const std::integral_constant< int, 1 > & | |||
) |
void Dune::writeMatrixMarket | ( | const V & | vector, |
std::ostream & | ostr, | ||
const std::integral_constant< int, 0 > & | |||
) |
void Dune::writeMatrixToMatlab | ( | const MatrixType & | matrix, |
const std::string & | filename, | ||
int | outputPrecision = 18 |
||
) |
Writes sparse matrix in a Matlab-readable format.
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
matrix | reference to matrix |
filename | |
outputPrecision | (number of digits) which is used to write the output file |
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.
This specialization for numbers ends the recursion
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.
void Dune::writeVectorToMatlab | ( | const VectorType & | vector, |
const std::string & | filename, | ||
int | outputPrecision = 18 |
||
) |
Writes vectors in a Matlab-readable format.
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
vector | reference to vector to be printed to output file |
filename | filename of output file |
outputPrecision | (number of digits) which is used to write the output file |
void Dune::writeVectorToMatlabHelper | ( | const V & | v, |
std::ostream & | stream | ||
) |
|
static |