python/dirichletvalues/dirichletvalues.hh

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2021-2024 The Ikarus Developers mueller@ibb.uni-stuttgart.de
// SPDX-License-Identifier: LGPL-3.0-or-later
 
#pragma once
 
#include <cstdlib>
#include <string>
 
#include "dune/common/classname.hh"
#include <dune/functions/functionspacebases/lagrangebasis.hh>
#include <dune/functions/functionspacebases/powerbasis.hh>
#include <dune/grid/yaspgrid.hh>
#include <dune/python/common/typeregistry.hh>
#include <dune/python/functions/globalbasis.hh>
#include <dune/python/functions/subspacebasis.hh>
#include <dune/python/pybind11/eigen.h>
#include <dune/python/pybind11/functional.h>
#include <dune/python/pybind11/pybind11.h>
#include <dune/python/pybind11/stl.h>
#include <dune/python/pybind11/stl_bind.h>
 
#include <ikarus/finiteelements/ferequirements.hh>
 
namespace Ikarus::Python {
 
namespace Impl {
  using FixBoundaryDOFsWithGlobalIndexFunction = std::function<void(Eigen::Ref<Eigen::VectorX<bool>>, int)>;
 
  template <typename LV>
  using FixBoundaryDOFsWithLocalViewFunction = std::function<void(Eigen::Ref<Eigen::VectorX<bool>>, int, LV&)>;
 
  template <typename LV, typename IS>
  using FixBoundaryDOFsWithIntersectionFunction =
      std::function<void(Eigen::Ref<Eigen::VectorX<bool>>, int, LV&, const IS&)>;
 
