DirichletBC.hpp

#pragma once

#include <functional>
#include <list>
#include <type_traits>
#include <vector>

#include <dune/amdis/Output.hpp>
#include <dune/amdis/common/Concepts.hpp>
#include <dune/amdis/common/ValueCategory.hpp>
#include <dune/amdis/utility/RangeType.hpp>
#include <dune/amdis/utility/TreeData.hpp>

namespace AMDiS
{
  /// Implements a boundary condition of Dirichlet-type.
  /**
   * By calling the methods \ref init() and \ref finish before and after
   * assembling the system-matrix, respectively, dirichlet boundary conditions
   * can be applied to the matrix and system vector. Therefore, a predicate
   * functions indicates the DOFs where values should be enforced and a second
   * functor provided in the constructor is responsible for determining the
   * values to be set at the DOFs.
   *
   * In the \ref finish method the matrix is called with \ref applyDirichletBC
   * to erase the corresponding rows and columns for the DOF indices. This
   * application of boundary conditions can be symmetric if the matrix does
   * support this symmetric modification. As a result, this method returns a list
   * of columns values, that should be subtracted from the rhs.
   **/
  template <class Domain, class Range = double>
  class DirichletBC
  {
  public:
    template <class Predicate, class Values,
      REQUIRES(Concepts::Functor<Predicate, bool(Domain)> &&
				       Concepts::Functor<Values,  Range(Domain)>) >
    DirichletBC(Predicate&& predicate, Values&& values)
      : predicate_(std::forward<Predicate>(predicate))
      , values_(std::forward<Values>(values))
    {}


    /// Prepare the matrix, rhs and solution block for assembling dirichlet
    /// boundary conditions, e.g. collect the corresponding indices of boundary
    /// DOFS for later elimination in \ref finish.
    template <class Matrix, class VectorX, class VectorB, class RowBasis, class ColBasis>
    void init(Matrix& /*matrix*/, VectorX& /*rhs*/, VectorB& /*solution*/,
              RowBasis const& rowBasis,
              ColBasis const& /*colBasis*/)
    {
      using RowNode = typename RowBasis::LocalView::Tree;
      initImpl(rowBasis, typename RowNode::NodeTag{});
    }



    /// \brief Apply dirichlet BC to matrix and vector, i.e., add a unit-row
    /// to the matrix and optionally delete the corresponding matrix-column.
    /** If DBC is set for matrix block {R,C}, then \p apply_row means that
      * the block-row R is assembled, and \p apply_col means that the block-col C
      * is assembled. The \p matrix, \p rhs, and \p solution correspond to the
      * currently visited blocks of system-matrix and system-vector.
      **/
    template <class Matrix, class VectorX, class VectorB, class RowBasis, class ColBasis>
    void finish(Matrix& matrix,
                VectorX& rhs,
                VectorB& solution,
                RowBasis const& rowBasis,
                ColBasis const& colBasis)
    {
      finishImpl(matrix, rhs, solution, rowBasis, colBasis, ValueCategory_t<Range>{});
    }

  protected:
    template <class RowBasis>
    void initImpl(RowBasis const& rowBasis, Dune::TypeTree::LeafNodeTag);

    template <class RowBasis>
    void initImpl(RowBasis const& rowBasis, Dune::TypeTree::PowerNodeTag);

    template <class RB, class RowNodeTag>
    void initImpl(RB const&, RowNodeTag) {}

    template <class Matrix, class VectorX, class VectorB, class RowBasis, class ColBasis, class ValueCat>
    void finishImpl(Matrix& matrix, VectorX& rhs, VectorB& solution,
                    RowBasis const& rowBasis, ColBasis const& colBasis,
                    ValueCat);

    template <class Matrix, class VectorX, class VectorB, class RowBasis, class ColBasis>
    void finishImpl(Matrix& matrix, VectorX& rhs, VectorB& solution,
                    RowBasis const& rowBasis, ColBasis const& colBasis,
                    tag::unknown) {}

  private:
    std::function<bool(Domain)> predicate_;
    std::function<Range(Domain)> values_;

    bool initialized_ = false;
    std::vector<char> dirichletNodes_;
  };


  template <class GlobalBasis>
  struct DirichletData
  {
    using WorldVector = typename GlobalBasis::GridView::template Codim<0>::Geometry::GlobalCoordinate;

    template <class RowNode, class ColNode>
    using type = std::list< std::shared_ptr<DirichletBC<WorldVector, RangeType_t<RowNode>>> >;
  };

  template <class GlobalBasis>
  using Constraints = MatrixData<GlobalBasis, DirichletData<GlobalBasis>::template type>;

} // end namespace AMDiS

#include "DirichletBC.inc.hpp"