mol_spacetimehandler.h

Go to the documentation of this file.

#ifndef MOL_SPACE_TIME_HANDLER_H_
#define MOL_SPACE_TIME_HANDLER_H_

#include "spacetimehandler.h"
#include "constraints.h"
#include "sparsitymaker.h"
#include "userdefineddofconstraints.h"
#include "sth_internals.h"
#include "mapping_wrapper.h"
#include "refinementcontainer.h"
#include "solutiontransfer_wrapper.h"

#include <dofs/dof_handler.h>
#include <dofs/dof_renumbering.h>
#include <dofs/dof_tools.h>
#include <hp/mapping_collection.h>
#include <lac/constraint_matrix.h>
#include <deal.II/grid/grid_refinement.h>

namespace DOpE
{
  template<template <int, int> class FE, template<int, int> class DH, typename SPARSITYPATTERN,
      typename VECTOR, int dopedim, int dealdim>
    class MethodOfLines_SpaceTimeHandler : public SpaceTimeHandler<FE, DH,
        SPARSITYPATTERN, VECTOR, dopedim, dealdim>
    {
      public:
        MethodOfLines_SpaceTimeHandler(dealii::Triangulation<dealdim>& triangulation, 
                                       const FE<dealdim, dealdim>& control_fe,
                                       const FE<dealdim, dealdim>& state_fe, 
                                       DOpEtypes::ControlType type,
                                       const ActiveFEIndexSetterInterface<dopedim, dealdim>& index_setter =
                                       ActiveFEIndexSetterInterface<dopedim, dealdim>()) :
      SpaceTimeHandler<FE, DH, SPARSITYPATTERN, VECTOR, dopedim, dealdim>(type, index_setter), 
        triangulation_(triangulation), 
        control_dof_handler_(triangulation_), 
        state_dof_handler_(triangulation_), 
        control_fe_(&control_fe), 
        state_fe_(&state_fe), 
        mapping_(&DOpEWrapper::StaticMappingQ1<dealdim, DH>::mapping_q1), 
        constraints_(), 
        control_mesh_transfer_(NULL), 
        state_mesh_transfer_(NULL), 
        sparse_mkr_dynamic_(true)
        {
          sparsitymaker_ = new SparsityMaker<DH, dealdim>;
          user_defined_dof_constr_ = NULL;
        }

        MethodOfLines_SpaceTimeHandler(dealii::Triangulation<dealdim>& triangulation, 
                                       const FE<dealdim, dealdim>& control_fe,
                                       const FE<dealdim, dealdim>& state_fe, 
                                       dealii::Triangulation<1> & times,
                                       DOpEtypes::ControlType type,
                                       const ActiveFEIndexSetterInterface<dopedim, dealdim>& index_setter =
                                       ActiveFEIndexSetterInterface<dopedim, dealdim>()) :
      SpaceTimeHandler<FE, DH, SPARSITYPATTERN, VECTOR, dopedim, dealdim>(times, type, index_setter), 
        triangulation_(triangulation), 
        control_dof_handler_(triangulation_), 
        state_dof_handler_(triangulation_), 
        control_fe_(&control_fe), 
        state_fe_(&state_fe), 
        mapping_(&DOpEWrapper::StaticMappingQ1<dealdim, DH>::mapping_q1), 
        constraints_(), 
        control_mesh_transfer_(NULL), state_mesh_transfer_(NULL), sparse_mkr_dynamic_(true)
        {
          sparsitymaker_ = new SparsityMaker<DH, dealdim>;
          user_defined_dof_constr_ = NULL;
        }

         MethodOfLines_SpaceTimeHandler(dealii::Triangulation<dealdim>& triangulation, 
                                        const FE<dealdim, dealdim>& control_fe,
                                        const FE<dealdim, dealdim>& state_fe, 
                                        const Constraints& c,
                                        DOpEtypes::ControlType type,
                                        const ActiveFEIndexSetterInterface<dopedim, dealdim>& index_setter =
                                        ActiveFEIndexSetterInterface<dopedim, dealdim>()) :
      SpaceTimeHandler<FE, DH, SPARSITYPATTERN, VECTOR, dopedim, dealdim>(type, index_setter), 
        triangulation_(triangulation), 
        control_dof_handler_(triangulation_), 
        state_dof_handler_(triangulation_), 
        control_fe_(&control_fe), 
        state_fe_(&state_fe), 
        mapping_(&DOpEWrapper::StaticMappingQ1<dealdim, DH>::mapping_q1), 
        constraints_(c), 
        control_mesh_transfer_(NULL), state_mesh_transfer_(NULL), sparse_mkr_dynamic_(true)
        {
          sparsitymaker_ = new SparsityMaker<DH, dealdim>;
          user_defined_dof_constr_ = NULL;
        }

        MethodOfLines_SpaceTimeHandler(dealii::Triangulation<dealdim>& triangulation, 
                                       const FE<dealdim, dealdim>& control_fe,
                                       const FE<dealdim, dealdim>& state_fe, 
                                       dealii::Triangulation<1> & times,
                                       const Constraints& c, 
                                       DOpEtypes::ControlType type,
                                       const ActiveFEIndexSetterInterface<dopedim, dealdim>& index_setter =
                                       ActiveFEIndexSetterInterface<dopedim, dealdim>()) :
      SpaceTimeHandler<FE, DH, SPARSITYPATTERN, VECTOR, dopedim, dealdim>(times, type, index_setter), 
        triangulation_(triangulation), 
        control_dof_handler_(triangulation_), 
        state_dof_handler_(triangulation_), 
        control_fe_(&control_fe), 
        state_fe_(&state_fe), 
        mapping_(&DOpEWrapper::StaticMappingQ1<dealdim, DH>::mapping_q1), 
        constraints_(c), 
        control_mesh_transfer_(NULL), state_mesh_transfer_(NULL), sparse_mkr_dynamic_(true)
        {
          sparsitymaker_ = new SparsityMaker<DH, dealdim>;
          user_defined_dof_constr_ = NULL;
        }

        ~MethodOfLines_SpaceTimeHandler()
        {
          control_dof_handler_.clear();

          state_dof_handler_.clear();

          if (control_mesh_transfer_ != NULL)
          {
            delete control_mesh_transfer_;
          }
          if (state_mesh_transfer_ != NULL)
          {
            delete state_mesh_transfer_;
          }
          if (sparsitymaker_ != NULL && sparse_mkr_dynamic_ == true)
          {
            delete sparsitymaker_;
          }
        }

        void
        ReInit(unsigned int control_n_blocks,
            const std::vector<unsigned int>& control_block_component,
            unsigned int state_n_blocks,
            const std::vector<unsigned int>& state_block_component)
        {
#if dope_dimension > 0
          SpaceTimeHandler<FE, DH, SPARSITYPATTERN,
          VECTOR, dopedim, dealdim>::SetActiveFEIndicesControl(control_dof_handler_);
#endif
          control_dof_handler_.distribute_dofs(*control_fe_);

#if dope_dimension > 0
          DoFRenumbering::component_wise (static_cast<DH<dopedim, dopedim>&>(control_dof_handler_));
          if(dopedim==dealdim)
          {
            control_dof_constraints_.clear ();
            DoFTools::make_hanging_node_constraints (static_cast<DH<dopedim, dopedim>&>(control_dof_handler_),
                control_dof_constraints_);
            if (GetUserDefinedDoFConstraints() != NULL)
            GetUserDefinedDoFConstraints()->MakeControlDoFConstraints(control_dof_handler_,
                control_dof_constraints_);
            control_dof_constraints_.close ();
          }
          else
          {
            throw DOpEException("Not implemented for dopedim != dealdim","MethodOfLines_SpaceTimeHandler::ReInit");
          }
#endif
          control_dofs_per_block_.resize(control_n_blocks);
#if dope_dimension > 0
          {
            DoFTools::count_dofs_per_block (static_cast<DH<dopedim, dopedim>&>(control_dof_handler_),
                control_dofs_per_block_,control_block_component);
          }
#else
          {
            for (unsigned int i = 0; i < control_dofs_per_block_.size(); i++)
            {
              control_dofs_per_block_[i] = 0;
            }
            for (unsigned int i = 0; i < control_block_component.size(); i++)
            {
              control_dofs_per_block_[control_block_component[i]]++;
            }
          }
#endif
          SpaceTimeHandler<FE, DH, SPARSITYPATTERN, VECTOR, dopedim, dealdim>::SetActiveFEIndicesState(
              state_dof_handler_);
          state_dof_handler_.distribute_dofs(GetFESystem("state"));
          DoFRenumbering::component_wise(
              static_cast<DH<dealdim, dealdim>&>(state_dof_handler_));

          state_dof_constraints_.clear();
          DoFTools::make_hanging_node_constraints(
              static_cast<DH<dealdim, dealdim>&>(state_dof_handler_),
              state_dof_constraints_);
          //TODO Dirichlet ueber Constraints
          if (GetUserDefinedDoFConstraints() != NULL)
            GetUserDefinedDoFConstraints()->MakeStateDoFConstraints(
                state_dof_handler_, state_dof_constraints_);
          state_dof_constraints_.close();

          state_dofs_per_block_.resize(state_n_blocks);
          DoFTools::count_dofs_per_block(
              static_cast<DH<dealdim, dealdim>&>(state_dof_handler_),
              state_dofs_per_block_, state_block_component);

          support_points_.clear();

          constraints_.ReInit(control_dofs_per_block_);
          //constraints_.ReInit(control_dofs_per_block_, state_dofs_per_block_);

          //Initialize also the timediscretization.
          this->ReInitTime();

          //There where changes invalidate tickets
          this->IncrementControlTicket();
          this->IncrementStateTicket();
        }

        const DOpEWrapper::DoFHandler<dopedim, DH>&
        GetControlDoFHandler() const
        {
          //There is only one mesh, hence always return this
          return control_dof_handler_;
        }
        const DOpEWrapper::DoFHandler<dealdim, DH>&
        GetStateDoFHandler() const
        {
          //There is only one mesh, hence always return this
          return state_dof_handler_;
        }
        const DOpEWrapper::Mapping<dealdim, DH>&
        GetMapping() const
        {
          return *mapping_;
        }

        unsigned int
        GetControlDoFsPerBlock(unsigned int b, int /*time_point*/= -1) const
        {
          return control_dofs_per_block_[b];
        }
        unsigned int
        GetStateDoFsPerBlock(unsigned int b, int /*time_point*/= -1) const
        {
          return state_dofs_per_block_[b];
        }
        unsigned int
        GetConstraintDoFsPerBlock(std::string name, unsigned int b) const
        {
          return (constraints_.GetDoFsPerBlock(name))[b];
        }
        const std::vector<unsigned int>&
        GetControlDoFsPerBlock(int /*time_point*/= -1) const
        {
          return control_dofs_per_block_;
        }
        const std::vector<unsigned int>&
        GetStateDoFsPerBlock(int /*time_point*/= -1) const
        {
          return state_dofs_per_block_;
        }
        const std::vector<unsigned int>&
        GetConstraintDoFsPerBlock(std::string name) const
        {
          return constraints_.GetDoFsPerBlock(name);
        }
        const dealii::ConstraintMatrix&
        GetControlDoFConstraints() const
        {
          return control_dof_constraints_;
        }
        const dealii::ConstraintMatrix&
        GetStateDoFConstraints() const
        {
          return state_dof_constraints_;
        }

        virtual void
        InterpolateControl(VECTOR& result,
            const std::vector<VECTOR*> & local_vectors, double t,
            const TimeIterator& it) const
        {
          assert(it.get_left() <= t);
          assert(it.get_right() >= t);
          if (local_vectors.size() != 2)
          {
            throw DOpEException(
                "This function is currently not implemented for anything other than"
                    " linear interpolation of 2 DoFs.",
                "MethodOfLine_SpaceTimeHandler::InterpolateControl");
          }
          double lambda_l = (it.get_right() - t) / it.get_k();
          double lambda_r = (t - it.get_left()) / it.get_k();

          //Here we assume that the numbering of dofs goes from left to right!
          result = *local_vectors[0];

          result.sadd(lambda_l, lambda_r, *local_vectors[1]);
        }
        virtual void
        InterpolateState(VECTOR& result,
            const std::vector<VECTOR*> & local_vectors, double t,
            const TimeIterator& it) const
        {
          assert(it.get_left() <= t);
          assert(it.get_right() >= t);
          if (local_vectors.size() != 2)
          {
            throw DOpEException(
                "This function is currently not implemented for anything other than"
                    " linear interpolation of 2 DoFs.",
                "MethodOfLine_SpaceTimeHandler::InterpolateState");
          }
          double lambda_l = (it.get_right() - t) / it.get_k();
          double lambda_r = (t - it.get_left()) / it.get_k();

          //Here we assume that the numbering of dofs goes from left to right!
          result = *local_vectors[0];

          result.sadd(lambda_l, lambda_r, *local_vectors[1]);
        }

        unsigned int
        GetControlNDoFs(int /*time_point*/= -1) const
        {
          return GetControlDoFHandler().n_dofs();
        }
        unsigned int
        GetStateNDoFs(int /*time_point*/= -1) const
        {
          return GetStateDoFHandler().n_dofs();
        }
        unsigned int
        GetConstraintNDoFs(std::string name) const
        {
          return constraints_.n_dofs(name);
        }
        unsigned int
        GetNGlobalConstraints() const
        {
          return constraints_.n_dofs("global");
          //return constraints_.global_n_dofs();
        }
        unsigned int
        GetNLocalConstraints() const
        {
          //return constraints_.local_n_dofs();
          return constraints_.n_dofs("local");
        }

        const std::vector<Point<dealdim> >&
        GetMapDoFToSupportPoints()
        {
          support_points_.resize(GetStateNDoFs());
          DOpE::STHInternals::MapDoFsToSupportPoints(this->GetMapping(),
              GetStateDoFHandler(), support_points_);
          return support_points_;
        }

        /******************************************************/
        void
        ComputeControlSparsityPattern(SPARSITYPATTERN & sparsity) const;

        /******************************************************/
        void
        ComputeStateSparsityPattern(SPARSITYPATTERN & sparsity) const
        {
          this->GetSparsityMaker()->ComputeSparsityPattern(
              this->GetStateDoFHandler(), sparsity,
              this->GetStateDoFConstraints(), this->GetStateDoFsPerBlock());
        }

        /******************************************************/

        const FE<dealdim, dealdim>&
        GetFESystem(std::string name) const
        {
          if (name == "state")
          {
            return *state_fe_;
          }
          else if (name == "control")
          {
            return *control_fe_;
          }
          else
          {
            throw DOpEException("Not implemented for name =" + name,
                "MethodOfLines_SpaceTimeHandler::GetFESystem");
          }

        }

        /******************************************************/
        void
        RefineSpaceTime(DOpEtypes::RefinementType ref_type =
            DOpEtypes::RefinementType::global)
        {
          assert(ref_type == DOpEtypes::RefinementType::global);
          RefineSpace(ref_type);
          SpaceTimeHandlerBase<VECTOR>::RefineTime(ref_type);
        }

        /******************************************************/
        void
        RefineSpace(DOpEtypes::RefinementType ref_type =
            DOpEtypes::RefinementType::global)
        {
          assert(ref_type == DOpEtypes::RefinementType::global);
          RefinementContainer ref_con_dummy;
          RefineSpace(ref_con_dummy);
        }

        /******************************************************/
        void
        RefineSpace(const RefinementContainer& ref_container)
        {
          DOpEtypes::RefinementType ref_type = ref_container.GetRefType();

          //make sure that we do not use any coarsening
          assert(!ref_container.UsesCoarsening());

          if (control_mesh_transfer_ != NULL)
          {
            delete control_mesh_transfer_;
            control_mesh_transfer_ = NULL;
          }
          if (state_mesh_transfer_ != NULL)
          {
            delete state_mesh_transfer_;
            state_mesh_transfer_ = NULL;
          }
#if dope_dimension == deal_II_dimension
          control_mesh_transfer_ = new DOpEWrapper::SolutionTransfer<dopedim, VECTOR,
            DH>(control_dof_handler_);
#endif
          state_mesh_transfer_ = new DOpEWrapper::SolutionTransfer<dealdim, VECTOR,
            DH>(state_dof_handler_);
          if (DOpEtypes::RefinementType::global == ref_type)
          {
            triangulation_.set_all_refine_flags();
          }
          else if (DOpEtypes::RefinementType::fixed_number == ref_type)
          {
            GridRefinement::refine_and_coarsen_fixed_number(triangulation_,
                ref_container.GetLocalErrorIndicators(),
                ref_container.GetTopFraction(),
                ref_container.GetBottomFraction());
          }
          else if (DOpEtypes::RefinementType::fixed_fraction == ref_type)
          {
            GridRefinement::refine_and_coarsen_fixed_fraction(triangulation_,
                ref_container.GetLocalErrorIndicators(),
                ref_container.GetTopFraction(),
                ref_container.GetBottomFraction());
          }
          else if (DOpEtypes::RefinementType::optimized == ref_type)
          {
            GridRefinement::refine_and_coarsen_optimize(triangulation_,
                ref_container.GetLocalErrorIndicators(),
                ref_container.GetConvergenceOrder());
          }
          else
          {
            throw DOpEException("Not implemented for name =" + ref_type,
                "MethodOfLines_SpaceTimeHandler::RefineSpace");
          }
          triangulation_.prepare_coarsening_and_refinement();

          //FIXME: works only if no coarsening happens, because we do not have the vectors to be interpolated availiable...
          if (control_mesh_transfer_ != NULL)
            control_mesh_transfer_->prepare_for_pure_refinement();
          if (state_mesh_transfer_ != NULL)
            state_mesh_transfer_->prepare_for_pure_refinement();

          triangulation_.execute_coarsening_and_refinement();
        }
        
        /******************************************************/

        unsigned int
        NewTimePointToOldTimePoint(unsigned int t) const
        {
          //TODO this has to be implemented when temporal refinement is possible!
          //At present the temporal grid can't be refined
          return t;
        }

        /******************************************************/

        void
        SpatialMeshTransferControl(const VECTOR& old_values,
            VECTOR& new_values) const
        {
          if (control_mesh_transfer_ != NULL)
            control_mesh_transfer_->refine_interpolate(old_values, new_values);
        }
        void
        SpatialMeshTransferState(const VECTOR& old_values,
            VECTOR& new_values) const
        {
          if (state_mesh_transfer_ != NULL)
            state_mesh_transfer_->refine_interpolate(old_values, new_values);
        }
        /******************************************************/
        void
        SetUserDefinedDoFConstraints(
            UserDefinedDoFConstraints<DH, dopedim, dealdim>& constraints_maker)
        {
          user_defined_dof_constr_ = &constraints_maker;
          user_defined_dof_constr_->RegisterMapping(this->GetMapping());
        }
        /******************************************************/
        void
        SetSparsityMaker(SparsityMaker<DH, dealdim>& sparsity_maker)
        {
          if (sparsitymaker_ != NULL && sparse_mkr_dynamic_)
            delete sparsitymaker_;
          sparsitymaker_ = &sparsity_maker;
          sparse_mkr_dynamic_ = false;
        }

//        /******************************************************/
//        /**
//         * Through this function one can reinitialize the 
//         * triangulation for the state variable to be a copy of the
//         * given argument.
//         */
//
//        void
//        ResetTriangulation(const dealii::Triangulation<dealdim>& tria)
//        {
//          state_dof_handler_.clear();
//          triangulation_.clear();
//          triangulation_.copytriangulation_(tria);
//          state_dof_handler_.initialize(triangulation_, *state_fe_);
//          this->IncrementControlTicket();
//          this->IncrementStateTicket();
//          if (control_mesh_transfer_ != NULL)
//            delete control_mesh_transfer_;
//          control_mesh_transfer_ = NULL;
//          if (state_mesh_transfer_ != NULL)
//            delete state_mesh_transfer_;
//          state_mesh_transfer_ = NULL;
//
//        }

      private:
        const SparsityMaker<DH, dealdim>*
        GetSparsityMaker() const
        {
          return sparsitymaker_;
        }
        const UserDefinedDoFConstraints<DH, dopedim, dealdim>*
        GetUserDefinedDoFConstraints() const
        {
          return user_defined_dof_constr_;
        }
        SparsityMaker<DH, dealdim>* sparsitymaker_;
        UserDefinedDoFConstraints<DH, dopedim, dealdim>* user_defined_dof_constr_;

        dealii::Triangulation<dealdim>& triangulation_;
        DOpEWrapper::DoFHandler<dopedim, DH> control_dof_handler_;
        DOpEWrapper::DoFHandler<dealdim, DH> state_dof_handler_;

        std::vector<unsigned int> control_dofs_per_block_;
        std::vector<unsigned int> state_dofs_per_block_;

        dealii::ConstraintMatrix control_dof_constraints_;
        dealii::ConstraintMatrix state_dof_constraints_;

        const dealii::SmartPointer<const FE<dealdim, dealdim> > control_fe_;
        const dealii::SmartPointer<const FE<dealdim, dealdim> > state_fe_;

        const dealii::SmartPointer<const DOpEWrapper::Mapping<dealdim, DH> > mapping_;

        std::vector<Point<dealdim> > support_points_;

        Constraints constraints_;
        DOpEWrapper::SolutionTransfer<dealdim, VECTOR,DH>* control_mesh_transfer_;
        DOpEWrapper::SolutionTransfer<dealdim, VECTOR,DH>* state_mesh_transfer_;
        bool sparse_mkr_dynamic_;
    };

