blockvectorfunction/blockvectorfunction.hh

Go to the documentation of this file.

#ifndef DUNE_FEM_BLOCKVECTORFUNCTION_HH
#define DUNE_FEM_BLOCKVECTORFUNCTION_HH
 
#include <memory>
#include <string>
#include <utility>
 
#include <dune/fem/common/stackallocator.hh>
#include <dune/fem/function/common/discretefunction.hh>
#include <dune/fem/function/localfunction/mutable.hh>
#include <dune/fem/function/blockvectorfunction/declaration.hh>
#include <dune/fem/function/blockvectors/defaultblockvectors.hh>
#include <dune/fem/space/common/dofmanager.hh>
 
namespace Dune
{
  namespace Fem
  {
    template< class DiscreteFunctionSpace,
              class Block >
    struct DiscreteFunctionTraits< ISTLBlockVectorDiscreteFunction< DiscreteFunctionSpace, Block > >
      : public DefaultDiscreteFunctionTraits< DiscreteFunctionSpace, ISTLBlockVector< Block > >
    {
      typedef ISTLBlockVectorDiscreteFunction< DiscreteFunctionSpace, Block >  DiscreteFunctionType;
      typedef MutableLocalFunction< DiscreteFunctionType > LocalFunctionType;
    };
 
 
 
    template < class DiscreteFunctionSpace, class Block >
    class ISTLBlockVectorDiscreteFunction
    : public DiscreteFunctionDefault< ISTLBlockVectorDiscreteFunction< DiscreteFunctionSpace, Block > >
    {
      typedef ISTLBlockVectorDiscreteFunction< DiscreteFunctionSpace, Block > ThisType;
      typedef DiscreteFunctionDefault< ThisType > BaseType;
 
    public:
      typedef typename BaseType :: DiscreteFunctionSpaceType  DiscreteFunctionSpaceType;
      typedef typename BaseType :: GridType                   GridType;
      typedef typename BaseType :: DofVectorType              DofVectorType;
      typedef typename BaseType :: DofType                    DofType;
      typedef typename DofVectorType :: DofContainerType      DofContainerType;
      typedef DofContainerType                                DofStorageType;
 
      typedef typename BaseType :: ScalarProductType          ScalarProductType;
 
      using BaseType::assign;
      using BaseType::name;
 
      ISTLBlockVectorDiscreteFunction( const std::string& name,
                                       const DiscreteFunctionSpaceType& space )
        : BaseType( name, space ),
          memObject_(),
          dofVector_( allocateDofStorage( space ) )
      {}
 
      ISTLBlockVectorDiscreteFunction( const std::string& name,
                                       const DiscreteFunctionSpaceType& space,
                                       const DofContainerType& dofVector )
        : BaseType( name, space ),
          memObject_(),
          dofVector_( allocateDofStorage( space, const_cast< DofContainerType* > (&dofVector) ) )
      {}
 
      ISTLBlockVectorDiscreteFunction( const ThisType& other )
        : BaseType( "copy of " + other.name(), other.space() ),
          memObject_(),
          dofVector_( allocateDofStorage( other.space() ) )
      {
        assign( other );
      }
 
      ISTLBlockVectorDiscreteFunction( ThisType&& other )
        : BaseType( static_cast< BaseType && >( other ) ),
          memObject_( std::move( other.memObject_ ) ),
          dofVector_( memObject_->getArray() )
      {}
 
      ISTLBlockVectorDiscreteFunction () = delete;
      ThisType& operator= ( const ThisType& ) = delete;
      ThisType& operator= ( ThisType&& ) = delete;
 
      void enableDofCompression ()
      {
        if( memObject_ )
          memObject_->enableDofCompression();
      }
 
#if HAVE_PETSC
      void assign( const PetscDiscreteFunction< DiscreteFunctionSpaceType >& g )
      {
        g.dofVector().copyTo( dofVector() );
      }
#endif
 
      DofContainerType& blockVector() { return dofVector().array(); }
 
      const DofContainerType& blockVector() const { return dofVector().array(); }
 
      DofVectorType& dofVector() { return dofVector_; }
 
      const DofVectorType& dofVector() const { return dofVector_; }
 
      ScalarProductType& scalarProduct() { return scalarProduct_ ; }
 
    protected:
      using BaseType :: scalarProduct_;
 
      typedef typename DiscreteFunctionSpaceType :: BlockMapperType BlockMapperType;
 
      class ISTLDofStorage :
        public ManagedDofStorageImplementation< GridType,
                                                BlockMapperType,
                                                DofVectorType >
      {
        typedef ManagedDofStorageImplementation< GridType, BlockMapperType, DofVectorType >  BaseType;
      protected:
        // pointer to data if created here
        std::unique_ptr< DofContainerType > myDofContainer_;
        // array wrapper class
        DofVectorType myArray_;
 
        DofContainerType* createData( const size_t size, DofContainerType* otherData )
        {
          if( otherData )
          {
            // user data provided from outside
            return otherData ;
          }
          else
          {
            // create new data vector
            myDofContainer_.reset( new DofContainerType( size ) );
            return myDofContainer_.operator->();
          }
        }
      public:
        ISTLDofStorage( const GridType& grid,
                        const BlockMapperType& mapper,
                        DofContainerType* otherData = nullptr )
          : BaseType( grid, mapper, myArray_ ),
            myArray_( createData( mapper.size(), otherData ) )
        {
        }
      };
 
 
      // allocate managed dof storage
      DofVectorType& allocateDofStorage ( const DiscreteFunctionSpaceType &space, DofContainerType* otherData = nullptr )
      {
        memObject_.reset( new ISTLDofStorage( space.gridPart().grid(), space.blockMapper(), otherData ) );
        return memObject_->getArray();
      }
 
      // pointer to allocated DofVector
      std::unique_ptr< ISTLDofStorage > memObject_;
 
      // DofVector object holds pointer to dof container
      DofVectorType& dofVector_;
    };
 
  } // namespace Fem
} // namespace Dune
 
#endif // #ifndef DUNE_FEM_BLOCKVECTORFUNCTION_HH