Reference documentation for deal.II version GIT relicensing362gab68047079 20240411 17:50:02+00:00

#include <deal.II/grid/manifold_lib.h>
Public Types  
using  FaceVertexNormals = std::array< Tensor< 1, spacedim >, GeometryInfo< dim >::vertices_per_face > 
Public Member Functions  
PolarManifold (const Point< spacedim > center=Point< spacedim >())  
virtual std::unique_ptr< Manifold< dim, spacedim > >  clone () const override 
virtual Point< spacedim >  pull_back (const Point< spacedim > &space_point) const override 
virtual Point< spacedim >  push_forward (const Point< spacedim > &chart_point) const override 
virtual DerivativeForm< 1, spacedim, spacedim >  push_forward_gradient (const Point< spacedim > &chart_point) const override 
virtual Tensor< 1, spacedim >  normal_vector (const typename Triangulation< dim, spacedim >::face_iterator &face, const Point< spacedim > &p) const override 
virtual Point< spacedim >  get_intermediate_point (const Point< spacedim > &p1, const Point< spacedim > &p2, const double w) const override 
virtual Point< spacedim >  get_new_point (const ArrayView< const Point< spacedim > > &surrounding_points, const ArrayView< const double > &weights) const override 
virtual void  get_new_points (const ArrayView< const Point< spacedim > > &surrounding_points, const Table< 2, double > &weights, ArrayView< Point< spacedim > > new_points) const override 
virtual Point< spacedim >  push_forward (const Point< chartdim > &chart_point) const =0 
virtual DerivativeForm< 1, chartdim, spacedim >  push_forward_gradient (const Point< chartdim > &chart_point) const 
virtual Tensor< 1, spacedim >  get_tangent_vector (const Point< spacedim > &x1, const Point< spacedim > &x2) const override 
const Tensor< 1, chartdim > &  get_periodicity () const 
template<class Archive >  
void  serialize (Archive &ar, const unsigned int version) 
Computing the location of points.  
virtual Point< spacedim >  project_to_manifold (const ArrayView< const Point< spacedim > > &surrounding_points, const Point< spacedim > &candidate) const 
virtual Point< spacedim >  get_new_point_on_line (const typename Triangulation< dim, spacedim >::line_iterator &line) const 
virtual Point< spacedim >  get_new_point_on_quad (const typename Triangulation< dim, spacedim >::quad_iterator &quad) const 
virtual Point< spacedim >  get_new_point_on_hex (const typename Triangulation< dim, spacedim >::hex_iterator &hex) const 
Point< spacedim >  get_new_point_on_face (const typename Triangulation< dim, spacedim >::face_iterator &face) const 
Point< spacedim >  get_new_point_on_cell (const typename Triangulation< dim, spacedim >::cell_iterator &cell) const 
Computing normal vectors  
virtual void  get_normals_at_vertices (const typename Triangulation< dim, spacedim >::face_iterator &face, FaceVertexNormals &face_vertex_normals) const 
Subscriptor functionality  
Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class.  
void  subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const 
void  unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const 
unsigned int  n_subscriptions () const 
template<typename StreamType >  
void  list_subscribers (StreamType &stream) const 
void  list_subscribers () const 
Static Public Member Functions  
static ::ExceptionBase &  ExcInUse (int arg1, std::string arg2, std::string arg3) 
static ::ExceptionBase &  ExcNoSubscriber (std::string arg1, std::string arg2) 
Public Attributes  
const Point< spacedim >  center 
Private Types  
using  map_value_type = decltype(counter_map)::value_type 
using  map_iterator = decltype(counter_map)::iterator 
Private Member Functions  
void  check_no_subscribers () const noexcept 
Static Private Member Functions  
static Tensor< 1, spacedim >  get_periodicity () 
Private Attributes  
const FlatManifold< chartdim, chartdim >  sub_manifold 
std::atomic< unsigned int >  counter 
std::map< std::string, unsigned int >  counter_map 
std::vector< std::atomic< bool > * >  validity_pointers 
const std::type_info *  object_info 
Static Private Attributes  
static std::mutex  mutex 
Manifold description for a polar coordinate system.
You can use this Manifold object to describe any sphere, circle, hypersphere or hyperdisc in two or three dimensions, both as a codimension one manifold descriptor or as codimension zero manifold descriptor, provided that the north and south poles (in three dimensions) and the center (in both two and three dimensions) are excluded from the Manifold (as they are singular points of the polar change of coordinates).
The two template arguments match the meaning of the two template arguments in Triangulation<dim, spacedim>; however, this Manifold can be used to describe both thin and thick objects, and the behavior is identical when dim <= spacedim, i.e., the functionality of PolarManifold<2,3> is identical to PolarManifold<3,3>.
This class works by transforming points from Cartesian coordinates into Polar coordinates, doing computations (e.g., averages) in that coordinate system, and then transforming the results back to Cartesian coordinates. For more information on this approach see the documentation of the base class (ChartManifold).
In order for this manifold to work correctly, it cannot be attached to cells containing the center of the coordinate system or, in 3d, the north and south poles. Those points are singular points of the coordinate mapping; consequently, pull_back() is not defined at those points and taking averages across them does not make sense. We recommend setting the manifold_id of the cell containing the center to numbers::flat_manifold_id and blending in one of two ways:
In 3d, we recommend using SphericalManifold to correctly handle the north and south poles.
Definition at line 83 of file manifold_lib.h.

