Detailed Description

Manages storage for matrices and vectors.

This is a simple implementation of the MatrixProvider and VectorProvider interfaces.

It is simple insofar it does not reuse released matrices/vectors, but keeps them in memory until they are acquired again by the user.

Definition at line 29 of file SimpleMatrixVectorProvider.h.

#include <SimpleMatrixVectorProvider.h>

Inheritance diagram for NumLib::SimpleMatrixVectorProvider:

[legend]

Collaboration diagram for NumLib::SimpleMatrixVectorProvider:

[legend]

Public Member Functions
	SimpleMatrixVectorProvider ()=default

	SimpleMatrixVectorProvider (SimpleMatrixVectorProvider const &)=delete

SimpleMatrixVectorProvider &	operator= (SimpleMatrixVectorProvider const &)=delete

GlobalVector &	getVector (std::size_t &id) override
	Get an uninitialized vector with the given `id`.

GlobalVector &	getVector (GlobalVector const &x) override
	Get a copy of `x`.

GlobalVector &	getVector (GlobalVector const &x, std::size_t &id) override
	Get a copy of `x` in the storage of the vector with the given `id`.

GlobalVector &	getVector (MathLib::MatrixSpecifications const &ms) override
	Get a vector according to the given specifications.

GlobalVector &	getVector (MathLib::MatrixSpecifications const &ms, std::size_t &id) override

void	releaseVector (GlobalVector const &x) override

GlobalMatrix &	getMatrix (std::size_t &id) override
	Get an uninitialized matrix with the given `id`.

GlobalMatrix &	getMatrix (MathLib::MatrixSpecifications const &ms, std::size_t &id) override

void	releaseMatrix (GlobalMatrix const &A) override

void	clear ()

	~SimpleMatrixVectorProvider () override

Public Member Functions inherited from NumLib::MatrixProvider
virtual	~MatrixProvider ()=default

Public Member Functions inherited from NumLib::VectorProvider
virtual	~VectorProvider ()=default

Private Member Functions
template<typename... Args>
std::pair< GlobalMatrix *, bool >	getMatrix_ (std::size_t &id, Args &&... args)

template<typename... Args>
std::pair< GlobalVector *, bool >	getVector_ (std::size_t &id, Args &&... args)

template<typename MatVec , typename... Args>
std::pair< MatVec *, bool >	get_ (std::size_t &id, std::map< MatVec *, std::size_t > &used_map, Args &&... args)

Private Attributes
std::size_t	_next_id = 1

std::map< GlobalMatrix *, std::size_t >	_used_matrices

std::map< GlobalVector *, std::size_t >	_used_vectors

Constructor & Destructor Documentation

◆ SimpleMatrixVectorProvider() [1/2]

NumLib::SimpleMatrixVectorProvider::SimpleMatrixVectorProvider ( )

default

◆ SimpleMatrixVectorProvider() [2/2]

NumLib::SimpleMatrixVectorProvider::SimpleMatrixVectorProvider ( SimpleMatrixVectorProvider const & )

delete

◆ ~SimpleMatrixVectorProvider()

NumLib::SimpleMatrixVectorProvider::~SimpleMatrixVectorProvider ( )

override

Definition at line 167 of file SimpleMatrixVectorProvider.cpp.

{
    clear();
}

References clear().

Member Function Documentation

◆ clear()

void NumLib::SimpleMatrixVectorProvider::clear ( )

Definition at line 137 of file SimpleMatrixVectorProvider.cpp.

{
    if (!_used_matrices.empty())
    {
        WARN(
            "There are still {:d} global matrices in use."
            " This might be an indicator of a possible waste of memory.",
            _used_matrices.size());
    }
    if (!_used_vectors.empty())
    {
        WARN(
            "There are still {:d} global vectors in use."
            " This might be an indicator of a possible waste of memory.",
            _used_vectors.size());
    }
 
    for (auto const& ptr_id : _used_matrices)
    {
        delete ptr_id.first;
    }
    _used_matrices.clear();
 
    for (auto const& ptr_id : _used_vectors)
    {
        delete ptr_id.first;
    }
    _used_vectors.clear();
}

References _used_matrices, _used_vectors, and WARN().

Referenced by ~SimpleMatrixVectorProvider().

◆ get_()

template<typename MatVec , typename... Args>

std::pair< MatVec *, bool > NumLib::SimpleMatrixVectorProvider::get_	(	std::size_t &	id,
		std::map< MatVec *, std::size_t > &	used_map,
		Args &&...	args )

private

Definition at line 25 of file SimpleMatrixVectorProvider.cpp.

{
    id = _next_id++;
    auto res =
        used_map.emplace(MathLib::MatrixVectorTraits<MatVec>::newInstance(
                             std::forward<Args>(args)...)
                             .release(),
                         id);
    return {res.first->first, true};
}

References _next_id.

Referenced by getMatrix_(), and getVector_().

◆ getMatrix() [1/2]

GlobalMatrix & NumLib::SimpleMatrixVectorProvider::getMatrix	(	MathLib::MatrixSpecifications const &	ms,
		std::size_t &	id )

overridevirtual

Get a matrix according to the given specifications in the storage of the matrix with the given id.

Implements NumLib::MatrixProvider.

Definition at line 49 of file SimpleMatrixVectorProvider.cpp.

{
    return *getMatrix_(id, ms).first;
    // TODO assert that the returned object always is of the right size
}

References getMatrix_().

◆ getMatrix() [2/2]

