lagrangegridcreator.hh 14.9 KB
Newer Older
Praetorius, Simon's avatar
Praetorius, Simon committed
1
2
3
4
5
#pragma once

#include <cassert>
#include <cstdint>
#include <limits>
6
#include <optional>
Praetorius, Simon's avatar
Praetorius, Simon committed
7
8
9
10
11
#include <vector>

#include <dune/common/exceptions.hh>
#include <dune/common/hybridutilities.hh>
#include <dune/geometry/utility/typefromvertexcount.hh>
Stenger, Florian's avatar
Stenger, Florian committed
12
#include <dune/geometry/multilineargeometry.hh>
Praetorius, Simon's avatar
Praetorius, Simon committed
13
14
15
#include <dune/localfunctions/lagrange.hh>
#include <dune/grid/common/gridfactory.hh>

Stenger, Florian's avatar
Stenger, Florian committed
16
#include <dune/vtk/types.hh>
Praetorius, Simon's avatar
Praetorius, Simon committed
17
18
19
20
21
#include <dune/vtk/gridcreatorinterface.hh>
#include <dune/vtk/utility/lagrangepoints.hh>

namespace Dune
{
Stenger, Florian's avatar
Stenger, Florian committed
22
  namespace Vtk
Praetorius, Simon's avatar
Praetorius, Simon committed
23
  {
Stenger, Florian's avatar
Stenger, Florian committed
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
    // \brief Create a grid from data that represents higher (lagrange) cells.
    /**
    * The grid is created from the first nodes of a cell parametrization, representing
    * the  corner vertices. Thus a piecewise "flat" grid is constructed. The
    * parametrization is 1. passed as a local element parametrization to the
    * `insertElement()` function of a gridFactory to allow the grid itself to handle the
    * parametrization and 2. is stored internally that can be accessed by using this
    * GridCreator object as a grid function, or by extracting locally the parametrization
    * on each existing grid element after creation of the grid.
    *
    * So, the LagrangeGridCreator models both, a `GridCreator` and a `GridFunction`.
    **/
    template <class GridType>
    struct LagrangeGridCreator
        : public GridCreatorInterface<GridType, LagrangeGridCreator<GridType>>
Praetorius, Simon's avatar
Praetorius, Simon committed
39
    {
Stenger, Florian's avatar
Stenger, Florian committed
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
      using Self = LagrangeGridCreator;
      using Super = GridCreatorInterface<GridType, Self>;
      using GlobalCoordinate = typename Super::GlobalCoordinate;

      using Nodes = std::vector<GlobalCoordinate>;

      struct ElementParametrization
      {
        GeometryType type;                  //< Geometry type of the element
        std::vector<std::int64_t> nodes;    //< Indices of the w.r.t. `nodes_` vector
        std::vector<unsigned int> corners;  //< Insertion-indices of the element corner nodes
      };

      using Parametrization = std::vector<ElementParametrization>;
      using Element = typename GridType::template Codim<0>::Entity;
      using LocalCoordinate = typename Element::Geometry::LocalCoordinate;

      class LocalParametrization;
      class LocalFunction;

    public:
      using Super::factory;

      LagrangeGridCreator (GridFactory<GridType>& factory)
        : Super(factory)
      {}

      /// Implementation of the interface function `insertVertices()`
      void insertVerticesImpl (std::vector<GlobalCoordinate> const& points,
                              std::vector<std::uint64_t> const& /*point_ids*/)
      {
        // store point coordinates in member variable
        nodes_ = points;
      }
Praetorius, Simon's avatar
Praetorius, Simon committed
74

Stenger, Florian's avatar
Stenger, Florian committed
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
      template <class F>
      using HasParametrizedElements = decltype(std::declval<F>().insertElement(std::declval<GeometryType>(),
        std::declval<std::vector<unsigned int> const&>(), std::declval<std::function<GlobalCoordinate(LocalCoordinate)>>()));

      /// Implementation of the interface function `insertElements()`
      void insertElementsImpl (std::vector<std::uint8_t> const& types,
                              std::vector<std::int64_t> const& offsets,
                              std::vector<std::int64_t> const& connectivity)
      {
        assert(nodes_.size() > 0);

        // mapping of node index to element-vertex index
        std::vector<std::int64_t> elementVertices(nodes_.size(), -1);
        parametrization_.reserve(types.size());

        std::int64_t vertexIndex = 0;
        for (std::size_t i = 0; i < types.size(); ++i) {
          auto type = Vtk::to_geometry(types[i]);
          if (type.dim() != GridType::dimension)
            continue;

          Vtk::CellType cellType{type};
          auto refElem = referenceElement<double,GridType::dimension>(type);

          std::int64_t shift = (i == 0 ? 0 : offsets[i-1]);
          int nNodes = offsets[i] - shift;
          int nVertices = refElem.size(GridType::dimension);

          // insert vertices into grid and construct element vertices
          std::vector<unsigned int> element(nVertices);
          for (int j = 0; j < nVertices; ++j) {
            auto index = connectivity.at(shift + j);
            auto& vertex = elementVertices.at(index);
            if (vertex < 0) {
              factory().insertVertex(nodes_.at(index));
              vertex = vertexIndex++;
            }
            element[j] = vertex;
Praetorius, Simon's avatar
Praetorius, Simon committed
113
114
          }

Stenger, Florian's avatar
Stenger, Florian committed
115
116
117
118
          // permute element indices
          if (!cellType.noPermutation()) {
            // apply index permutation
            std::vector<unsigned int> cell(element.size());
119
            for (std::size_t j = 0; j < element.size(); ++j)
Stenger, Florian's avatar
Stenger, Florian committed
120
121
122
              cell[j] = element[cellType.permutation(j)];
            std::swap(element, cell);
          }
Praetorius, Simon's avatar
Praetorius, Simon committed
123

Stenger, Florian's avatar
Stenger, Florian committed
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
          // fill vector of element parametrizations
          parametrization_.push_back(ElementParametrization{type});
          auto& param = parametrization_.back();

          param.nodes.resize(nNodes);
          for (int j = 0; j < nNodes; ++j)
            param.nodes[j] = connectivity.at(shift + j);
          param.corners = element;

          // try to create element with parametrization
          if constexpr (Std::is_detected_v<HasParametrizedElements, GridFactory<GridType>>) {
            try {
              factory().insertElement(type, element,
                localParametrization(parametrization_.size()-1));
            } catch (Dune::GridError const& /* notImplemented */) {
              factory().insertElement(type, element);
            }
          } else {
Praetorius, Simon's avatar
Praetorius, Simon committed
142
143
144
145
146
            factory().insertElement(type, element);
          }
        }
      }

Stenger, Florian's avatar
Stenger, Florian committed
147
148
149
150
151
152
153
154
155
156
157
158
      /// \brief Construct an element parametrization
      /**
      * The returned LocalParametrization is a mapping `GlobalCoordinate(LocalCoordinate)`
      * where `LocalCoordinate is w.r.t. the local coordinate system in an element with
      * given `insertionIndex` (defined by the inserted corner vertices) and
      * `GlobalCoordinate` a world coordinate in the parametrized grid.
      **/
      LocalParametrization localParametrization (unsigned int insertionIndex) const
      {
        assert(!nodes_.empty() && !parametrization_.empty());
        auto const& localParam = parametrization_.at(insertionIndex);
        return LocalParametrization{nodes_, localParam, order(localParam)};
Praetorius, Simon's avatar
Praetorius, Simon committed
159
160
      }

Stenger, Florian's avatar
Stenger, Florian committed
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
      /// \brief Construct an element parametrization
      /**
      * The returned LocalParametrization is a mapping `GlobalCoordinate(LocalCoordinate)`
      * where `LocalCoordinate is w.r.t. the local coordinate system in the passed element
      * and `GlobalCoordinate` a world coordinate in the parametrized grid.
      *
      * Note, when an element is passed, it might have a different local coordinate system
      * than the coordinate system used to defined the element parametrization. Thus
      * coordinate transform is internally chained to the evaluation of the local
      * parametrization. This local geometry transform is obtained by figuring out the
      * permutation of corners in the element corresponding to the inserted corner
      * vertices.
      **/
      LocalParametrization localParametrization (Element const& element) const
      {
        assert(!nodes_.empty() && !parametrization_.empty());

        unsigned int insertionIndex = factory().insertionIndex(element);
        auto const& localParam = parametrization_.at(insertionIndex);
        assert(element.type() == localParam.type);

        // collect indices of vertices
        std::vector<unsigned int> indices(element.subEntities(GridType::dimension));
        for (unsigned int i = 0; i < element.subEntities(GridType::dimension); ++i)
          indices[i] = factory().insertionIndex(element.template subEntity<GridType::dimension>(i));

        // calculate permutation vector
        std::vector<unsigned int> permutation(indices.size());
        for (std::size_t i = 0; i < indices.size(); ++i) {
          auto it = std::find(localParam.corners.begin(), localParam.corners.end(), indices[i]);
          assert(it != localParam.corners.end());
          permutation[i] = std::distance(localParam.corners.begin(), it);
        }
Praetorius, Simon's avatar
Praetorius, Simon committed
194

Stenger, Florian's avatar
Stenger, Florian committed
195
196
        return LocalParametrization{nodes_, localParam, order(localParam), permutation};
      }
197

Stenger, Florian's avatar
Stenger, Florian committed
198
199
      /// Determine lagrange order from number of points
      template <class LocalParam>
200
      int order (LocalParam const& localParam) const
Stenger, Florian's avatar
Stenger, Florian committed
201
202
      {
        GeometryType type = localParam.type;
203
204
205
        int nNodes = localParam.nodes.size();
        for (int o = 1; o <= nNodes; ++o)
          if (numLagrangePoints(type.id(), type.dim(), o) == std::size_t(nNodes))
Stenger, Florian's avatar
Stenger, Florian committed
206
207
208
209
            return o;

        return 1;
      }
210

Stenger, Florian's avatar
Stenger, Florian committed
211
      /// Determine lagrange order from number of points from the first element parametrization
212
      int order () const
Stenger, Florian's avatar
Stenger, Florian committed
213
214
215
216
      {
        assert(!parametrization_.empty());
        return order(parametrization_.front());
      }
217

Stenger, Florian's avatar
Stenger, Florian committed
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
    public:
      /// \brief Local function representing the parametrization of the grid.
      /**
      * The returned object models Functions::Concept::LocalFunction
      * and can thus be bound to an element of the created grid and evaluated in
      * the local coordinates of the bound element.
      *
      * It is implemented in terms of the \ref LocalParametrization function
      * returned by the method \ref localParametrization(element). See comments
      * there for further details.
      *
      * Note, this methods requires the GridCreator to be based by
      * lvalue-reference. This is necessary, since we want to guarantee that all
      * internal storage is preserved while evaluating the local function.
      **/
      friend LocalFunction localFunction (LagrangeGridCreator& gridCreator)
      {
        return LocalFunction{gridCreator};
      }
237

Stenger, Florian's avatar
Stenger, Florian committed
238
239
240
241
      friend LocalFunction localFunction (LagrangeGridCreator const& gridCreator)
      {
        return LocalFunction{gridCreator};
      }
242

Stenger, Florian's avatar
Stenger, Florian committed
243
244
245
246
247
      friend LocalFunction localFunction (LagrangeGridCreator&& gridCreator)
      {
        DUNE_THROW(Dune::Exception, "Cannot pass temporary LagrangeGridCreator to localFunction(). Pass an lvalue-reference instead.");
        return LocalFunction{gridCreator};
      }
248

Stenger, Florian's avatar
Stenger, Florian committed
249
250
251
252
253
254
255
256
257
258
259
260
      struct EntitySet
      {
        using Grid = GridType;
        using GlobalCoordinate = typename Self::GlobalCoordinate;
      };

      /// Dummy function returning a placeholder entityset
      EntitySet entitySet () const
      {
        assert(false && "Should not be used!");
        return EntitySet{};
      }
Praetorius, Simon's avatar
Praetorius, Simon committed
261

Stenger, Florian's avatar
Stenger, Florian committed
262
263
264
265
266
267
      /// Dummy function returning a placeholder entityset
      GlobalCoordinate operator() (GlobalCoordinate const&) const
      {
        assert(false && "Should not be used!");
        return GlobalCoordinate{};
      }
Praetorius, Simon's avatar
Praetorius, Simon committed
268

Stenger, Florian's avatar
Stenger, Florian committed
269
270
271
    private:
      /// All point coordinates inclusing the higher-order lagrange points
      Nodes nodes_;
Praetorius, Simon's avatar
Praetorius, Simon committed
272

Stenger, Florian's avatar
Stenger, Florian committed
273
274
275
      /// Parametrization for all elements
      Parametrization parametrization_;
    };
Praetorius, Simon's avatar
Praetorius, Simon committed
276
277


Stenger, Florian's avatar
Stenger, Florian committed
278
279
    template <class Grid>
    class LagrangeGridCreator<Grid>::LocalParametrization
Praetorius, Simon's avatar
Praetorius, Simon committed
280
    {
Stenger, Florian's avatar
Stenger, Florian committed
281
282
283
284
285
286
287
288
289
290
291
292
293
      using ctype = typename Grid::ctype;

      using GlobalCoordinate = typename Grid::template Codim<0>::Entity::Geometry::GlobalCoordinate;
      using LocalCoordinate = typename Grid::template Codim<0>::Entity::Geometry::LocalCoordinate;
      using LocalGeometry = MultiLinearGeometry<ctype,Grid::dimension,Grid::dimension>;

      using LocalFE = LagrangeLocalFiniteElement<Vtk::LagrangePointSet, Grid::dimension, ctype, ctype>;
      using LocalBasis = typename LocalFE::Traits::LocalBasisType;
      using LocalBasisTraits = typename LocalBasis::Traits;

    public:
      /// Construct a local element parametrization
      template <class Nodes, class LocalParam>
294
      LocalParametrization (Nodes const& nodes, LocalParam const& param, int order)
Stenger, Florian's avatar
Stenger, Florian committed
295
296
297
298
299
300
        : localFE_(param.type, order)
        , localNodes_(param.nodes.size())
      {
        for (std::size_t i = 0; i < localNodes_.size(); ++i)
          localNodes_[i] = nodes[param.nodes[i]];
      }
Praetorius, Simon's avatar
Praetorius, Simon committed
301

Stenger, Florian's avatar
Stenger, Florian committed
302
303
      /// Construct a local element parametrization for elements with permuted corners
      template <class Nodes, class LocalParam, class Permutation>
304
      LocalParametrization (Nodes const& nodes, LocalParam const& param, int order, Permutation const& permutation)
Stenger, Florian's avatar
Stenger, Florian committed
305
306
307
308
309
310
311
312
313
        : LocalParametrization(nodes, param, order)
      {
        auto refElem = referenceElement<ctype,Grid::dimension>(param.type);
        std::vector<LocalCoordinate> corners(permutation.size());
        for (std::size_t i = 0; i < permutation.size(); ++i)
          corners[i] = refElem.position(permutation[i], Grid::dimension);

        localGeometry_.emplace(param.type, corners);
      }
Praetorius, Simon's avatar
Praetorius, Simon committed
314

Stenger, Florian's avatar
Stenger, Florian committed
315
316
317
318
319
320
      /// Evaluate the local parametrization in local coordinates
      template <class LocalCoordinate>
      GlobalCoordinate operator() (LocalCoordinate const& local) const
      {
        // map coordinates if element corners are permuted
        LocalCoordinate x = localGeometry_ ? localGeometry_->global(local) : local;
Praetorius, Simon's avatar
Praetorius, Simon committed
321

Stenger, Florian's avatar
Stenger, Florian committed
322
323
324
        LocalBasis const& localBasis = localFE_.localBasis();
        localBasis.evaluateFunction(x, shapeValues_);
        assert(shapeValues_.size() == localNodes_.size());
Praetorius, Simon's avatar
Praetorius, Simon committed
325

326
327
        using field_type = typename LocalBasisTraits::RangeType::field_type;

Stenger, Florian's avatar
Stenger, Florian committed
328
329
        GlobalCoordinate out(0);
        for (std::size_t i = 0; i < shapeValues_.size(); ++i)
330
          out.axpy(field_type(shapeValues_[i]), localNodes_[i]);
Praetorius, Simon's avatar
Praetorius, Simon committed
331

Stenger, Florian's avatar
Stenger, Florian committed
332
333
        return out;
      }
Praetorius, Simon's avatar
Praetorius, Simon committed
334

Stenger, Florian's avatar
Stenger, Florian committed
335
336
337
338
    private:
      LocalFE localFE_;
      std::vector<GlobalCoordinate> localNodes_;
      std::optional<LocalGeometry> localGeometry_;
Praetorius, Simon's avatar
Praetorius, Simon committed
339

Stenger, Florian's avatar
Stenger, Florian committed
340
341
      mutable std::vector<typename LocalBasisTraits::RangeType> shapeValues_;
    };
Praetorius, Simon's avatar
Praetorius, Simon committed
342

343

Stenger, Florian's avatar
Stenger, Florian committed
344
345
    template <class Grid>
    class LagrangeGridCreator<Grid>::LocalFunction
Praetorius, Simon's avatar
Praetorius, Simon committed
346
    {
Stenger, Florian's avatar
Stenger, Florian committed
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
      using ctype = typename Grid::ctype;
      using LocalContext = typename Grid::template Codim<0>::Entity;
      using GlobalCoordinate = typename LocalContext::Geometry::GlobalCoordinate;
      using LocalCoordinate = typename LocalContext::Geometry::LocalCoordinate;
      using LocalParametrization = typename LagrangeGridCreator::LocalParametrization;

    public:
      explicit LocalFunction (LagrangeGridCreator const& gridCreator)
        : gridCreator_(&gridCreator)
      {}

      explicit LocalFunction (LagrangeGridCreator&& gridCreator) = delete;

      /// Collect a local parametrization on the element
      void bind (LocalContext const& element)
      {
        localContext_ = element;
        localParametrization_.emplace(gridCreator_->localParametrization(element));
      }
Praetorius, Simon's avatar
Praetorius, Simon committed
366

Stenger, Florian's avatar
Stenger, Florian committed
367
      void unbind () { /* do nothing */ }
Praetorius, Simon's avatar
Praetorius, Simon committed
368

Stenger, Florian's avatar
Stenger, Florian committed
369
370
371
372
373
374
      /// Evaluate the local parametrization in local coordinates
      GlobalCoordinate operator() (LocalCoordinate const& local) const
      {
        assert(!!localParametrization_);
        return (*localParametrization_)(local);
      }
Praetorius, Simon's avatar
Praetorius, Simon committed
375

Stenger, Florian's avatar
Stenger, Florian committed
376
377
378
379
380
      /// Return the bound element
      LocalContext const& localContext () const
      {
        return localContext_;
      }
Praetorius, Simon's avatar
Praetorius, Simon committed
381

Stenger, Florian's avatar
Stenger, Florian committed
382
383
    private:
      LagrangeGridCreator const* gridCreator_;
Praetorius, Simon's avatar
Praetorius, Simon committed
384

Stenger, Florian's avatar
Stenger, Florian committed
385
386
387
      LocalContext localContext_;
      std::optional<LocalParametrization> localParametrization_;
    };
Praetorius, Simon's avatar
Praetorius, Simon committed
388

Stenger, Florian's avatar
Stenger, Florian committed
389
  } // end namespace Vtk
Praetorius, Simon's avatar
Praetorius, Simon committed
390
} // end namespace Dune