Reference documentation for deal.II version Git 31af17f30d 2020-12-04 11:18:37 -0500
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
mapping.h
Go to the documentation of this file.
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 
24 
26 
27 #include <deal.II/grid/tria.h>
28 
29 #include <array>
30 #include <cmath>
31 #include <memory>
32 
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 
300 template <int dim, int spacedim = dim>
301 class Mapping : public Subscriptor
302 {
303 public:
307  virtual ~Mapping() override = default;
308 
318  virtual std::unique_ptr<Mapping<dim, spacedim>>
319  clone() const = 0;
320 
335  virtual boost::container::small_vector<Point<spacedim>,
337  get_vertices(
338  const typename Triangulation<dim, spacedim>::cell_iterator &cell) const;
339 
363  virtual Point<spacedim>
365  const bool map_center_of_reference_cell = true) const;
366 
384  virtual BoundingBox<spacedim>
386  const typename Triangulation<dim, spacedim>::cell_iterator &cell) const;
387 
399  virtual bool
400  preserves_vertex_locations() const = 0;
401 
418  virtual Point<spacedim>
420  const typename Triangulation<dim, spacedim>::cell_iterator &cell,
421  const Point<dim> & p) const = 0;
422 
451  virtual Point<dim>
453  const typename Triangulation<dim, spacedim>::cell_iterator &cell,
454  const Point<spacedim> & p) const = 0;
455 
467  virtual void
469  const typename Triangulation<dim, spacedim>::cell_iterator &cell,
470  const ArrayView<const Point<spacedim>> & real_points,
471  const ArrayView<Point<dim>> &unit_points) const;
472 
483  Point<dim - 1>
485  const typename Triangulation<dim, spacedim>::cell_iterator &cell,
486  const unsigned int face_no,
487  const Point<spacedim> & p) const;
488 
503 
504 
514  "Computing the mapping between a real space point and a point in reference "
515  "space failed, typically because the given point lies outside the cell "
516  "where the inverse mapping is not unique.");
517 
527  double,
528  int,
529  << "The image of the mapping applied to cell with center ["
530  << arg1 << "] is distorted. The cell geometry or the "
531  << "mapping are invalid, giving a non-positive volume "
532  << "fraction of " << arg2 << " in quadrature point " << arg3
533  << ".");
534 
544 public:
611  {
612  public:
618 
622  InternalDataBase(const InternalDataBase &) = delete;
623 
627  virtual ~InternalDataBase() = default;
628 
644 
648  virtual std::size_t
649  memory_consumption() const;
650  };
651 
652 
653 protected:
677  virtual UpdateFlags
678  requires_update_flags(const UpdateFlags update_flags) const = 0;
679 
728  virtual std::unique_ptr<InternalDataBase>
729  get_data(const UpdateFlags update_flags,
730  const Quadrature<dim> &quadrature) const = 0;
731 
759  virtual std::unique_ptr<InternalDataBase>
760  get_face_data(const UpdateFlags update_flags,
761  const Quadrature<dim - 1> &quadrature) const = 0;
762 
791  virtual std::unique_ptr<InternalDataBase>
792  get_subface_data(const UpdateFlags update_flags,
793  const Quadrature<dim - 1> &quadrature) const = 0;
794 
880  const typename Triangulation<dim, spacedim>::cell_iterator &cell,
881  const CellSimilarity::Similarity cell_similarity,
882  const Quadrature<dim> & quadrature,
883  const typename Mapping<dim, spacedim>::InternalDataBase & internal_data,
885  &output_data) const = 0;
886 
911  virtual void
913  const typename Triangulation<dim, spacedim>::cell_iterator &cell,
914  const unsigned int face_no,
915  const Quadrature<dim - 1> & quadrature,
916  const typename Mapping<dim, spacedim>::InternalDataBase & internal_data,
918  &output_data) const = 0;
919 
946  virtual void
948  const typename Triangulation<dim, spacedim>::cell_iterator &cell,
949  const unsigned int face_no,
950  const unsigned int subface_no,
951  const Quadrature<dim - 1> & quadrature,
952  const typename Mapping<dim, spacedim>::InternalDataBase & internal_data,
954  &output_data) const = 0;
955 
960 public:
1029  virtual void
1030  transform(const ArrayView<const Tensor<1, dim>> & input,
1031  const MappingKind kind,
1032  const typename Mapping<dim, spacedim>::InternalDataBase &internal,
1033  const ArrayView<Tensor<1, spacedim>> &output) const = 0;
1034 
1082  virtual void
1084  const MappingKind kind,
1085  const typename Mapping<dim, spacedim>::InternalDataBase &internal,
1086  const ArrayView<Tensor<2, spacedim>> &output) const = 0;
1087 
1140  virtual void
1141  transform(const ArrayView<const Tensor<2, dim>> & input,
1142  const MappingKind kind,
1143  const typename Mapping<dim, spacedim>::InternalDataBase &internal,
1144  const ArrayView<Tensor<2, spacedim>> &output) const = 0;
1145 
1187  virtual void
1189  const MappingKind kind,
1190  const typename Mapping<dim, spacedim>::InternalDataBase &internal,
1191  const ArrayView<Tensor<3, spacedim>> &output) const = 0;
1192 
1240  virtual void
1241  transform(const ArrayView<const Tensor<3, dim>> & input,
1242  const MappingKind kind,
1243  const typename Mapping<dim, spacedim>::InternalDataBase &internal,
1244  const ArrayView<Tensor<3, spacedim>> &output) const = 0;
1245 
1251  // Give class @p FEValues access to the private <tt>get_...data</tt> and
1252  // <tt>fill_fe_...values</tt> functions.
1253  friend class FEValuesBase<dim, spacedim>;
1254  friend class FEValues<dim, spacedim>;
1255  friend class FEFaceValues<dim, spacedim>;
1256  friend class FESubfaceValues<dim, spacedim>;
1257 };
1258 
1259 
1261 
1262 #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:107
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:45
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 void transform_points_real_to_unit_cell(const typename Triangulation< dim, spacedim >::cell_iterator &cell, const ArrayView< const Point< spacedim >> &real_points, const ArrayView< Point< dim >> &unit_points) const
Definition: mapping.cc:83
virtual std::size_t memory_consumption() const
Definition: mapping.cc:156
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:301
#define DeclExceptionMsg(Exception, defaulttext)
Definition: exceptions.h:493
#define DeclException0(Exception0)
Definition: exceptions.h:470
#define DEAL_II_NAMESPACE_CLOSE
Definition: config.h:372
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:70
#define DEAL_II_NAMESPACE_OPEN
Definition: config.h:371
virtual UpdateFlags requires_update_flags(const UpdateFlags update_flags) const =0
Definition: fe.h:38
virtual bool preserves_vertex_locations() const =0
virtual boost::container::small_vector< Point< spacedim >, GeometryInfo< dim >::vertices_per_cell > get_vertices(const typename Triangulation< dim, spacedim >::cell_iterator &cell) const
Definition: mapping.cc:29
#define DeclException3(Exception3, type1, type2, type3, outsequence)
Definition: exceptions.h:561
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:643
virtual std::unique_ptr< InternalDataBase > get_data(const UpdateFlags update_flags, const Quadrature< dim > &quadrature) const =0