istl/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_ISTL_VECTOR_HH
#define DUNE_PDELAB_BACKEND_ISTL_VECTOR_HH
 
#include <dune/common/fvector.hh>
#include <dune/common/shared_ptr.hh>
#include <dune/istl/bvector.hh>
#include <dune/typetree/typetree.hh>
#include <dune/functions/backends/istlvectorbackend.hh>
 
#include <dune/pdelab/backend/interface.hh>
#include <dune/pdelab/backend/common/tags.hh>
#include <dune/pdelab/backend/common/uncachedvectorview.hh>
#include <dune/pdelab/backend/common/aliasedvectorview.hh>
#include <dune/pdelab/backend/istl/descriptors.hh>
#include <dune/pdelab/backend/istl/vectorhelpers.hh>
#include <dune/pdelab/backend/istl/vectoriterator.hh>
#include <dune/pdelab/gridfunctionspace/gridfunctionspace.hh>
#include <dune/pdelab/gridfunctionspace/lfsindexcache.hh>
#include <dune/pdelab/gridfunctionspace/tags.hh>
 
namespace Dune {
  namespace PDELab {
    namespace ISTL {
 
      template<typename GFS, typename C>
      class BlockVector
        : public Backend::impl::Wrapper<C>
      {
 
        friend Backend::impl::Wrapper<C>;
 
      public:
        typedef typename C::field_type ElementType;
        typedef ElementType E;
        typedef C Container;
        typedef GFS GridFunctionSpace;
        typedef typename Container::field_type field_type;
        typedef typename Container::block_type block_type;
        typedef typename Container::size_type size_type;
 
        using value_type = E;
 
        typedef typename GFS::Ordering::Traits::ContainerIndex ContainerIndex;
 
        typedef ISTL::vector_iterator<C> iterator;
        typedef ISTL::vector_iterator<const C> const_iterator;
 
 
        template<typename LFSCache>
        using LocalView = UncachedVectorView<BlockVector,LFSCache>;
 
        template<typename LFSCache>
        using ConstLocalView = ConstUncachedVectorView<const BlockVector,LFSCache>;
 
        template<typename LFSCache>
        using AliasedLocalView = AliasedVectorView<BlockVector,LFSCache>;
 
        template<typename LFSCache>
        using ConstAliasedLocalView = ConstAliasedVectorView<const BlockVector,LFSCache>;
 
        BlockVector(const BlockVector& rhs)
          : _gfs(rhs._gfs)
          , _container(std::make_shared<Container>(_gfs->ordering().blockCount()))
        {
          resize();
          (*_container) = rhs.native();
        }
 
        BlockVector(BlockVector&& rhs)
          : _gfs(rhs._gfs)
          , _container(std::move(rhs._container))
        {}
 
        BlockVector (std::shared_ptr<const GFS> gfs, Backend::attached_container = Backend::attached_container())
          : _gfs(gfs)
          , _container(std::make_shared<Container>())
        {
          resize();
        }
 
        BlockVector(std::shared_ptr<const GFS> gfs, Backend::unattached_container)
          : _gfs(gfs)
        {}
 
        BlockVector (std::shared_ptr<const GFS> gfs, Container& container)
          : _gfs(gfs)
          , _container(stackobject_to_shared_ptr(container))
        {
          resize();
        }
 
        BlockVector (std::shared_ptr<const GFS> gfs, const E& e)
          : _gfs(gfs)
          , _container(std::make_shared<Container>())
        {
          resize();
          (*_container)=e;
        }
 
        BlockVector (const GFS& gfs, Backend::attached_container tag = Backend::attached_container())
          : BlockVector(Dune::stackobject_to_shared_ptr(gfs), tag)
        {}
 
        BlockVector(const GFS& gfs, Backend::unattached_container tag)
          : BlockVector(Dune::stackobject_to_shared_ptr(gfs), tag)
        {}
 
        BlockVector (const GFS& gfs, Container& container)
          : BlockVector(Dune::stackobject_to_shared_ptr(gfs), container)
        {}
 
        BlockVector (const GFS& gfs, const E& e)
          : BlockVector(Dune::stackobject_to_shared_ptr(gfs), e)
        {}
 
        void resize()
        {
          assert(_gfs);
          auto b = Functions::istlVectorBackend(*_container);
          SizeProviderAdapter size_provider{_gfs->orderingStorage()};
          static_assert(decltype(size_provider)::ContainerIndexOrder == MultiIndexOrder::Outer2Inner);
          b.resize(size_provider);
        }
 
        void detach()
        {
          _container.reset();
        }
 
        template<typename LFSCache>
        value_type* data(const LFSCache& lfs_cache)
        {
          return &((*this)[lfs_cache.containerIndex(0)]);
        }
 
        template<typename LFSCache>
        const value_type* data(const LFSCache& lfs_cache) const
        {
          return &((*this)[lfs_cache.containerIndex(0)]);
        }
 
        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->N();
        }
 