  /**************************explicit instantiation*************/

  template<>
    void
    DOpE::MethodOfLines_SpaceTimeHandler<dealii::FESystem,
        dealii::DoFHandler, dealii::BlockSparsityPattern,
        dealii::BlockVector<double>, dope_dimension, deal_II_dimension>::ComputeControlSparsityPattern(
          dealii::BlockSparsityPattern & sparsity) const;

  /******************************************************/

  template<>
    void
    MethodOfLines_SpaceTimeHandler<dealii::FESystem,
        dealii::DoFHandler, dealii::SparsityPattern,
        dealii::Vector<double>, dope_dimension, deal_II_dimension>::ComputeControlSparsityPattern(
          dealii::SparsityPattern & sparsity) const;


  template<>
    void
    DOpE::MethodOfLines_SpaceTimeHandler<
        dealii::hp::FECollection,
        dealii::hp::DoFHandler, dealii::BlockSparsityPattern,
        dealii::BlockVector<double>, dope_dimension, deal_II_dimension>::ComputeControlSparsityPattern(
          dealii::BlockSparsityPattern & sparsity) const;

  /******************************************************/

  template<>
    void
    MethodOfLines_SpaceTimeHandler<dealii::hp::FECollection,
        dealii::hp::DoFHandler, dealii::SparsityPattern,
        dealii::Vector<double>, dope_dimension, deal_II_dimension>::ComputeControlSparsityPattern(
          dealii::SparsityPattern & sparsity) const;

}

#endif