  template <typename Basis>
  auto registerSubSpaceLocalView() {
    pybind11::module scopedf = pybind11::module::import("dune.functions");
    using LocalViewWrapper   = Dune::Python::LocalViewWrapper<Basis>;
 
    auto includes = Dune::Python::IncludeFiles{"dune/python/functions/globalbasis.hh"};
 
    Dune::Python::insertClass<Basis>(scopedf, "SubspaceBasis_" + Dune::className<typename Basis::PrefixPath>(),
                                     Dune::Python::GenerateTypeName(Dune::className<Basis>()), includes);
 
    auto [lv, isNew] = Dune::Python::insertClass<LocalViewWrapper>(
        scopedf, "LocalView_" + Dune::className<typename Basis::PrefixPath>(),
        Dune::Python::GenerateTypeName("Dune::Python::LocalViewWrapper", Dune::MetaType<Basis>()), includes);
    if (isNew) {
      lv.def("bind", &LocalViewWrapper::bind);
      lv.def("unbind", &LocalViewWrapper::unbind);
      lv.def("index", [](const LocalViewWrapper& localView, int index) { return localView.index(index); });
      lv.def("__len__", [](LocalViewWrapper& self) -> int { return self.size(); });
 
      Dune::Python::Functions::registerTree<typename LocalViewWrapper::Tree>(lv);
      lv.def("tree", [](const LocalViewWrapper& view) { return view.tree(); });
    }
  }
} // namespace Impl
 
template <class DirichletValues>
void forwardCorrectFunction(DirichletValues& dirichletValues, const pybind11::function& functor, auto&& cppFunction) {
  using Basis        = typename DirichletValues::Basis;
  using Intersection = typename Basis::GridView::Intersection;
  using BackendType  = typename DirichletValues::BackendType;
  using MultiIndex   = typename Basis::MultiIndex;
 
  // Disambiguate by number of arguments
  pybind11::module inspect_module = pybind11::module::import("inspect");
  pybind11::object result         = inspect_module.attr("signature")(functor).attr("parameters");
  size_t numParams                = pybind11::len(result);
 
  if (numParams == 2) {
    auto function = functor.template cast<const Impl::FixBoundaryDOFsWithGlobalIndexFunction>();
    auto lambda   = [&](BackendType& vec, const MultiIndex& indexGlobal) { function(vec.vector(), indexGlobal); };
    cppFunction(lambda);
 
  } else if (numParams == 3) {
    auto lambda = [&](BackendType& vec, int localIndex, auto&& lv) {
      using SubSpaceBasis = typename std::remove_cvref_t<decltype(lv)>::GlobalBasis;
      Impl::registerSubSpaceLocalView<SubSpaceBasis>();
 
      using SubSpaceLocalViewWrapper = Dune::Python::LocalViewWrapper<SubSpaceBasis>;
      auto lvWrapper                 = SubSpaceLocalViewWrapper(lv);
 
      auto function =
          functor.template cast<const Impl::FixBoundaryDOFsWithLocalViewFunction<SubSpaceLocalViewWrapper>>();
      function(vec.vector(), localIndex, lvWrapper);
    };
    cppFunction(lambda);
 
  } else if (numParams == 4) {
    auto lambda = [&](BackendType& vec, int localIndex, auto&& lv, const Intersection& intersection) {
      using SubSpaceBasis = typename std::remove_cvref_t<decltype(lv)>::GlobalBasis;
      Impl::registerSubSpaceLocalView<SubSpaceBasis>();
 
      using SubSpaceLocalViewWrapper = Dune::Python::LocalViewWrapper<SubSpaceBasis>;
      auto lvWrapper                 = SubSpaceLocalViewWrapper(lv);
 
      auto function = functor.template cast<
          const Impl::FixBoundaryDOFsWithIntersectionFunction<SubSpaceLocalViewWrapper, Intersection>>();
      function(vec.vector(), localIndex, lvWrapper, intersection);
    };
    cppFunction(lambda);
 
  } else {
    DUNE_THROW(Dune::NotImplemented, "fixBoundaryDOFs: A function with this signature is not supported");
  }
}
 
template <class DirichletValues, class... options>
void registerDirichletValues(pybind11::handle scope, pybind11::class_<DirichletValues, options...> cls) {
  using pybind11::operator""_a;
 
  using Basis        = typename DirichletValues::Basis;
  using BackendType  = typename DirichletValues::BackendType;
  using FlagsType    = typename DirichletValues::FlagsType;
  using MultiIndex   = typename Basis::MultiIndex;
  using LocalView    = typename Basis::LocalView;
  using Intersection = typename Basis::GridView::Intersection;
 
  pybind11::module scopedf = pybind11::module::import("dune.functions");
  using LocalViewWrapper   = Dune::Python::LocalViewWrapper<Basis>;
 
  auto includes    = Dune::Python::IncludeFiles{"dune/python/functions/globalbasis.hh"};
  auto [lv, isNew] = Dune::Python::insertClass<LocalViewWrapper>(
      scopedf, "LocalView", Dune::Python::GenerateTypeName("Dune::Python::LocalViewWrapper", Dune::MetaType<Basis>()),
      includes);
 
  if (isNew) {
    lv.def("bind", &LocalViewWrapper::bind);
    lv.def("unbind", &LocalViewWrapper::unbind);
    lv.def("index", [](const LocalViewWrapper& localView, int index) { return localView.index(index); });
    lv.def("__len__", [](LocalViewWrapper& self) -> int { return self.size(); });
 
    Dune::Python::Functions::registerTree<typename LocalViewWrapper::Tree>(lv);
    lv.def("tree", [](const LocalViewWrapper& view) { return view.tree(); });
  }
 
  cls.def(pybind11::init([](const Basis& basis) { return new DirichletValues(basis); }), pybind11::keep_alive<1, 2>());
 
  cls.def_property_readonly("container", &DirichletValues::container);
  cls.def_property_readonly("size", &DirichletValues::size);
  cls.def("__len__", &DirichletValues::size);
  cls.def_property_readonly("fixedDOFsize", &DirichletValues::fixedDOFsize);
  cls.def("isConstrained", [](DirichletValues& self, std::size_t i) -> bool { return self.isConstrained(i); });
  cls.def("setSingleDOF", [](DirichletValues& self, std::size_t i, bool flag) { self.setSingleDOF(i, flag); });
  cls.def("isConstrained", [](DirichletValues& self, MultiIndex i) -> bool { return self.isConstrained(i); });
  cls.def("setSingleDOF", [](DirichletValues& self, MultiIndex i, bool flag) { self.setSingleDOF(i, flag); });
  cls.def("reset", &DirichletValues::reset);
 
  cls.def("fixDOFs",
          [](DirichletValues& self, const std::function<void(const Basis&, Eigen::Ref<Eigen::VectorX<bool>>)>& f) {
            auto lambda = [&](const Basis& basis, BackendType& vec) { f(basis, vec.vector()); };
            self.fixDOFs(lambda);
          });
}
 
} // namespace Ikarus::Python