nonblockmapper.hh

Go to the documentation of this file.

#ifndef DUNE_FEM_NONBLOCKMAPPER_HH
#define DUNE_FEM_NONBLOCKMAPPER_HH
 
#include <vector>
 
#include <dune/fem/gridpart/common/indexset.hh>
#include <dune/fem/misc/functor.hh>
#include <dune/fem/space/mapper/dofmapper.hh>
 
namespace Dune
{
 
  namespace Fem
  {
 
    // Internal Forward Declarations
    // -----------------------------
 
    template< class BlockMapper, int blockSize >
    class NonBlockMapper;
 
 
    namespace __NonBlockMapper
    {
 
      // Traits
      // ------
 
      template< class BlockMapper, int bS >
      struct Traits
      {
        typedef NonBlockMapper< BlockMapper, bS > DofMapperType;
 
        typedef BlockMapper BlockMapperType;
        typedef typename BlockMapper::ElementType ElementType;
        typedef typename BlockMapper::SizeType SizeType;
        typedef typename BlockMapper::GlobalKeyType GlobalKeyType;
 
        static const int blockSize = bS;
      };
 
 
      // DofMapper
      // ---------
 
      template< class T, template< class > class Base = Dune::Fem::DofMapper >
      class DofMapper
        : public Base< T >
      {
        typedef Base< T > BaseType;
 
        template< class, template< class > class >
        friend class DofMapper;
 
      public:
        typedef typename BaseType::Traits Traits;
 
        typedef typename Traits::BlockMapperType BlockMapperType;
        static const int blockSize = Traits::blockSize;
 
        typedef typename Traits::ElementType ElementType;
        typedef typename Traits::SizeType SizeType;
        typedef typename Traits::GlobalKeyType GlobalKeyType;
 
      private:
        template< class Functor >
        struct BlockFunctor
        {
          explicit BlockFunctor ( Functor functor )
            : functor_( functor )
          {}
 
          template< class GlobalKey >
          void operator() ( int localBlock, const GlobalKey globalKey ) const
          {
            int localDof = blockSize*localBlock;
            SizeType globalDof = blockSize*globalKey;
            const int localEnd = localDof + blockSize;
            while( localDof != localEnd )
              functor_( localDof++, globalDof++ );
          }
 
        private:
          Functor functor_;
        };
 
      public:
        DofMapper ( BlockMapperType &blockMapper )
          : blockMapper_( blockMapper )
        {}
 
        SizeType size () const { return blockSize * blockMapper_.size(); }
 
        bool contains ( const int codim ) const { return blockMapper_.contains( codim ); }
 
        bool fixedDataSize ( int codim ) const { return blockMapper_.fixedDataSize( codim ); }
 
        template< class Functor >
        void mapEach ( const ElementType &element, Functor f ) const
        {
          blockMapper_.mapEach( element, BlockFunctor< Functor >( std::forward< Functor >( f ) ) );
        }
 
        void map ( const ElementType &element, std::vector< GlobalKeyType > &indices ) const
        {
          indices.resize( numDofs( element ) );
          mapEach( element, [ &indices ] ( int local, GlobalKeyType global ) { indices[ local ] = global; } );
        }
 
        [[deprecated("Use onSubEntity method with char vector instead")]]
        void onSubEntity ( const ElementType &element, int i, int c, std::vector< bool > &indices ) const
        {
          std::vector< char > _idx;
          onSubEntity(element, i, c, _idx);
          indices.resize( _idx.size() );
          for (std::size_t i=0; i<_idx.size();++i)
            _idx[i] = indices[i] > 0;
        }
        // this method returns which local dofs are attached to the given subentity.
        // indices[locDofNr] =
        //  0 : not attached, not equal to 0 : attached
        // (so this method can still be used in the way the deprecated method was).
        // New: In case the dof can be associated to a component of the
        //      space, the value returned is that component+1. In other
        //      cases (normal velocity for RT for example) the value is 1).
        // So indices[i] is in [0,dimRange+1]
        void onSubEntity ( const ElementType &element, int i, int c, std::vector< char > &indices ) const
        {
          const SizeType numDofs = blockMapper_.numDofs( element );
          blockMapper_.onSubEntity( element, i, c, indices );
          indices.resize( blockSize * numDofs );
          for( SizeType i = numDofs-1; i!=SizeType(-1) ; --i )
          {
            for( int j = 0; j < blockSize; ++j )
            {
              assert( i < indices.size() );
              assert( i*blockSize+j < indices.size() );
              indices[ i*blockSize + j ] = (indices[ i ]==0)? 0 : j+1;
            }
          }
        }
 
        template< class Entity, class Functor >
        void mapEachEntityDof ( const Entity &entity, Functor f ) const
        {
          blockMapper_.mapEachEntityDof( entity, BlockFunctor< Functor >( std::forward< Functor >( f ) ) );
        }
 
        template< class Entity >
        void mapEntityDofs ( const Entity &entity, std::vector< GlobalKeyType > &indices ) const
        {
          indices.resize( numEntityDofs( entity ) );
          mapEachEntityDof( entity, [ &indices ] ( int local, GlobalKeyType global ) { indices[ local ] = global; } );
        }
 
        int maxNumDofs () const { return blockSize * blockMapper_.maxNumDofs(); }
 
        SizeType numDofs ( const ElementType &element ) const { return blockSize * blockMapper_.numDofs( element ); }
 
        template< class Entity >
        SizeType numEntityDofs ( const Entity &entity ) const { return blockSize * blockMapper_.numEntityDofs( entity ); }
 
        static constexpr bool consecutive () noexcept { return false; }
 
        SizeType numBlocks () const
        {
          DUNE_THROW( NotImplemented, "Method numBlocks() called on non-adaptive block mapper" );
        }
 
        SizeType numberOfHoles ( int ) const
        {
          DUNE_THROW( NotImplemented, "Method numberOfHoles() called on non-adaptive block mapper" );
        }
 
        GlobalKeyType oldIndex ( int hole, int ) const
        {
          DUNE_THROW( NotImplemented, "Method oldIndex() called on non-adaptive block mapper" );
        }
 
        GlobalKeyType newIndex ( int hole, int ) const
        {
          DUNE_THROW( NotImplemented, "Method newIndex() called on non-adaptive block mapper" );
        }
 
        SizeType oldOffSet ( int ) const
        {
          DUNE_THROW( NotImplemented, "Method oldOffSet() called on non-adaptive block mapper" );
        }
 
        SizeType offSet ( int ) const
        {
          DUNE_THROW( NotImplemented, "Method offSet() called on non-adaptive block mapper" );
        }
 
        const BlockMapperType &blockMapper () const { return blockMapper_; }
 
        void update () { blockMapper_.update(); }
 
      private:
        BlockMapperType &blockMapper_;
      };
 
 
      // AdaptiveDofMapper
      // -----------------
 