inherited 
Type keeping information about the normals at the vertices of a face of a cell. Thus, there are GeometryInfo<dim>::vertices_per_face
normal vectors, that define the tangent spaces of the boundary at the vertices. Note that the vectors stored in this object are not required to be normalized, nor to actually point outward, as one often will only want to check for orthogonality to define the tangent plane; if a function requires the normals to be normalized, then it must do so itself.
For obvious reasons, this type is not useful in 1d.
Definition at line 305 of file manifold.h.

privateinherited 
The data type used in counter_map.
Definition at line 229 of file subscriptor.h.

privateinherited 
The iterator type used in counter_map.
Definition at line 234 of file subscriptor.h.
PolarManifold< dim, spacedim >::PolarManifold  (  const Point< spacedim >  center = Point<spacedim>()  ) 
Constructor.
[in]  center  The center of the coordinate system. Defaults to the origin. 
Definition at line 127 of file manifold_lib.cc.

overridevirtual 
Make a clone of this Manifold object.
Implements Manifold< dim, spacedim >.
Definition at line 137 of file manifold_lib.cc.

overridevirtual 
Pull back the given point from the Euclidean space. Will return the polar coordinates associated with the point space_point
.
Implements ChartManifold< dim, spacedim, chartdim >.
Definition at line 197 of file manifold_lib.cc.

overridevirtual 
Given a point in the spherical coordinate system, this method returns the Euclidean coordinates associated to the polar coordinates chart_point
.
Definition at line 163 of file manifold_lib.cc.

overridevirtual 
Given a point in the spacedim dimensional Euclidean space, this method returns the derivatives of the function \(F\) that maps from the polar coordinate system to the Euclidean coordinate system. In other words, it is a matrix of size \(\text{spacedim}\times\text{spacedim}\).
This function is used in the computations required by the get_tangent_vector() function.
Refer to the general documentation of this class for more information.
Definition at line 236 of file manifold_lib.cc.

overridevirtual 
Return the normal vector to a face embedded in this manifold, at the point p. It is not required that the normals actually point outward from the domain even if the face iterator given points to a face on the boundary of the domain. If p is not in fact on the surface, but only closeby, try to return something reasonable, for example the normal vector at the surface point closest to p. (The point p will in fact not normally lie on the actual surface, but rather be a quadrature point mapped by some polynomial mapping; the mapped surface, however, will not usually coincide with the actual surface.)
This function only makes sense if dim==spacedim because otherwise there is no unique normal vector but in fact a (spacedimdim+1)dimensional tangent space of vectors that are all both normal to the face and normal to the dimdimensional surface that lives in spacedimdimensional space. For example, think of a twodimensional mesh that covers a twodimensional surface in threedimensional space. In that case, each face (edge) is onedimensional, and there are two linearly independent vectors that are both normal to the edge: one is normal to the edge and tangent to the surface (intuitively, that would be the one that points from the current cell to the neighboring one, if the surface was locally flat), and the other one is rooted in the edge but points perpendicular to the surface (which is also perpendicular to the edge that lives within the surface). Thus, because there are no obviously correct semantics for this function if spacedim is greater than dim, the function will simply throw an error in that situation.
The face iterator gives an indication which face this function is supposed to compute the normal vector for. This is useful if the boundary of the domain is composed of different nondifferential pieces (for example when using the FlatManifold class to approximate a geometry that is completely described by the coarse mesh, with piecewise (bi)linear components between the vertices, but where the boundary may have a kink at the vertices itself).
Reimplemented from Manifold< dim, spacedim >.
Definition at line 325 of file manifold_lib.cc.

