eigen/vector.hh

Go to the documentation of this file.

// -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
// vi: set et ts=4 sw=2 sts=2:
#ifndef DUNE_PDELAB_BACKEND_EIGEN_VECTOR_HH
#define DUNE_PDELAB_BACKEND_EIGEN_VECTOR_HH
 
#if HAVE_EIGEN
 
#include <memory>
 
#include <dune/common/shared_ptr.hh>
#include <dune/istl/bvector.hh>
 
#include <dune/pdelab/backend/common/tags.hh>
#include <dune/pdelab/backend/interface.hh>
#include <dune/pdelab/backend/common/uncachedvectorview.hh>
#include "descriptors.hh"
#include <Eigen/Dense>
 
namespace Dune {
  namespace PDELab {
 
    namespace Eigen {
 
      template<typename GFS, typename ET>
      class VectorContainer
        : public Backend::impl::Wrapper<::Eigen::Matrix<ET, ::Eigen::Dynamic, 1>>
      {
      public:
        typedef ::Eigen::Matrix<ET, ::Eigen::Dynamic, 1> Container;
 
      private:
 
        friend Backend::impl::Wrapper<Container>;
 
      public:
        typedef ET ElementType;
        typedef ET E;
 
        // for ISTL solver compatibility
        typedef ElementType field_type;
 
        typedef GFS GridFunctionSpace;
          typedef std::size_t size_type;
 
        typedef typename GFS::Ordering::Traits::ContainerIndex ContainerIndex;
 
        typedef ElementType* iterator;
        typedef const ElementType* const_iterator;
        // #warning iterators does not work well with Eigen
        // typedef typename Container::iterator iterator;
        // typedef typename Container::const_iterator const_iterator;
 
        template<typename LFSCache>
        using LocalView = UncachedVectorView<VectorContainer,LFSCache>;
 
        template<typename LFSCache>
        using ConstLocalView = ConstUncachedVectorView<const VectorContainer,LFSCache>;
 
        VectorContainer(const VectorContainer& rhs)
          : _gfs(rhs._gfs)
          , _container(std::make_shared<Container>(*(rhs._container)))
        {}
 
        VectorContainer (const GFS& gfs, Backend::attached_container = Backend::attached_container())
          : _gfs(gfs)
          , _container(std::make_shared<Container>(gfs.ordering().blockCount()))
        {}
 
        VectorContainer(const GFS& gfs, Backend::unattached_container)
          : _gfs(gfs)
        {}
 
        VectorContainer (const GFS& gfs, Container& container)
          : _gfs(gfs)
          , _container(stackobject_to_shared_ptr(container))
        {
          _container->resize(gfs.ordering().blockCount());
        }
 
        VectorContainer (const GFS& gfs, const E& e)
          : _gfs(gfs)
          , _container(std::make_shared<Container>(Container::Constant(gfs.ordering().blockCount(),e)))
        {}
 
        void detach()
        {
          _container.reset();
        }
 
        void attach(std::shared_ptr<Container> container)
        {
          _container = container;
        }
 
        bool attached() const
        {
          return bool(_container);
        }
 
        const std::shared_ptr<Container>& storage() const
        {
          return _container;
        }
 
        size_type N() const
        {
          return _container->size();
        }
 
        VectorContainer& operator=(const VectorContainer& r)
        {
          if (this == &r)
            return *this;
          if (attached())
            {
              (*_container) = (*r._container);
            }
          else
            {
              _container = std::make_shared<Container>(*(r._container));
            }
          return *this;
        }
 
        VectorContainer& operator=(const E& e)
        {
          (*_container) = Container::Constant(N(),e);
          return *this;
        }
 
        VectorContainer& operator*=(const E& e)
        {
          (*_container) *= e;
          return *this;
        }
 
 
        VectorContainer& operator+=(const E& e)
        {
          (*_container) += Container::Constant(N(),e);
          return *this;
        }
 
        VectorContainer& operator+=(const VectorContainer& y)
        {
          (*_container) += (*y._container);
          return *this;
        }
 
        VectorContainer& operator-= (const VectorContainer& y)
        {
          (*_container) -= (*y._container);
          return *this;
        }
 
        E& operator[](const ContainerIndex& ci)
        {
          return (*_container)(ci[0]);
        }
 
        const E& operator[](const ContainerIndex& ci) const
        {
          return (*_container)(ci[0]);
        }
 
        typename Dune::template FieldTraits<E>::real_type two_norm() const
        {
          return _container->norm();
        }
 
        typename Dune::template FieldTraits<E>::real_type one_norm() const
        {
          return _container->template lpNorm<1>();
        }
 
        typename Dune::template FieldTraits<E>::real_type infinity_norm() const
        {
          return _container->template lpNorm<::Eigen::Infinity>();
        }
 
        E operator*(const VectorContainer& y) const
        {
          return _container->transpose() * (*y._container);
        }
 
        E dot(const VectorContainer& y) const
        {
          return _container->dot(*y._container);
        }
 
        VectorContainer& axpy(const E& a, const VectorContainer& y)
        {
          (*_container) += a * (*y._container);
          return *this;
        }
 
        // for debugging and AMG access
        Container& base ()
        {
          return *_container;
        }
 
        const Container& base () const
        {
          return *_container;
        }
 
      private:
 
        Container& native ()
        {
          return *_container;
        }
 
        const Container& native () const
        {
          return *_container;
        }
 
      public:
 
        iterator begin()
        {
          return _container->data();
        }
 
        const_iterator begin() const
        {
          return _container->data();
        }
 
        iterator end()
        {
          return _container->data() + N();
        }
 
        const_iterator end() const
        {
          return _container->data() + N();
        }
 
        size_t flatsize() const
        {
          return _container->size();
        }
 
        const GFS& gridFunctionSpace() const
        {
          return _gfs;
        }
 
      private:
        const GFS& _gfs;
        std::shared_ptr<Container> _container;
 
      };
 
    } // end namespace EIGEN
 
 
#ifndef DOXYGEN
 
    template<typename GFS, typename E>
    struct EigenVectorSelectorHelper
    {
      using Type = PDELab::Eigen::VectorContainer<GFS, E>;
    };
 
    namespace Backend {
      namespace impl {
 
        template<typename GFS, typename E>
        struct BackendVectorSelectorHelper<Eigen::VectorBackend, GFS, E>
          : public EigenVectorSelectorHelper<GFS,E>
        {};
 
      } // namespace impl
    } // namespace Backend
 
#endif // DOXYGEN
 
  } // namespace PDELab
} // namespace Dune
 
#endif
 
#endif // DUNE_PDELAB_BACKEND_EIGEN_VECTOR_HH