Detailed Description

Global matrix based on Eigen sparse matrix

The matrix will be dynamically allocated during construction.

Definition at line 28 of file EigenMatrix.h.

#include <EigenMatrix.h>

Public Types
using	RawMatrixType = Eigen::SparseMatrix<double, Eigen::RowMajor>
using	IndexType = RawMatrixType::Index

Public Member Functions
	EigenMatrix (IndexType const n, IndexType const n_nonzero_columns=0)
IndexType	getNumberOfRows () const
	return the number of rows
IndexType	getNumberOfColumns () const
	return the number of columns
IndexType	getRangeEnd () const
	return an end index of the active data range
void	setZero ()
	reset data entries to zero.
int	setValue (IndexType row, IndexType col, double val)
int	add (IndexType row, IndexType col, double val)
template<class T_DENSE_MATRIX>
void	add (std::vector< IndexType > const &row_pos, const T_DENSE_MATRIX &sub_matrix, double fkt=1.0)
template<class T_DENSE_MATRIX>
void	add (RowColumnIndices< IndexType > const &indices, const T_DENSE_MATRIX &sub_matrix, double fkt=1.0)
template<class T_DENSE_MATRIX>
void	add (std::vector< IndexType > const &row_pos, std::vector< IndexType > const &col_pos, const T_DENSE_MATRIX &sub_matrix, double fkt=1.0)
double	get (IndexType row, IndexType col) const
	get value. This function returns zero if the element doesn't exist.
void	write (const std::string &filename) const
	printout this matrix for debugging
void	write (std::ostream &os) const
	printout this matrix for debugging
RawMatrixType &	getRawMatrix ()
const RawMatrixType &	getRawMatrix () const

Static Public Member Functions
static constexpr IndexType	getRangeBegin ()
	return a start index of the active data range
static constexpr bool	isAssembled ()
	return always true, i.e. the matrix is always ready for use

Protected Attributes
RawMatrixType	mat_

Member Typedef Documentation

◆ IndexType

using MathLib::EigenMatrix::IndexType = RawMatrixType::Index

Definition at line 32 of file EigenMatrix.h.

◆ RawMatrixType

using MathLib::EigenMatrix::RawMatrixType = Eigen::SparseMatrix<double, Eigen::RowMajor>

Definition at line 31 of file EigenMatrix.h.

Constructor & Destructor Documentation

◆ EigenMatrix()

MathLib::EigenMatrix::EigenMatrix	(	IndexType const	n,
		IndexType const	n_nonzero_columns = 0 )

inlineexplicit

Parameters

n	the number of rows (that is equal to the number of columns).
n_nonzero_columns	the number of non-zero columns used for preallocation.

Definition at line 41 of file EigenMatrix.h.

        : mat_(n, n)
    {
        if (n_nonzero_columns > 0)
        {
            mat_.reserve(Eigen::Matrix<IndexType, Eigen::Dynamic, 1>::Constant(
                n, n_nonzero_columns));
        }
    }

References mat_.

Member Function Documentation

◆ add() [1/4]

int MathLib::EigenMatrix::add	(	IndexType	row,
		IndexType	col,
		double	val )

inline

add a value to the given entry. If the entry doesn't exist, the value is inserted.

Definition at line 87 of file EigenMatrix.h.

    {
        mat_.coeffRef(row, col) += val;
        return 0;
    }

References mat_.

Referenced by add(), add(), add(), ProcessLib::BoundaryConditionAndSourceTerm::Python::BcAndStLocalAssemblerImpl< BcOrStData, ShapeFunction, LowerOrderShapeFunction, GlobalDim >::assemble(), ProcessLib::RobinBoundaryConditionLocalAssembler< ShapeFunction, GlobalDim >::assemble(), ProcessLib::VectorMatrixAssembler::assemble(), ProcessLib::ComponentTransport::ComponentTransportLocalAssemblerInterface::assembleReactionEquation(), ProcessLib::VectorMatrixAssembler::assembleWithJacobian(), ProcessLib::AnchorTerm< GlobalDim >::integrate(), and ProcessLib::EmbeddedAnchor< GlobalDim >::integrate().

