Reference documentation for deal.II version Git c679197b1a 2019-11-19 16:09:58 -0500
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
mapping.h
1 // ---------------------------------------------------------------------
2 //
3 // Copyright (C) 2000 - 2019 by the deal.II authors
4 //
5 // This file is part of the deal.II library.
6 //
7 // The deal.II library is free software; you can use it, redistribute
8 // it, and/or modify it under the terms of the GNU Lesser General
9 // Public License as published by the Free Software Foundation; either
10 // version 2.1 of the License, or (at your option) any later version.
11 // The full text of the license can be found in the file LICENSE.md at
12 // the top level directory of deal.II.
13 //
14 // ---------------------------------------------------------------------
15 
16 #ifndef dealii_mapping_h
17 #define dealii_mapping_h
18 
19 
20 #include <deal.II/base/config.h>
21 
22 #include <deal.II/base/array_view.h>
23 #include <deal.II/base/derivative_form.h>
24 
25 #include <deal.II/fe/fe_update_flags.h>
26 
27 #include <deal.II/grid/tria.h>
28 
29 #include <array>
30 #include <cmath>
31 #include <memory>
32 
33 DEAL_II_NAMESPACE_OPEN
34 
35 template <typename ElementType, typename MemorySpaceType>
36 class ArrayView;
37 template <int dim>
38 class Quadrature;
39 template <int dim, int spacedim>
40 class FEValues;
41 template <int dim, int spacedim>
42 class FEValuesBase;
43 template <int dim, int spacedim>
44 class FEValues;
45 template <int dim, int spacedim>
46 class FEFaceValues;
47 template <int dim, int spacedim>
48 class FESubfaceValues;
49 
50 
63 {
68  mapping_none = 0x0000,
69 
74 
79 
85 
91 
98  mapping_piola = 0x0100,
99 
105 
113  mapping_nedelec = 0x0200,
114 
119 
124 
135 
141 
147 };
148 
149 
301 template <int dim, int spacedim = dim>
302 class Mapping : public Subscriptor
303 {
304 public:
308  virtual ~Mapping() override = default;
309 
319  virtual std::unique_ptr<Mapping<dim, spacedim>>
320  clone() const = 0;
321 
336  virtual std::array<Point<spacedim>, GeometryInfo<dim>::vertices_per_cell>
337  get_vertices(
338  const typename Triangulation<dim, spacedim>::cell_iterator &cell) const;
339 
365  virtual Point<spacedim>
367  const bool map_center_of_reference_cell = true) const;
368 
388  virtual BoundingBox<spacedim>
390  const typename Triangulation<dim, spacedim>::cell_iterator &cell) const;
391 
403  virtual bool
404  preserves_vertex_locations() const = 0;
405 
422  virtual Point<spacedim>
424  const typename Triangulation<dim, spacedim>::cell_iterator &cell,
425  const Point<dim> & p) const = 0;
426 
455  virtual Point<dim>
457  const typename Triangulation<dim, spacedim>::cell_iterator &cell,
458  const Point<spacedim> & p) const = 0;
459 
469  Point<dim - 1>
471  const typename Triangulation<dim, spacedim>::cell_iterator &cell,
472  const unsigned int face_no,
473  const Point<spacedim> & p) const;
474 
489 
490 
500  "Computing the mapping between a real space point and a point in reference "
501  "space failed, typically because the given point lies outside the cell "
502  "where the inverse mapping is not unique.");
503 
513  double,
514  int,
515  << "The image of the mapping applied to cell with center ["
516  << arg1 << "] is distorted. The cell geometry or the "
517  << "mapping are invalid, giving a non-positive volume "
518  << "fraction of " << arg2 << " in quadrature point " << arg3
519  << ".");
520 
530 public:
597  {
598  public:
604 
608  InternalDataBase(const InternalDataBase &) = delete;
609 
613  virtual ~InternalDataBase() = default;
614 
630 
634  virtual std::size_t
635  memory_consumption() const;
636  };
637 
638 
639 protected:
663  virtual UpdateFlags
664  requires_update_flags(const UpdateFlags update_flags) const = 0;
665 
714  virtual std::unique_ptr<InternalDataBase>
715  get_data(const UpdateFlags update_flags,
716  const Quadrature<dim> &quadrature) const = 0;
717 
745  virtual std::unique_ptr<InternalDataBase>
746  get_face_data(const UpdateFlags update_flags,
747  const Quadrature<dim - 1> &quadrature) const = 0;
748 
777  virtual std::unique_ptr<InternalDataBase>
778  get_subface_data(const UpdateFlags update_flags,
779  const Quadrature<dim - 1> &quadrature) const = 0;
780 
866  const typename Triangulation<dim, spacedim>::cell_iterator &cell,
867  const CellSimilarity::Similarity cell_similarity,
868  const Quadrature<dim> & quadrature,
869  const typename Mapping<dim, spacedim>::InternalDataBase & internal_data,
871  &output_data) const = 0;
872 
897  virtual void
899  const typename Triangulation<dim, spacedim>::cell_iterator &cell,
900  const unsigned int face_no,
901  const Quadrature<dim - 1> & quadrature,
902  const typename Mapping<dim, spacedim>::InternalDataBase & internal_data,
904  &output_data) const = 0;
905 
932  virtual void
934  const typename Triangulation<dim, spacedim>::cell_iterator &cell,
935  const unsigned int face_no,
936  const unsigned int subface_no,
937  const Quadrature<dim - 1> & quadrature,
938  const typename Mapping<dim, spacedim>::InternalDataBase & internal_data,
940  &output_data) const = 0;
941 
946 public:
1015  virtual void
1016  transform(const ArrayView<const Tensor<1, dim>> & input,
1017  const MappingKind kind,
1018  const typename Mapping<dim, spacedim>::InternalDataBase &internal,
1019  const ArrayView<Tensor<1, spacedim>> &output) const = 0;
1020 
1068  virtual void
1070  const MappingKind kind,
1071  const typename Mapping<dim, spacedim>::InternalDataBase &internal,
1072  const ArrayView<Tensor<2, spacedim>> &output) const = 0;
1073 
1126  virtual void
1127  transform(const ArrayView<const Tensor<2, dim>> & input,
1128  const MappingKind kind,
1129  const typename Mapping<dim, spacedim>::InternalDataBase &internal,
1130  const ArrayView<Tensor<2, spacedim>> &output) const = 0;
1131 
1173  virtual void
1175  const MappingKind kind,
1176  const typename Mapping<dim, spacedim>::InternalDataBase &internal,
1177  const ArrayView<Tensor<3, spacedim>> &output) const = 0;
1178 
1226  virtual void
1227  transform(const ArrayView<const Tensor<3, dim>> & input,
1228  const MappingKind kind,
1229  const typename Mapping<dim, spacedim>::InternalDataBase &internal,
1230  const ArrayView<Tensor<3, spacedim>> &output) const = 0;
1231 
1237  // Give class @p FEValues access to the private <tt>get_...data</tt> and
1238  // <tt>fill_fe_...values</tt> functions.
1239  friend class FEValuesBase<dim, spacedim>;
1240  friend class FEValues<dim, spacedim>;
1241  friend class FEFaceValues<dim, spacedim>;
1242  friend class FESubfaceValues<dim, spacedim>;
1243 };
1244 
1245 
1246 DEAL_II_NAMESPACE_CLOSE
1247 
1248 #endif
Point< dim - 1 > project_real_point_to_unit_point_on_face(const typename Triangulation< dim, spacedim >::cell_iterator &cell, const unsigned int face_no, const Point< spacedim > &p) const
Definition: mapping.cc:81
virtual std::unique_ptr< InternalDataBase > get_subface_data(const UpdateFlags update_flags, const Quadrature< dim - 1 > &quadrature) const =0
static ::ExceptionBase & ExcTransformationFailed()
virtual ~InternalDataBase()=default
virtual Point< spacedim > get_center(const typename Triangulation< dim, spacedim >::cell_iterator &cell, const bool map_center_of_reference_cell=true) const
Definition: mapping.cc:43
virtual void transform(const ArrayView< const Tensor< 1, dim >> &input, const MappingKind kind, const typename Mapping< dim, spacedim >::InternalDataBase &internal, const ArrayView< Tensor< 1, spacedim >> &output) const =0
virtual std::size_t memory_consumption() const
Definition: mapping.cc:130
virtual std::array< Point< spacedim >, GeometryInfo< dim >::vertices_per_cell > get_vertices(const typename Triangulation< dim, spacedim >::cell_iterator &cell) const
Definition: mapping.cc:28
virtual ~Mapping() override=default
virtual std::unique_ptr< InternalDataBase > get_face_data(const UpdateFlags update_flags, const Quadrature< dim - 1 > &quadrature) const =0
virtual Point< dim > transform_real_to_unit_cell(const typename Triangulation< dim, spacedim >::cell_iterator &cell, const Point< spacedim > &p) const =0
static ::ExceptionBase & ExcDistortedMappedCell(Point< spacedim > arg1, double arg2, int arg3)
MappingKind
Definition: mapping.h:62
virtual void fill_fe_face_values(const typename Triangulation< dim, spacedim >::cell_iterator &cell, const unsigned int face_no, const Quadrature< dim - 1 > &quadrature, const typename Mapping< dim, spacedim >::InternalDataBase &internal_data, ::internal::FEValuesImplementation::MappingRelatedData< dim, spacedim > &output_data) const =0
UpdateFlags
Abstract base class for mapping classes.
Definition: mapping.h:302
#define DeclExceptionMsg(Exception, defaulttext)
Definition: exceptions.h:496
#define DeclException0(Exception0)
Definition: exceptions.h:473
static ::ExceptionBase & ExcInvalidData()
virtual CellSimilarity::Similarity fill_fe_values(const typename Triangulation< dim, spacedim >::cell_iterator &cell, const CellSimilarity::Similarity cell_similarity, const Quadrature< dim > &quadrature, const typename Mapping< dim, spacedim >::InternalDataBase &internal_data, ::internal::FEValuesImplementation::MappingRelatedData< dim, spacedim > &output_data) const =0
virtual BoundingBox< spacedim > get_bounding_box(const typename Triangulation< dim, spacedim >::cell_iterator &cell) const
Definition: mapping.cc:68
virtual UpdateFlags requires_update_flags(const UpdateFlags update_flags) const =0
Definition: fe.h:38
virtual bool preserves_vertex_locations() const =0
#define DeclException3(Exception3, type1, type2, type3, outsequence)
Definition: exceptions.h:564
virtual void fill_fe_subface_values(const typename Triangulation< dim, spacedim >::cell_iterator &cell, const unsigned int face_no, const unsigned int subface_no, const Quadrature< dim - 1 > &quadrature, const typename Mapping< dim, spacedim >::InternalDataBase &internal_data, ::internal::FEValuesImplementation::MappingRelatedData< dim, spacedim > &output_data) const =0
virtual Point< spacedim > transform_unit_to_real_cell(const typename Triangulation< dim, spacedim >::cell_iterator &cell, const Point< dim > &p) const =0
virtual std::unique_ptr< Mapping< dim, spacedim > > clone() const =0
UpdateFlags update_each
Definition: mapping.h:629
virtual std::unique_ptr< InternalDataBase > get_data(const UpdateFlags update_flags, const Quadrature< dim > &quadrature) const =0