dune-istl  2.7.1
Public Types | Public Member Functions | Public Attributes | List of all members
Dune::ColCompMatrix< Mat, I > Class Template Reference

Utility class for converting an ISTL Matrix into a column-compressed matrix. More...

#include <dune/istl/colcompmatrix.hh>

Inheritance diagram for Dune::ColCompMatrix< Mat, I >:
Inheritance graph

Public Types

using Matrix = Mat
 The type of the matrix to convert. More...
 
typedef Matrix::size_type size_type
 
using Index = I
 

Public Member Functions

 ColCompMatrix (const Matrix &mat)
 Constructor that initializes the data. More...
 
 ColCompMatrix ()
 
virtual ~ColCompMatrix ()
 Destructor. More...
 
size_type N () const
 Get the number of rows. More...
 
size_type nnz () const
 
size_type M () const
 Get the number of columns. More...
 
B * getValues () const
 
IndexgetRowIndex () const
 
IndexgetColStart () const
 
ColCompMatrixoperator= (const Matrix &mat)
 
ColCompMatrixoperator= (const ColCompMatrix &mat)
 
virtual void setMatrix (const Matrix &mat, const std::set< std::size_t > &mrs)
 Initialize data from a given set of matrix rows and columns. More...
 
virtual void free ()
 free allocated space. More...
 
virtual void setMatrix (const Matrix &mat)
 Initialize data from given matrix. More...
 

Public Attributes

size_type N_
 
size_type M_
 
size_type Nnz_
 
B * values
 
Indexrowindex
 
Indexcolstart
 

Detailed Description

template<class Mat, class I = int>
class Dune::ColCompMatrix< Mat, I >

Utility class for converting an ISTL Matrix into a column-compressed matrix.

Template Parameters
MThe matrix type
Ithe internal index type

Member Typedef Documentation

◆ Index

template<class Mat , class I = int>
using Dune::ColCompMatrix< Mat, I >::Index = I

◆ Matrix

template<class Mat , class I = int>
using Dune::ColCompMatrix< Mat, I >::Matrix = Mat

The type of the matrix to convert.

◆ size_type

template<class Mat , class I = int>
typedef Matrix::size_type Dune::ColCompMatrix< Mat, I >::size_type

Constructor & Destructor Documentation

◆ ColCompMatrix() [1/2]

template<class Mat , class I = int>
Dune::ColCompMatrix< Mat, I >::ColCompMatrix ( const Matrix mat)
explicit

Constructor that initializes the data.

Parameters
matThe matrix to convert.

◆ ColCompMatrix() [2/2]

template<class Mat , class I = int>
Dune::ColCompMatrix< Mat, I >::ColCompMatrix ( )

◆ ~ColCompMatrix()

template<class Mat , class I = int>
virtual Dune::ColCompMatrix< Mat, I >::~ColCompMatrix ( )
virtual

Destructor.

Member Function Documentation

◆ free()

template<class Mat , class I = int>
virtual void Dune::ColCompMatrix< Mat, I >::free ( )
virtual

free allocated space.

Reimplemented in Dune::SuperLUMatrix< BCRSMatrix< B, TA > >.

◆ getColStart()

template<class Mat , class I = int>
Index* Dune::ColCompMatrix< Mat, I >::getColStart ( ) const
inline

◆ getRowIndex()

template<class Mat , class I = int>
Index* Dune::ColCompMatrix< Mat, I >::getRowIndex ( ) const
inline

◆ getValues()

template<class Mat , class I = int>
B* Dune::ColCompMatrix< Mat, I >::getValues ( ) const
inline

◆ M()

template<class Mat , class I = int>
size_type Dune::ColCompMatrix< Mat, I >::M ( ) const
inline

Get the number of columns.

Returns
The number of columns.

◆ N()

template<class Mat , class I = int>
size_type Dune::ColCompMatrix< Mat, I >::N ( ) const
inline

Get the number of rows.

Returns
The number of rows.

◆ nnz()

template<class Mat , class I = int>
size_type Dune::ColCompMatrix< Mat, I >::nnz ( ) const
inline

◆ operator=() [1/2]

template<class Mat , class I = int>
ColCompMatrix& Dune::ColCompMatrix< Mat, I >::operator= ( const ColCompMatrix< Mat, I > &  mat)

◆ operator=() [2/2]

template<class Mat , class I = int>
ColCompMatrix& Dune::ColCompMatrix< Mat, I >::operator= ( const Matrix mat)

◆ setMatrix() [1/2]

template<class Mat , class I = int>
virtual void Dune::ColCompMatrix< Mat, I >::setMatrix ( const Matrix mat)
virtual

Initialize data from given matrix.

Reimplemented in Dune::SuperLUMatrix< BCRSMatrix< B, TA > >.

◆ setMatrix() [2/2]

template<class Mat , class I = int>
virtual void Dune::ColCompMatrix< Mat, I >::setMatrix ( const Matrix mat,
const std::set< std::size_t > &  mrs 
)
virtual

Initialize data from a given set of matrix rows and columns.

Parameters
matthe matrix with the values
mrsThe set of row (and column) indices to remove

Reimplemented in Dune::SuperLUMatrix< BCRSMatrix< B, TA > >.

Member Data Documentation

◆ colstart

template<class Mat , class I = int>
Index* Dune::ColCompMatrix< Mat, I >::colstart

◆ M_

template<class Mat , class I = int>
size_type Dune::ColCompMatrix< Mat, I >::M_

◆ N_

template<class Mat , class I = int>
size_type Dune::ColCompMatrix< Mat, I >::N_

◆ Nnz_

template<class Mat , class I = int>
size_type Dune::ColCompMatrix< Mat, I >::Nnz_

◆ rowindex

template<class Mat , class I = int>
Index* Dune::ColCompMatrix< Mat, I >::rowindex

◆ values

template<class Mat , class I = int>
B* Dune::ColCompMatrix< Mat, I >::values

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