File: tree.hh

package info (click to toggle)
dune-functions 2.11.0%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,988 kB
  • sloc: cpp: 18,456; python: 653; makefile: 3
file content (178 lines) | stat: -rw-r--r-- 6,241 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
// SPDX-FileCopyrightText: Copyright © DUNE Project contributors, see file AUTHORS.md
// SPDX-License-Identifier: LicenseRef-GPL-2.0-only-with-DUNE-exception OR LGPL-3.0-or-later

#ifndef DUNE_PYTHON_FUNCTIONS_TREE_HH
#define DUNE_PYTHON_FUNCTIONS_TREE_HH

#include <sstream>
#include <tuple>
#include <type_traits>
#include <utility>
#include <memory>

// for void_t, in <type_traits> for C++17
#include <dune/common/typetraits.hh>
#include <dune/common/visibility.hh>

#include <dune/common/typetree/childaccess.hh>
#include <dune/common/typetree/nodeconcepts.hh>

#include <dune/python/pybind11/pybind11.h>
#include <dune/python/pybind11/extensions.h>
#include <dune/python/localfunctions/localfiniteelement.hh>

namespace Dune {
namespace Python {
namespace Functions {

namespace detail {

template<typename Tree>
requires Dune::TypeTree::Concept::StaticDegreeInnerTreeNode<Tree>
         and (not Dune::TypeTree::Concept::UniformInnerTreeNode<Tree>)
void registerTree_(pybind11::handle scope, const char* name = "Tree");

template<typename Tree>
requires Dune::TypeTree::Concept::LeafTreeNode<Tree>
void registerTree_(pybind11::handle scope, const char* name = "Tree");

template<typename Tree>
requires Dune::TypeTree::Concept::UniformInnerTreeNode<Tree>
void registerTree_(pybind11::handle scope, const char* name = "Tree");

template<typename Tree>
void registerTreeCommon(pybind11::class_<Tree, std::shared_ptr<Tree>>& cls)
{
    using namespace Dune::TypeTree::Concept;
  /* dune-typetree properties */
  cls.def_property_readonly_static("isComposite", [](pybind11::object) {
    return StaticDegreeInnerTreeNode<Tree> and (not UniformInnerTreeNode<Tree>);
  });
  cls.def_property_readonly_static("isLeaf", [](pybind11::object) { return LeafTreeNode<Tree>; });
  cls.def_property_readonly_static("isPower", [](pybind11::object) { return UniformInnerTreeNode<Tree>; });
  cls.def("degree", [](pybind11::object) -> std::size_t { return Tree::degree(); });
  cls.def( "__len__", [] (const Tree& self) -> int { return self.size(); } );
  cls.def( "size", [] (const Tree& self) -> int { return self.size(); } );
  cls.def("localIndex", [](const Tree& self, unsigned int index) { return self.localIndex(index); });
  cls.def("treeIndex", [](const Tree& self, unsigned int index) { return self.treeIndex(); });
}

template<typename Tree, std::size_t i>
auto childAccessor()
{
  return [](Tree& tree) {
    return pybind11::cast(tree.template child(index_constant<i>{}));
  };
}

template<typename Tree, std::size_t... I>
std::array< std::function<pybind11::object(Tree& tree)>, sizeof...(I) >
childAccessors(std::index_sequence<I...>)
{
  static_assert(sizeof...(I) == Tree::degree(),"size of index sequence does not match degree of tree");
  return { (childAccessor<Tree, I>())... };
}

template<typename Tree>
void registerTreeChildAccessor(pybind11::class_<Tree, std::shared_ptr<Tree>>& cls)
{
  const auto accessors = childAccessors<Tree>(std::make_index_sequence<Tree::degree()>{});
  cls.def(
    "child",
    [accessors](Tree& tree, std::size_t i) { return accessors.at(i)(tree); },
    pybind11::arg("i"));
}

template<typename Tree>
requires Dune::TypeTree::Concept::StaticDegreeInnerTreeNode<Tree>
         and (not Dune::TypeTree::Concept::UniformInnerTreeNode<Tree>)
void registerTree_(pybind11::handle scope, const char* name)
{
  if( !pybind11::already_registered< Tree >() )
  {
    pybind11::class_<Tree, std::shared_ptr<Tree>> cls(scope, name);
    registerTreeCommon(cls);

    // static variable cls is captured automatically - explicit capture fails with clang:
    //    fatal error: 'cls' cannot be captured because it does not have automatic storage duration
    Hybrid::forEach(std::make_index_sequence<Tree::degree()>{}, [&cls](auto i) {
        using SubTree = Dune::TypeTree::Child<Tree, i>;
        std::string subName = std::string("Tree") + std::to_string(i);
        if( !pybind11::already_registered< SubTree >() )
          registerTree_<SubTree>(cls, subName.c_str());
      });
    registerTreeChildAccessor(cls);
  }
}

template<typename Tree, typename = void_t<>>
struct hasFiniteElement
  : std::false_type
{};

template<typename Tree>
struct hasFiniteElement<Tree, void_t<typename Tree::FiniteElement>>
  : std::true_type
{};

template< typename Tree, std::enable_if_t< !hasFiniteElement<Tree>::value, int > = 0>
void registerFiniteElementProperty(pybind11::class_< Tree, std::shared_ptr<Tree> >&)
{
  /* Nothing. */
}

template< typename Tree, std::enable_if_t< hasFiniteElement<Tree>::value, int > = 0>
void registerFiniteElementProperty(pybind11::class_< Tree, std::shared_ptr<Tree> >& cls)
{
  // this should probably be fixed in dune-localfunctions
  if (!pybind11::already_registered< typename Tree::FiniteElement >())
    registerLocalFiniteElement<typename Tree::FiniteElement>(cls);
  cls.def(
    "finiteElement",
    &Tree::finiteElement,
    pybind11::return_value_policy::reference_internal
    );
}

// fatal error: template parameter redefines default argument (clang)
// using static to avoid double registration doesn't work with clang
// because statics remain local to module and are not made unique between modules
// If the class is needed use the TypeRegistry to make this work smoothly
template<typename Tree>
requires Dune::TypeTree::Concept::LeafTreeNode<Tree>
void registerTree_(pybind11::handle scope, const char* name)
{
  if( !pybind11::already_registered< Tree >() )
  {
    pybind11::class_< Tree, std::shared_ptr<Tree> > cls(scope, name);
    registerTreeCommon(cls);
    registerFiniteElementProperty(cls);
  }
}

template<typename Tree>
requires Dune::TypeTree::Concept::UniformInnerTreeNode<Tree>
void registerTree_(pybind11::handle scope, const char* name)
{
  if( !pybind11::already_registered< Tree >() )
  {
    pybind11::class_< Tree, std::shared_ptr<Tree> > cls(scope, name);
    registerTreeCommon(cls);
    registerTree_<Dune::TypeTree::Child<Tree,0>>(cls);
    registerTreeChildAccessor(cls);
  }
}

} /* namespace detail */

template<typename Tree>
void registerTree(pybind11::handle scope, const char* name = "Tree")
{
  detail::registerTree_<Tree>(scope, name);
}

} /* namespace Functions */
} /* namespace Python */
} /* namespace Dune */

#endif