◆ add() [2/4]

template<class T_DENSE_MATRIX>

void MathLib::EigenMatrix::add	(	RowColumnIndices< IndexType > const &	indices,
		const T_DENSE_MATRIX &	sub_matrix,
		double	fkt = 1.0 )

inline

Add sub-matrix at positions given by indices. If the entry doesn't exist, this class inserts the value.

Definition at line 106 of file EigenMatrix.h.

    {
        this->add(indices.rows, indices.columns, sub_matrix, fkt);
    }

References add(), MathLib::RowColumnIndices< IDX_TYPE >::columns, and MathLib::RowColumnIndices< IDX_TYPE >::rows.

◆ add() [3/4]

template<class T_DENSE_MATRIX>

void MathLib::EigenMatrix::add	(	std::vector< IndexType > const &	row_pos,
		const T_DENSE_MATRIX &	sub_matrix,
		double	fkt = 1.0 )

inline

Add sub-matrix at positions row_pos and same column positions as the given row positions. If the entry doesn't exist, the value is inserted.

Definition at line 96 of file EigenMatrix.h.

    {
        this->add(row_pos, row_pos, sub_matrix, fkt);
    }

References add().

◆ add() [4/4]

template<class T_DENSE_MATRIX>

void MathLib::EigenMatrix::add	(	std::vector< IndexType > const &	row_pos,
		std::vector< IndexType > const &	col_pos,
		const T_DENSE_MATRIX &	sub_matrix,
		double	fkt = 1.0 )

Add sub-matrix at positions row_pos and col_pos. If the entries doesn't exist in the matrix, the values are inserted.

Parameters

row_pos	a vector of row position indices. The vector size should equal to the number of rows in the given sub-matrix.
col_pos	a vector of column position indices. The vector size should equal to the number of columns in the given sub-matrix.
sub_matrix	a sub-matrix to be added
fkt	a scaling factor applied to all entries in the sub-matrix

Definition at line 153 of file EigenMatrix.h.

{
    auto const n_rows = row_pos.size();
    auto const n_cols = col_pos.size();
    for (auto i = decltype(n_rows){0}; i < n_rows; i++)
    {
        auto const row = row_pos[i];
        for (auto j = decltype(n_cols){0}; j < n_cols; j++)
        {
            auto const col = col_pos[j];
            add(row, col, fkt * sub_matrix(i, j));
        }
    }
};

References add().

◆ get()

double MathLib::EigenMatrix::get	(	IndexType	row,
		IndexType	col ) const

inline

get value. This function returns zero if the element doesn't exist.

Definition at line 131 of file EigenMatrix.h.

    {
        return mat_.coeff(row, col);
    }

References mat_.

◆ getNumberOfColumns()

IndexType MathLib::EigenMatrix::getNumberOfColumns ( ) const

inline

return the number of columns

Definition at line 56 of file EigenMatrix.h.

56{ return mat_.cols(); }

References mat_.

Referenced by setValue().

◆ getNumberOfRows()

IndexType MathLib::EigenMatrix::getNumberOfRows ( ) const

inline

return the number of rows

Definition at line 53 of file EigenMatrix.h.

53{ return mat_.rows(); }

References mat_.

Referenced by getRangeEnd(), MathLib::SetMatrixSparsity< EigenMatrix, SPARSITY_PATTERN >::operator()(), setValue(), and MathLib::EigenLisLinearSolver::solve().

◆ getRangeBegin()

constexpr IndexType MathLib::EigenMatrix::getRangeBegin ( )

inlinestaticconstexpr

return a start index of the active data range

Definition at line 59 of file EigenMatrix.h.

59{ return 0; }

◆ getRangeEnd()

IndexType MathLib::EigenMatrix::getRangeEnd ( ) const

inline

return an end index of the active data range

Definition at line 62 of file EigenMatrix.h.

62{ return getNumberOfRows(); }

MathLib::EigenMatrix::getNumberOfRows

IndexType getNumberOfRows() const

return the number of rows

Definition EigenMatrix.h:53