staticprivate 
Helper function which returns the periodicity associated with this coordinate system, according to dim, chartdim, and spacedim.
Definition at line 146 of file manifold_lib.cc.

overridevirtualinherited 
Refer to the general documentation of this class and the documentation of the base class for more information.
Reimplemented from Manifold< dim, spacedim >.
Definition at line 1013 of file manifold.cc.

overridevirtualinherited 
Refer to the general documentation of this class and the documentation of the base class for more information.
Reimplemented from Manifold< dim, spacedim >.
Reimplemented in CylindricalManifold< dim, spacedim >.
Definition at line 1027 of file manifold.cc.

overridevirtualinherited 
Compute a new set of points that interpolate between the given points surrounding_points
. weights
is a table with as many columns as surrounding_points.size()
. The number of rows in weights
must match the length of new_points
.
The implementation of this function first transforms the surrounding_points
to the chart space by calling pull_back(). Then, new points are computed on the chart by usual interpolation according to the given weights
, which are finally transformed to the image space by push_forward().
This implementation can be much more efficient for computing multiple new points from the same surrounding points than separate calls to get_new_point() in case the pull_back() operation is expensive. This is because pull_back() is only called once for the surrounding points and the interpolation is done for all given weights using this set of points. Often, pull_back() is also more expensive than push_forward() because the former might involve some kind of Newton iteration in nontrivial manifolds.
Reimplemented from Manifold< dim, spacedim >.
Definition at line 1048 of file manifold.cc.

pure virtualinherited 
Given a point in the chartdim dimensional Euclidean space, this method returns a point on the manifold embedded in the spacedim Euclidean space.
Refer to the general documentation of this class for more information.
Implemented in CompositionManifold< dim, spacedim, chartdim, intermediate_dim, dim1, dim2 >, FunctionManifold< dim, spacedim, chartdim >, and TensorProductManifold< dim, dim_A, spacedim_A, chartdim_A, dim_B, spacedim_B, chartdim_B >.

virtualinherited 
Given a point in the chartdim dimensional Euclidean space, this method returns the derivatives of the function \(F\) that maps from the chartdimdimensional to the spacedimdimensional space. In other words, it is a matrix of size \(\text{spacedim}\times\text{chartdim}\).
This function is used in the computations required by the get_tangent_vector() function. Since not all users of the Manifold class interface will require calling that function, the current function is implemented but will trigger an exception whenever called. This allows derived classes to avoid implementing the push_forward_gradient function if this functionality is not needed in the user program.
Refer to the general documentation of this class for more information.
Reimplemented in CompositionManifold< dim, spacedim, chartdim, intermediate_dim, dim1, dim2 >, FunctionManifold< dim, spacedim, chartdim >, and TensorProductManifold< dim, dim_A, spacedim_A, chartdim_A, dim_B, spacedim_B, chartdim_B >.
Definition at line 1074 of file manifold.cc.