        BlockVector& operator= (const BlockVector& r)
        {
          if (this == &r)
            return *this;
          if (attached())
            {
              (*_container) = r.native();
            }
          else
            {
              _container = std::make_shared<Container>(r.native());
            }
          return *this;
        }
 
        BlockVector& operator= (const E& e)
        {
          (*_container)=e;
          return *this;
        }
 
        BlockVector& operator*= (const E& e)
        {
          (*_container)*=e;
          return *this;
        }
 
 
        BlockVector& operator+= (const E& e)
        {
          (*_container)+=e;
          return *this;
        }
 
        BlockVector& operator+= (const BlockVector& e)
        {
          (*_container)+= e.native();
          return *this;
        }
 
        BlockVector& operator-= (const BlockVector& e)
        {
          (*_container)-= e.native();
          return *this;
        }
 
        block_type& block(std::size_t i)
        {
          return (*_container)[i];
        }
 
        const block_type& block(std::size_t i) const
        {
          return (*_container)[i];
        }
 
        E& operator[](const ContainerIndex& ci)
        {
          return ISTL::access_vector_element(ISTL::container_tag(*_container),*_container,ci,ci.size()-1);
        }
 
        const E& operator[](const ContainerIndex& ci) const
        {
          return ISTL::access_vector_element(ISTL::container_tag(*_container),*_container,ci,ci.size()-1);
        }
 
        typename Dune::template FieldTraits<E>::real_type two_norm2() const
        {
          return _container->two_norm2();
        }
 
        typename Dune::template FieldTraits<E>::real_type two_norm() const
        {
          return _container->two_norm();
        }
 
        typename Dune::template FieldTraits<E>::real_type one_norm() const
        {
          return _container->one_norm();
        }
 
        typename Dune::template FieldTraits<E>::real_type infinity_norm() const
        {
          return _container->infinity_norm();
        }
 
        E operator*(const BlockVector& y) const
        {
          return (*_container)*y.native();
        }
 
        E dot(const BlockVector& y) const
        {
          return _container->dot(y.native());
        }
 
        BlockVector& axpy(const E& a, const BlockVector& y)
        {
          _container->axpy(a, y.native());
          return *this;
        }
 
      private:
 
        // for debugging and AMG access
        Container& native ()
        {
          return *_container;
        }
 
        const Container& native () const
        {
          return *_container;
        }
 
      public:
 
        operator Container&()
        {
          return *_container;
        }
 
        operator const Container&() const
        {
          return *_container;
        }
 
        iterator begin()
        {
          return iterator(*_container,false);
        }
 
 
        const_iterator begin() const
        {
          return const_iterator(*_container,false);
        }
 
        iterator end()
        {
          return iterator(*_container,true);
        }
 
 
        const_iterator end() const
        {
          return const_iterator(*_container,true);
        }
 
        size_t flatsize() const
        {
          return _container->dim();
        }
 
        const GFS& gridFunctionSpace() const
        {
          return *_gfs;
        }
 
        std::shared_ptr<const GFS> gridFunctionSpaceStorage() const
        {
          return _gfs;
        }
 
      private:
        std::shared_ptr<const GFS> _gfs;
        std::shared_ptr<Container> _container;
      };
 
#ifndef DOXYGEN
 
      // helper struct invoking the GFS tree -> ISTL vector reduction
      template<typename GFS, typename E>
      struct BlockVectorSelectorHelper
      {
 
        typedef typename TypeTree::AccumulateType<
          GFS,
          ISTL::vector_creation_policy<E>
          >::type vector_descriptor;
 
        typedef BlockVector<GFS,typename vector_descriptor::vector_type> Type;
 
      };
 
#endif // DOXYGEN
 
    // can't have the closing of the namespace inside the #ifndef DOXYGEN block
    } // namespace ISTL
 
#ifndef DOXYGEN
 
    namespace Backend {
      namespace impl {
 
        template<Dune::PDELab::ISTL::Blocking blocking, std::size_t block_size, typename GFS, typename E>
        struct BackendVectorSelectorHelper<ISTL::VectorBackend<blocking,block_size>, GFS, E>
          : public ISTL::BlockVectorSelectorHelper<GFS,E>
        {};
 
      } // namespace impl
    } // namespace Backend
 
#endif // DOXYGEN
 
  } // namespace PDELab
} // namespace Dune
 
#endif // DUNE_PDELAB_BACKEND_ISTL_VECTOR_HH