References getNumberOfRows().

◆ getRawMatrix() [1/2]

RawMatrixType & MathLib::EigenMatrix::getRawMatrix ( )

inline

Definition at line 145 of file EigenMatrix.h.

145{ return mat_; }

References mat_.

Referenced by MathLib::applyKnownSolution(), NumLib::detail::calculateFluxCorrectedTransportPETSc(), MathLib::EigenLinearSolver::compute(), MathLib::SetMatrixSparsity< EigenMatrix, SPARSITY_PATTERN >::operator()(), MathLib::EigenLinearSolver::solve(), and MathLib::EigenLisLinearSolver::solve().

◆ getRawMatrix() [2/2]

const RawMatrixType & MathLib::EigenMatrix::getRawMatrix ( ) const

inline

Definition at line 146 of file EigenMatrix.h.

146{ return mat_; }

References mat_.

◆ isAssembled()

constexpr bool MathLib::EigenMatrix::isAssembled ( )

inlinestaticconstexpr

return always true, i.e. the matrix is always ready for use

Definition at line 137 of file EigenMatrix.h.

137{ return true; }

◆ setValue()

int MathLib::EigenMatrix::setValue	(	IndexType	row,
		IndexType	col,
		double	val )

inline

set a value to the given entry. If the entry doesn't exist, this class dynamically allocates it.

Definition at line 77 of file EigenMatrix.h.

    {
        assert(row < (IndexType)getNumberOfRows() &&
               col < (IndexType)getNumberOfColumns());
        mat_.coeffRef(row, col) = val;
        return 0;
    }

References getNumberOfColumns(), getNumberOfRows(), and mat_.

◆ setZero()

void MathLib::EigenMatrix::setZero ( )

inline

reset data entries to zero.

Definition at line 65 of file EigenMatrix.h.

    {
        auto const N = mat_.nonZeros();
        for (auto i = decltype(N){0}; i < N; i++)
        {
            mat_.valuePtr()[i] = 0;
        }
        // don't use mat_.setZero(). it makes a matrix uncompressed
    }

References mat_.

Referenced by NumLib::detail::calculateFluxCorrectedTransportPETSc().

◆ write() [1/2]

void MathLib::EigenMatrix::write ( const std::string & filename ) const

printout this matrix for debugging

Definition at line 19 of file EigenMatrix.cpp.

{
    std::ofstream of(filename);
    if (of)
    {
        write(of);
    }
}

References write().

Referenced by write().

◆ write() [2/2]

void MathLib::EigenMatrix::write ( std::ostream & os ) const

printout this matrix for debugging

Definition at line 29 of file EigenMatrix.cpp.

{
    for (int k = 0; k < mat_.outerSize(); ++k)
    {
        for (RawMatrixType::InnerIterator it(mat_, k); it; ++it)
        {
            os << it.row() << " " << it.col() << " " << it.value() << "\n";
        }
    }
    os << std::endl;
}

References mat_.

Member Data Documentation

◆ mat_

RawMatrixType MathLib::EigenMatrix::mat_

protected

Definition at line 149 of file EigenMatrix.h.

Referenced by EigenMatrix(), add(), get(), getNumberOfColumns(), getNumberOfRows(), getRawMatrix(), getRawMatrix(), setValue(), setZero(), and write().

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

MathLib/LinAlg/Eigen/EigenMatrix.h
MathLib/LinAlg/Eigen/EigenMatrix.cpp

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Member Typedef Documentation

◆ IndexType

◆ RawMatrixType

Constructor & Destructor Documentation

◆ EigenMatrix()

Member Function Documentation

◆ add() [1/4]

◆ add() [2/4]

◆ add() [3/4]

◆ add() [4/4]

◆ get()

◆ getNumberOfColumns()

◆ getNumberOfRows()

◆ getRangeBegin()

◆ getRangeEnd()

◆ getRawMatrix() [1/2]

◆ getRawMatrix() [2/2]

◆ isAssembled()

◆ setValue()

◆ setZero()

◆ write() [1/2]

◆ write() [2/2]

Member Data Documentation

◆ mat_