overridevirtualinherited 
Return a vector that, at \(\mathbf x_1\), is tangential to the geodesic that connects two points \(\mathbf x_1,\mathbf x_2\). See the documentation of the Manifold class and of Manifold::get_tangent_vector() for a more detailed description.
For the current class, we assume that this geodesic is the image under the push_forward() operation of a straight line of the preimages of x1
and x2
(where preimages are computed by pulling back the locations x1
and x2
). In other words, if these preimages are \(\xi_1=F^{1}(\mathbf x_1), \xi_2=F^{1}(\mathbf x_2)\), then the geodesic in preimage (the chartdimdimensional Euclidean) space is
\begin{align*} \zeta(t) &= \xi_1 + t (\xi_2\xi_1) \\ &= F^{1}(\mathbf x_1) + t\left[F^{1}(\mathbf x_2) F^{1}(\mathbf x_1)\right] \end{align*}
In image space, i.e., in the space in which we operate, this leads to the curve
\begin{align*} \mathbf s(t) &= F(\zeta(t)) \\ &= F(\xi_1 + t (\xi_2\xi_1)) \\ &= F\left(F^{1}(\mathbf x_1) + t\left[F^{1}(\mathbf x_2) F^{1}(\mathbf x_1)\right]\right). \end{align*}
What the current function is supposed to return is \(\mathbf s'(0)\). By the chain rule, this is equal to
\begin{align*} \mathbf s'(0) &= \frac{d}{dt}\left. F\left(F^{1}(\mathbf x_1) + t\left[F^{1}(\mathbf x_2) F^{1}(\mathbf x_1)\right]\right) \right_{t=0} \\ &= \nabla_\xi F\left(F^{1}(\mathbf x_1)\right) \left[F^{1}(\mathbf x_2) F^{1}(\mathbf x_1)\right]. \end{align*}
This formula may then have to be slightly modified by considering any periodicity that was assumed in the call to the constructor.
Thus, the computation of tangent vectors also requires the implementation of derivatives \(\nabla_\xi F(\xi)\) of the pushforward mapping. Here, \(F^{1}(\mathbf x_2)F^{1}(\mathbf x_1)\) is a chartdimdimensional vector, and \(\nabla_\xi F\left(F^{1}(\mathbf x_1)\right) = \nabla_\xi F\left(\xi_1\right)\) is a spacedimtimeschartdimdimensional matrix. Consequently, and as desired, the operation results in a spacedimdimensional vector.
x1  The first point that describes the geodesic, and the one at which the "direction" is to be evaluated. 
x2  The second point that describes the geodesic. 
Reimplemented from Manifold< dim, spacedim >.
Definition at line 1087 of file manifold.cc.

inherited 
Return the periodicity associated with the submanifold.
Definition at line 1119 of file manifold.cc.

virtualinherited 
Given a point which lies close to the given manifold, it modifies it and projects it to manifold itself.
This class is used by the default implementation of the function get_new_point() and should be implemented by derived classes. The default implementation simply throws an exception if called.
If your manifold is simple, you could implement this function only, and the default behavior should work out of the box.
Reimplemented in FlatManifold< dim, spacedim >, FlatManifold< chartdim, chartdim >, FlatManifold< dim, dim >, FlatManifold< dim, spacedim >, OpenCASCADE::NormalProjectionManifold< dim, spacedim >, OpenCASCADE::DirectionalProjectionManifold< dim, spacedim >, and OpenCASCADE::NormalToMeshProjectionManifold< dim, spacedim >.

virtualinherited 
Backward compatibility interface. Return the point which shall become the new middle vertex of the two children of a regular line. In 2d, this line is a line at the boundary, while in 3d, it is bounding a face at the boundary (the lines therefore is also on the boundary).
The default implementation of this function passes its argument to the Manifolds::get_default_points_and_weights() function, and then calls the Manifold<dim,spacedim>::get_new_point() function. User derived classes can overload Manifold<dim,spacedim>::get_new_point() or Manifold<dim,spacedim>::project_to_manifold(), which is called by the default implementation of Manifold<dim,spacedim>::get_new_point().

virtualinherited 
Backward compatibility interface. Return the point which shall become the common point of the four children of a quad at the boundary in three or more spatial dimensions. This function therefore is only useful in at least three dimensions and should not be called for lower dimensions.
This function is called after the four lines bounding the given quad
are refined, so you may want to use the information provided by quad>line(i)>child(j)
, i=0...3
, j=0,1
.
The default implementation of this function passes its argument to the Manifolds::get_default_points_and_weights() function, and then calls the Manifold<dim,spacedim>::get_new_point() function. User derived classes can overload Manifold<dim,spacedim>::get_new_point() or Manifold<dim,spacedim>::project_to_manifold(), which is called by the default implementation of Manifold<dim,spacedim>::get_new_point().

virtualinherited 
Backward compatibility interface. Return the point which shall become the common point of the eight children of a hex in three or spatial dimensions. This function therefore is only useful in at least three dimensions and should not be called for lower dimensions.
This function is called after the all the bounding objects of the given hex
are refined, so you may want to use the information provided by hex>quad(i)>line(j)>child(k)
, i=0...5
, j=0...3
, k=0,1
.
The default implementation of this function passes its argument to the Manifolds::get_default_points_and_weights() function, and then calls the Manifold<dim,spacedim>::get_new_point() function. User derived classes can overload Manifold<dim,spacedim>::get_new_point() or Manifold<dim,spacedim>::project_to_manifold(), which is called by the default implementation of Manifold<dim,spacedim>::get_new_point().

inherited 
Backward compatibility interface. Depending on dim=2
or dim=3
this function calls the get_new_point_on_line or the get_new_point_on_quad function. It throws an exception for dim=1
. This wrapper allows dimension independent programming.

inherited 
Backward compatibility interface. Depending on dim=1
, dim=2
or dim=3
this function calls the get_new_point_on_line, get_new_point_on_quad or the get_new_point_on_hex function. This wrapper allows dimension independent programming.

virtualinherited 
Compute the normal vectors to the boundary at each vertex of the given face embedded in the Manifold. It is not required that the normal vectors be normed somehow. Neither is it required that the normals actually point outward.
This function is needed to compute data for C1 mappings. The default implementation calls normal_vector() on each vertex.
Note that when computing normal vectors at a vertex where the boundary is not differentiable, you have to make sure that you compute the onesided limits, i.e. limit with respect to points inside the given face.

inherited 
Subscribes a user of the object by storing the pointer validity
. The subscriber may be identified by text supplied as identifier
.
Definition at line 135 of file subscriptor.cc.

inherited 
Unsubscribes a user from the object.
identifier
and the validity
pointer must be the same as the one supplied to subscribe(). Definition at line 155 of file subscriptor.cc.

inlineinherited 
Return the present number of subscriptions to this object. This allows to use this class for reference counted lifetime determination where the last one to unsubscribe also deletes the object.
Definition at line 300 of file subscriptor.h.

inlineinherited 
List the subscribers to the input stream
.
Definition at line 317 of file subscriptor.h.

inherited 
List the subscribers to deallog
.
Definition at line 203 of file subscriptor.cc.

inlineinherited 
Read or write the data of this object to or from a stream for the purpose of serialization using the BOOST serialization library.
This function does not actually serialize any of the member variables of this class. The reason is that what this class stores is only who subscribes to this object, but who does so at the time of storing the contents of this object does not necessarily have anything to do with who subscribes to the object when it is restored. Consequently, we do not want to overwrite the subscribers at the time of restoring, and then there is no reason to write the subscribers out in the first place.
Definition at line 309 of file subscriptor.h.

privatenoexceptinherited 
Check that there are no objects subscribing to this object. If this check passes then it is safe to destroy the current object. It this check fails then this function will either abort or print an error message to deallog (by using the AssertNothrow mechanism), but will not throw an exception.
Definition at line 52 of file subscriptor.cc.
const Point<spacedim> PolarManifold< dim, spacedim >::center 
The center of the spherical coordinate system.
Definition at line 140 of file manifold_lib.h.

privateinherited 
The sub_manifold object is used to compute the average of the points in the chart coordinates system.
In an ideal world, it would have type FlatManifold<dim,chartdim>. However, this would instantiate cases where dim>spacedim, which leads to invalid situations. We instead use <chartdim,chartdim>, which is (i) always valid, and (ii) does not matter at all since the first (dim) argument of manifolds is, in fact, ignored as far as manifold functionality is concerned.
Definition at line 1087 of file manifold.h.

mutableprivateinherited 
Store the number of objects which subscribed to this object. Initially, this number is zero, and upon destruction it shall be zero again (i.e. all objects which subscribed should have unsubscribed again).
The creator (and owner) of an object is counted in the map below if HE manages to supply identification.
We use the mutable
keyword in order to allow subscription to constant objects also.
This counter may be read from and written to concurrently in multithreaded code: hence we use the std::atomic
class template.
Definition at line 218 of file subscriptor.h.

mutableprivateinherited 
In this map, we count subscriptions for each different identification string supplied to subscribe().
Definition at line 224 of file subscriptor.h.

mutableprivateinherited 
In this vector, we store pointers to the validity bool in the SmartPointer objects that subscribe to this class.
Definition at line 240 of file subscriptor.h.

mutableprivateinherited 
Pointer to the typeinfo object of this object, from which we can later deduce the class name. Since this information on the derived class is neither available in the destructor, nor in the constructor, we obtain it in between and store it here.
Definition at line 248 of file subscriptor.h.

staticprivateinherited 
A mutex used to ensure data consistency when accessing the mutable
members of this class. This lock is used in the subscribe() and unsubscribe() functions, as well as in list_subscribers()
.
Definition at line 271 of file subscriptor.h.