Dune Core Modules (2.7.1)

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>

Public Types

using Matrix = Mat
 The type of the matrix to convert.
 

Public Member Functions

 ColCompMatrix (const Matrix &mat)
 Constructor that initializes the data. More...
 
virtual ~ColCompMatrix ()
 Destructor.
 
size_type N () const
 Get the number of rows. More...
 
size_type M () const
 Get the number of columns. More...
 
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.
 
virtual void setMatrix (const Matrix &mat)
 Initialize data from given matrix.
 

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

Constructor & Destructor Documentation

◆ ColCompMatrix()

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.

Member Function Documentation

◆ 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.

Referenced by Dune::UMFPack< M >::apply(), and Dune::UMFPack< M >::setMatrix().

◆ 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.

Referenced by Dune::UMFPack< M >::apply(), and Dune::UMFPack< M >::setMatrix().

◆ setMatrix()

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 > >.


The documentation for this class was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.111.3 (Nov 13, 23:29, 2024)