      template< class T >
      class AdaptiveDofMapper
        : public DofMapper< T, Dune::Fem::AdaptiveDofMapper >
      {
        typedef DofMapper< T, Dune::Fem::AdaptiveDofMapper > BaseType;
 
        template< class >
        friend class AdaptiveDofMapper;
 
      public:
        typedef typename BaseType::Traits Traits;
 
        typedef typename Traits::BlockMapperType BlockMapperType;
 
        static const int blockSize = Traits::blockSize;
 
        using BaseType::blockMapper;
 
        typedef typename Traits::ElementType ElementType;
        typedef typename Traits::SizeType SizeType;
        typedef typename Traits::GlobalKeyType GlobalKeyType;
 
        AdaptiveDofMapper ( BlockMapperType &blockMapper )
          : BaseType( blockMapper )
        {}
 
        bool consecutive () const { return blockMapper().consecutive(); }
 
        SizeType numBlocks () const { return blockMapper().numBlocks(); }
 
        SizeType numberOfHoles ( const int block ) const { return blockSize * blockMapper().numberOfHoles( block ); }
 
        GlobalKeyType oldIndex ( const int hole, const int block ) const
        {
          const int i = hole % blockSize;
          const int blockHole = hole / blockSize;
          return blockMapper().oldIndex( blockHole, block ) * blockSize + i;
        }
 
        GlobalKeyType newIndex ( const int hole, const int block ) const
        {
          const int i = hole % blockSize;
          const int blockHole = hole / blockSize;
          return blockMapper().newIndex( blockHole, block ) * blockSize + i;
        }
 
        SizeType oldOffSet ( const int block ) const { return blockMapper().oldOffSet( block ) * blockSize; }
 
        SizeType offSet ( const int block ) const { return blockMapper().offSet( block ) * blockSize; }
      };
 
 
 
      // Implementation
      // --------------
 
      template< class BlockMapper, int blockSize, bool adaptive = Capabilities::isAdaptiveDofMapper< BlockMapper >::v >
      class Implementation
      {
        typedef __NonBlockMapper::Traits< BlockMapper, blockSize > Traits;
 
      public:
        typedef typename std::conditional< adaptive,
                                           AdaptiveDofMapper< Traits >,
                                           DofMapper< Traits > >::type Type;
      };
 
    } // namespace __NonBlockMapper
 
 
    // NonBlockMapper
    // --------------
 
    template< class BlockMapper, int blockSize >
    class NonBlockMapper
      : public __NonBlockMapper::template Implementation< BlockMapper, blockSize >::Type
    {
      typedef typename __NonBlockMapper::template Implementation< BlockMapper, blockSize >::Type BaseType;
 
    public:
 
      NonBlockMapper ( BlockMapper &blockMapper )
        : BaseType( blockMapper )
      {}
    };
 
 
    // NonBlockMapper for NonBlockMapper
    // ---------------------------------
 
    template< class BlockMapper, int innerBlockSize, int outerBlockSize >
    class NonBlockMapper< NonBlockMapper< BlockMapper, innerBlockSize >, outerBlockSize >
      : public NonBlockMapper< BlockMapper, innerBlockSize *outerBlockSize >
    {
      typedef NonBlockMapper< NonBlockMapper< BlockMapper, innerBlockSize >, outerBlockSize > ThisType;
      typedef NonBlockMapper< BlockMapper, innerBlockSize *outerBlockSize > BaseType;
 
    public:
      explicit NonBlockMapper ( const NonBlockMapper< BlockMapper, innerBlockSize > &blockMapper )
        : BaseType( blockMapper.blockMapper_ )
      {}
    };
 
 
    // Capabilities
    // ------------
 
    namespace Capabilities
    {
      template< class BlockMapper, int blockSize >
      struct isAdaptiveDofMapper< NonBlockMapper< BlockMapper, blockSize > >
      {
        static const bool v = isAdaptiveDofMapper< BlockMapper >::v;
      };
 
      template< class BlockMapper, int blockSize >
      struct isConsecutiveIndexSet< __NonBlockMapper::AdaptiveDofMapper< __NonBlockMapper::Traits< BlockMapper, blockSize > > >
      {
        static const bool v = isConsecutiveIndexSet< BlockMapper >::v;
      };
 
    } // namespace Capabilities
 
  } // namespace Fem
 
} // namespace Dune
 
#endif // #ifndef DUNE_FEM_NONBLOCKMAPPER_HH