mol_statespacetimehandler.h

Go to the documentation of this file.

#ifndef MOL_STATESPACE_TIME_HANDLER_H_
#define MOL_STATESPACE_TIME_HANDLER_H_

#include "statespacetimehandler.h"
#include "constraints.h"
#include "sparsitymaker.h"
#include "userdefineddofconstraints.h"
#include "sth_internals.h"
#include "refinementcontainer.h"

#include <deal.II/dofs/dof_handler.h>
#include <deal.II/dofs/dof_renumbering.h>
#include <deal.II/dofs/dof_tools.h>
#include <deal.II/lac/constraint_matrix.h>
#include <deal.II/numerics/solution_transfer.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 dealdim>
    class MethodOfLines_StateSpaceTimeHandler : public StateSpaceTimeHandler<FE,
        DH, SPARSITYPATTERN, VECTOR, dealdim>
    {
      public:
        MethodOfLines_StateSpaceTimeHandler(
            dealii::Triangulation<dealdim>& triangulation, const FE<dealdim, dealdim>& state_fe,
            bool flux_pattern = false,
            const ActiveFEIndexSetterInterface<dealdim>& index_setter =
                ActiveFEIndexSetterInterface<dealdim>())
            : StateSpaceTimeHandler<FE, DH, SPARSITYPATTERN, VECTOR,
                dealdim>(index_setter), sparse_mkr_dynamic_(true), triangulation_(
                triangulation), state_dof_handler_(triangulation_), state_fe_(
                &state_fe), mapping_(
                &DOpEWrapper::StaticMappingQ1<dealdim, DH>::mapping_q1), state_mesh_transfer_(
                NULL)
        {
          sparsitymaker_ = new SparsityMaker<DH, dealdim>(flux_pattern);
          user_defined_dof_constr_ = NULL;
        }
        MethodOfLines_StateSpaceTimeHandler(
            dealii::Triangulation<dealdim>& triangulation, const FE<dealdim, dealdim>& state_fe,
            dealii::Triangulation<1> & times,
            bool flux_pattern = false,
            const ActiveFEIndexSetterInterface<dealdim>& index_setter =
                ActiveFEIndexSetterInterface<dealdim>())
            : StateSpaceTimeHandler<FE, DH, SPARSITYPATTERN, VECTOR,
                dealdim>(times, index_setter), sparse_mkr_dynamic_(true), triangulation_(
                triangulation), state_dof_handler_(triangulation_), state_fe_(
                &state_fe), mapping_(
                &DOpEWrapper::StaticMappingQ1<dealdim, DH>::mapping_q1), state_mesh_transfer_(
                NULL)
        {
          sparsitymaker_ = new SparsityMaker<DH, dealdim>(flux_pattern);
          user_defined_dof_constr_ = NULL;
        }

        MethodOfLines_StateSpaceTimeHandler(
            dealii::Triangulation<dealdim>& triangulation,
            const DOpEWrapper::Mapping<dealdim, DH>& mapping,
            const FE<dealdim, dealdim>& state_fe,
            bool flux_pattern = false,
            const ActiveFEIndexSetterInterface<dealdim>& index_setter =
                ActiveFEIndexSetterInterface<dealdim>())
            : StateSpaceTimeHandler<FE, DH, SPARSITYPATTERN, VECTOR,
                dealdim>(index_setter), sparse_mkr_dynamic_(true), triangulation_(
                triangulation), state_dof_handler_(triangulation_), state_fe_(
                &state_fe), mapping_(&mapping), state_mesh_transfer_(NULL)
        {
          sparsitymaker_ = new SparsityMaker<DH, dealdim>(flux_pattern);
          user_defined_dof_constr_ = NULL;
        }
        MethodOfLines_StateSpaceTimeHandler(
            dealii::Triangulation<dealdim>& triangulation,
            const DOpEWrapper::Mapping<dealdim, DH>& mapping,
            const FE<dealdim, dealdim>& state_fe, 
            dealii::Triangulation<1> & times,
            bool flux_pattern = false,
            const ActiveFEIndexSetterInterface<dealdim>& index_setter =
                ActiveFEIndexSetterInterface<dealdim>())
            : StateSpaceTimeHandler<FE, DH, SPARSITYPATTERN, VECTOR,
                dealdim>(times, index_setter), sparse_mkr_dynamic_(true), triangulation_(
                triangulation), state_dof_handler_(triangulation_), state_fe_(
                &state_fe), mapping_(&mapping), state_mesh_transfer_(NULL)
        {
          sparsitymaker_ = new SparsityMaker<DH, dealdim>(flux_pattern);
          user_defined_dof_constr_ = NULL;
        }

        virtual
        ~MethodOfLines_StateSpaceTimeHandler()
        {
          state_dof_handler_.clear();

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

        void
        ReInit(unsigned int state_n_blocks,
            const std::vector<unsigned int>& state_block_component)
        {

          StateSpaceTimeHandler<FE, DH, SPARSITYPATTERN, VECTOR, dealdim>::SetActiveFEIndicesState(
              state_dof_handler_);
          state_dof_handler_.distribute_dofs(GetFESystem("state"));
//          DoFRenumbering::Cuthill_McKee(
//              static_cast<DH<dealdim, dealdim>&>(state_dof_handler_));
          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();

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

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

        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
        GetStateDoFsPerBlock(unsigned int b, int /*time_point*/= -1) const
        {
          return state_dofs_per_block_[b];
        }

        const std::vector<unsigned int>&
        GetStateDoFsPerBlock(int /*time_point*/= -1) const
        {
          return state_dofs_per_block_;
        }

        const dealii::ConstraintMatrix&
        GetStateDoFConstraints() const
        {
          return state_dof_constraints_;
        }

        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
        GetStateNDoFs(int /*time_point*/= -1) const
        {
          return GetStateDoFHandler().n_dofs();
        }

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

        /******************************************************/
        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
          {
            abort();
            throw DOpEException("Not implemented for name =" + name,
                "MethodOfLines_StateSpaceTimeHandler::GetFESystem");
          }

        }

        /******************************************************/
        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 (state_mesh_transfer_ != NULL)
          {
            delete state_mesh_transfer_;
            state_mesh_transfer_ = NULL;
          }
          state_mesh_transfer_ = new dealii::SolutionTransfer<dealdim, VECTOR, DH<dealdim, dealdim> >(
              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 =" + DOpEtypesToString(ref_type),
                "MethodOfLines_StateSpaceTimeHandler::RefineStateSpace");
          }
          triangulation_.prepare_coarsening_and_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
        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, dealdim>& user_defined_dof_constr)
        {
          user_defined_dof_constr_ = &user_defined_dof_constr;
          user_defined_dof_constr_->RegisterMapping(this->GetMapping());
        }
        /******************************************************/
        void
        SetSparsityMaker(SparsityMaker<DH, dealdim>& sparsity_maker)
        {
          assert(sparse_mkr_dynamic_==true); //If not true, we already set the sparsity maker
          if (sparsitymaker_ != NULL && sparse_mkr_dynamic_)
            delete sparsitymaker_;
          sparsitymaker_ = &sparsity_maker;
          sparse_mkr_dynamic_ = false;
        }

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

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

        std::vector<unsigned int> state_dofs_per_block_;

        dealii::ConstraintMatrix state_dof_constraints_;

        const dealii::SmartPointer<const FE<dealdim, dealdim> > state_fe_; //TODO is there a reason that this is not a reference?
        const dealii::SmartPointer<
            const DOpEWrapper::Mapping<dealdim, DH> > mapping_;

        std::vector<Point<dealdim> > support_points_;
        dealii::SolutionTransfer<dealdim, VECTOR, DH<dealdim, dealdim> >* state_mesh_transfer_;

    };

}
#endif