GlobalMatrix & NumLib::SimpleMatrixVectorProvider::getMatrix ( std::size_t & id )

overridevirtual

Get an uninitialized matrix with the given id.

Implements NumLib::MatrixProvider.

Definition at line 44 of file SimpleMatrixVectorProvider.cpp.

{
    return *getMatrix_(id).first;
}

References getMatrix_().

◆ getMatrix_()

template<typename... Args>

std::pair< GlobalMatrix *, bool > NumLib::SimpleMatrixVectorProvider::getMatrix_	(	std::size_t &	id,
		Args &&...	args )

private

Definition at line 38 of file SimpleMatrixVectorProvider.cpp.

{
    return get_(id, _used_matrices, std::forward<Args>(args)...);
}

References _used_matrices, and get_().

Referenced by getMatrix(), and getMatrix().

◆ getVector() [1/5]

GlobalVector & NumLib::SimpleMatrixVectorProvider::getVector ( GlobalVector const & x )

overridevirtual

Get a copy of x.

Implements NumLib::VectorProvider.

Definition at line 99 of file SimpleMatrixVectorProvider.cpp.

{
    std::size_t id = 0u;
    auto const& res = getVector_(id, x);
    if (!res.second)
    {  // no new object has been created
        LinAlg::copy(x, *res.first);
    }
    return *res.first;
}

References MathLib::LinAlg::copy(), and getVector_().

◆ getVector() [2/5]

GlobalVector & NumLib::SimpleMatrixVectorProvider::getVector	(	GlobalVector const &	x,
		std::size_t &	id )

overridevirtual

Get a copy of x in the storage of the vector with the given id.

Implements NumLib::VectorProvider.

Definition at line 110 of file SimpleMatrixVectorProvider.cpp.

{
    auto const& res = getVector_(id, x);
    if (!res.second)
    {  // no new object has been created
        LinAlg::copy(x, *res.first);
    }
    return *res.first;
}

References MathLib::LinAlg::copy(), and getVector_().

◆ getVector() [3/5]

GlobalVector & NumLib::SimpleMatrixVectorProvider::getVector ( MathLib::MatrixSpecifications const & ms )

overridevirtual

Get a vector according to the given specifications.

Implements NumLib::VectorProvider.

Definition at line 84 of file SimpleMatrixVectorProvider.cpp.

{
    std::size_t id = 0u;
    return *getVector_(id, ms).first;
    // TODO assert that the returned object always is of the right size
}

References getVector_().

◆ getVector() [4/5]

GlobalVector & NumLib::SimpleMatrixVectorProvider::getVector	(	MathLib::MatrixSpecifications const &	ms,
		std::size_t &	id )

overridevirtual

Get a vector according to the given specifications in the storage of the vector with the given id.

Implements NumLib::VectorProvider.

Definition at line 92 of file SimpleMatrixVectorProvider.cpp.

{
    return *getVector_(id, ms).first;
    // TODO assert that the returned object always is of the right size
}

References getVector_().

◆ getVector() [5/5]

GlobalVector & NumLib::SimpleMatrixVectorProvider::getVector ( std::size_t & id )

overridevirtual

Get an uninitialized vector with the given id.

Implements NumLib::VectorProvider.

Definition at line 79 of file SimpleMatrixVectorProvider.cpp.

{
    return *getVector_(id).first;
}

References getVector_().

◆ getVector_()

template<typename... Args>

std::pair< GlobalVector *, bool > NumLib::SimpleMatrixVectorProvider::getVector_	(	std::size_t &	id,
		Args &&...	args )

private

Definition at line 73 of file SimpleMatrixVectorProvider.cpp.

{
    return get_(id, _used_vectors, std::forward<Args>(args)...);
}

References _used_vectors, and get_().

Referenced by getVector(), getVector(), getVector(), getVector(), and getVector().

◆ operator=()

SimpleMatrixVectorProvider & NumLib::SimpleMatrixVectorProvider::operator= ( SimpleMatrixVectorProvider const & )

delete

◆ releaseMatrix()

void NumLib::SimpleMatrixVectorProvider::releaseMatrix ( GlobalMatrix const & A )

overridevirtual

Release the given matrix.

Precondition: A must have been acquired before, i.e., you must not call this method twice in a row in the same A!

Implements NumLib::MatrixProvider.

Definition at line 56 of file SimpleMatrixVectorProvider.cpp.

{
    auto it = _used_matrices.find(const_cast<GlobalMatrix*>(&A));
    if (it == _used_matrices.end())
    {
        OGS_FATAL(
            "The given matrix has not been found. Cannot release it. "
            "Aborting.");
    }
    else
    {
        delete it->first;
        _used_matrices.erase(it);
    }
}

References _used_matrices, and OGS_FATAL.

◆ releaseVector()

void NumLib::SimpleMatrixVectorProvider::releaseVector ( GlobalVector const & x )

overridevirtual

Release the given vector.

Precondition: x must have been acquired before, i.e., you must not call this method twice in a row in the same x!

Implements NumLib::VectorProvider.

Definition at line 121 of file SimpleMatrixVectorProvider.cpp.

{
    auto it = _used_vectors.find(const_cast<GlobalVector*>(&x));
    if (it == _used_vectors.end())
    {
        OGS_FATAL(
            "The given vector has not been found. Cannot release it. "
            "Aborting.");
    }
    else
    {
        delete it->first;
        _used_vectors.erase(it);
    }
}