Reference documentation for deal.II version Git 78150d9107 2021-02-24 10:44:07 -0700
PolarManifold< dim, spacedim > Class Template Referenceabstract

#include <deal.II/grid/manifold_lib.h>

Inheritance diagram for PolarManifold< dim, spacedim >:
[legend]

## 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<>

template<>

template<>

template<>
Point< 3 > get_new_point_on_hex (const Triangulation< 3, 3 >::hex_iterator &hex) const

template<>
Point< 1 > get_new_point_on_face (const Triangulation< 1, 1 >::face_iterator &) const

template<>
Point< 2 > get_new_point_on_face (const Triangulation< 1, 2 >::face_iterator &) const

template<>
Point< 3 > get_new_point_on_face (const Triangulation< 1, 3 >::face_iterator &) const

template<>
Tensor< 1, 2 > normal_vector (const Triangulation< 2, 2 >::face_iterator &face, const Point< 2 > &p) const

template<>
Tensor< 1, 3 > normal_vector (const Triangulation< 3, 3 >::face_iterator &face, const Point< 3 > &p) const

template<>
void get_normals_at_vertices (const Triangulation< 2, 2 >::face_iterator &face, FaceVertexNormals &n) const

template<>
void get_normals_at_vertices (const Triangulation< 3, 3 >::face_iterator &face, FaceVertexNormals &n) 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_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 ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)

static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)

## Public Attributes

const Point< spacedim > center

## Static Private Member Functions

static Tensor< 1, spacedim > get_periodicity ()

## Detailed Description

### template<int dim, int spacedim = dim> class PolarManifold< dim, spacedim >

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 co-dimension one manifold descriptor or as co-dimension 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 to polar coordinates (in both two and three dimensions), taking the average in that coordinate system, and then transforming the point back to Cartesian coordinates. In order for this manifold to work correctly, it cannot be attached to cells containing the center of the coordinate system or the north and south poles in three dimensions. These points are singular points of the coordinate transformation, and taking averages around these points does not make any sense.

Definition at line 70 of file manifold_lib.h.

## ◆ FaceVertexNormals

template<int dim, int spacedim = dim>
 using Manifold< dim, spacedim >::FaceVertexNormals = std::array, GeometryInfo::vertices_per_face>
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 307 of file manifold.h.

## ◆ PolarManifold()

template<int dim, int spacedim>
 PolarManifold< dim, spacedim >::PolarManifold ( const Point< spacedim > center = Point() )

The Constructor takes the center of the spherical coordinates system. This class uses the pull_back and push_forward mechanism to transform from Cartesian to spherical coordinate systems, taking into account the periodicity of base Manifold in two dimensions, while in three dimensions it takes the middle point, and project it along the radius using the average radius of the surrounding points.

Definition at line 127 of file manifold_lib.cc.

## ◆ clone()

template<int dim, int spacedim>
 std::unique_ptr< Manifold< dim, spacedim > > PolarManifold< dim, spacedim >::clone ( ) const
overridevirtual

Make a clone of this Manifold object.

Implements Manifold< dim, spacedim >.

Definition at line 137 of file manifold_lib.cc.

## ◆ pull_back()

template<int dim, int spacedim>
 Point< spacedim > PolarManifold< dim, spacedim >::pull_back ( const Point< spacedim > & space_point ) const
overridevirtual

Pull back the given point from the Euclidean space. Will return the polar coordinates associated with the point space_point. Only used when spacedim = 2.

Implements ChartManifold< dim, spacedim, spacedim >.

Definition at line 197 of file manifold_lib.cc.

## ◆ push_forward() [1/2]

template<int dim, int spacedim>
 Point< spacedim > PolarManifold< dim, spacedim >::push_forward ( const Point< spacedim > & chart_point ) const
overridevirtual

Given a point in the spherical coordinate system, this method returns the Euclidean coordinates associated to the polar coordinates chart_point. Only used when spacedim = 3.

Definition at line 163 of file manifold_lib.cc.

template<int dim, int spacedim>
 DerivativeForm< 1, spacedim, spacedim > PolarManifold< dim, spacedim >::push_forward_gradient ( const Point< spacedim > & chart_point ) const
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.

Definition at line 236 of file manifold_lib.cc.

## ◆ normal_vector() [1/3]

template<int dim, int spacedim>
 Tensor< 1, spacedim > PolarManifold< dim, spacedim >::normal_vector ( const typename Triangulation< dim, spacedim >::face_iterator & face, const Point< spacedim > & p ) const
overridevirtual

Return the normal vector to a face embedded in this manifold, at the point p. If p is not in fact on the surface, but only close-by, 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 (spacedim-dim+1)-dimensional tangent space of vectors that are all both normal to the face and normal to the dim-dimensional surface that lives in spacedim-dimensional space. For example, think of a two-dimensional mesh that covers a two-dimensional surface in three-dimensional space. In that case, each face (edge) is one-dimensional, 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).

Note
In 2d, the default implementation of this function computes the normal vector by taking the tangent direction from p to the further one of the two vertices that make up an edge, and then rotates it outward (with respect to the coordinate system of the edge) by 90 degrees. In 3d, the default implementation is more complicated, aiming at avoiding problems with numerical round-off for points close to one of the vertices, and avoiding tangent directions that are linearly dependent.

Reimplemented from Manifold< dim, spacedim >.

Definition at line 325 of file manifold_lib.cc.

## ◆ get_periodicity() [1/2]

template<int dim, int spacedim>
 Tensor< 1, spacedim > PolarManifold< dim, spacedim >::get_periodicity ( )
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.

## ◆ get_intermediate_point()

 Point< spacedim > ChartManifold< dim, spacedim, chartdim >::get_intermediate_point ( const Point< spacedim > & p1, const Point< spacedim > & p2, const double w ) const
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 984 of file manifold.cc.

## ◆ get_new_point()

 Point< spacedim > ChartManifold< dim, spacedim, chartdim >::get_new_point ( const ArrayView< const Point< spacedim >> & surrounding_points, const ArrayView< const double > & weights ) const
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 999 of file manifold.cc.

## ◆ get_new_points()

 void ChartManifold< dim, spacedim, chartdim >::get_new_points ( const ArrayView< const Point< spacedim >> & surrounding_points, const Table< 2, double > & weights, ArrayView< Point< spacedim >> new_points ) const
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 non-trivial manifolds.

Reimplemented from Manifold< dim, spacedim >.

Definition at line 1020 of file manifold.cc.

## ◆ push_forward() [2/2]

 virtual Point ChartManifold< dim, spacedim, chartdim >::push_forward ( const Point< chartdim > & chart_point ) const
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.

 DerivativeForm< 1, chartdim, spacedim > ChartManifold< dim, spacedim, chartdim >::push_forward_gradient ( const Point< chartdim > & chart_point ) const
virtualinherited

Given a point in the chartdim dimensional Euclidean space, this method returns the derivatives of the function $$F$$ that maps from the chartdim-dimensional to the spacedim-dimensional 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.

Definition at line 1049 of file manifold.cc.

## ◆ get_tangent_vector()

 Tensor< 1, spacedim > ChartManifold< dim, spacedim, chartdim >::get_tangent_vector ( const Point< spacedim > & x1, const Point< spacedim > & x2 ) const
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 pre-images of x1 and x2 (where pre-images 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 chartdim-dimensional 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 push-forward mapping. Here, $$F^{-1}(\mathbf x_2)-F^{-1}(\mathbf x_1)$$ is a chartdim-dimensional vector, and $$\nabla_\xi F\left(F^{-1}(\mathbf x_1)\right) = \nabla_\xi F\left(\xi_1\right)$$ is a spacedim-times-chartdim-dimensional matrix. Consequently, and as desired, the operation results in a spacedim-dimensional vector.

Parameters
 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.
Returns
A "direction" vector tangential to the geodesic.

Reimplemented from Manifold< dim, spacedim >.

Definition at line 1062 of file manifold.cc.

## ◆ get_periodicity() [2/2]

 const Tensor< 1, chartdim > & ChartManifold< dim, spacedim, chartdim >::get_periodicity ( ) const
inherited

Return the periodicity associated with the submanifold.

Definition at line 1094 of file manifold.cc.

## ◆ project_to_manifold()

template<int dim, int spacedim>
 Point< spacedim > Manifold< dim, spacedim >::project_to_manifold ( const ArrayView< const Point< spacedim >> & surrounding_points, const Point< spacedim > & candidate ) const
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.

Definition at line 40 of file manifold.cc.

## ◆ get_new_point_on_line()

template<int dim, int spacedim>
 Point< spacedim > Manifold< dim, spacedim >::get_new_point_on_line ( const typename Triangulation< dim, spacedim >::line_iterator & line ) const
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().

Definition at line 318 of file manifold.cc.

template<int dim, int spacedim>
 Point< spacedim > Manifold< dim, spacedim >::get_new_point_on_quad ( const typename Triangulation< dim, spacedim >::quad_iterator & quad ) const
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().

Definition at line 332 of file manifold.cc.

template<>
 Point< 1 > Manifold< 1, 1 >::get_new_point_on_quad ( const Triangulation< 1, 1 >::quad_iterator & ) const
inherited

Definition at line 419 of file manifold.cc.

template<>
 Point< 2 > Manifold< 1, 2 >::get_new_point_on_quad ( const Triangulation< 1, 2 >::quad_iterator & ) const
inherited

Definition at line 430 of file manifold.cc.

template<>
 Point< 3 > Manifold< 1, 3 >::get_new_point_on_quad ( const Triangulation< 1, 3 >::quad_iterator & ) const
inherited

Definition at line 441 of file manifold.cc.

## ◆ get_new_point_on_hex() [1/2]

template<int dim, int spacedim>
 Point< spacedim > Manifold< dim, spacedim >::get_new_point_on_hex ( const typename Triangulation< dim, spacedim >::hex_iterator & hex ) const
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().

Definition at line 452 of file manifold.cc.

## ◆ get_new_point_on_hex() [2/2]

template<>
 Point< 3 > Manifold< 3, 3 >::get_new_point_on_hex ( const Triangulation< 3, 3 >::hex_iterator & hex ) const
inherited

Definition at line 463 of file manifold.cc.

## ◆ get_new_point_on_face() [1/4]

template<int dim, int spacedim>
 Point< spacedim > Manifold< dim, spacedim >::get_new_point_on_face ( const typename Triangulation< dim, spacedim >::face_iterator & face ) const
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.

Definition at line 346 of file manifold.cc.

## ◆ get_new_point_on_face() [2/4]

template<>
 Point< 1 > Manifold< 1, 1 >::get_new_point_on_face ( const Triangulation< 1, 1 >::face_iterator & ) const
inherited

Definition at line 386 of file manifold.cc.

## ◆ get_new_point_on_face() [3/4]

template<>
 Point< 2 > Manifold< 1, 2 >::get_new_point_on_face ( const Triangulation< 1, 2 >::face_iterator & ) const
inherited

Definition at line 397 of file manifold.cc.

## ◆ get_new_point_on_face() [4/4]

template<>
 Point< 3 > Manifold< 1, 3 >::get_new_point_on_face ( const Triangulation< 1, 3 >::face_iterator & ) const
inherited

Definition at line 408 of file manifold.cc.

## ◆ get_new_point_on_cell()

template<int dim, int spacedim>
 Point< spacedim > Manifold< dim, spacedim >::get_new_point_on_cell ( const typename Triangulation< dim, spacedim >::cell_iterator & cell ) const
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.

Definition at line 366 of file manifold.cc.

## ◆ normal_vector() [2/3]

template<>
 Tensor< 1, 2 > Manifold< 2, 2 >::normal_vector ( const Triangulation< 2, 2 >::face_iterator & face, const Point< 2 > & p ) const
inherited

Definition at line 145 of file manifold.cc.

## ◆ normal_vector() [3/3]

template<>
 Tensor< 1, 3 > Manifold< 3, 3 >::normal_vector ( const Triangulation< 3, 3 >::face_iterator & face, const Point< 3 > & p ) const
inherited

Definition at line 166 of file manifold.cc.

## ◆ get_normals_at_vertices() [1/3]

template<int dim, int spacedim>
 void Manifold< dim, spacedim >::get_normals_at_vertices ( const typename Triangulation< dim, spacedim >::face_iterator & face, FaceVertexNormals & face_vertex_normals ) const
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 one-sided limits, i.e. limit with respect to points inside the given face.

Definition at line 303 of file manifold.cc.

## ◆ get_normals_at_vertices() [2/3]

template<>
 void Manifold< 2, 2 >::get_normals_at_vertices ( const Triangulation< 2, 2 >::face_iterator & face, FaceVertexNormals & n ) const
inherited

Definition at line 251 of file manifold.cc.

## ◆ get_normals_at_vertices() [3/3]

template<>
 void Manifold< 3, 3 >::get_normals_at_vertices ( const Triangulation< 3, 3 >::face_iterator & face, FaceVertexNormals & n ) const
inherited

Definition at line 273 of file manifold.cc.

## ◆ subscribe()

 void Subscriptor::subscribe ( std::atomic< bool > *const validity, const std::string & identifier = "" ) const
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 136 of file subscriptor.cc.

## ◆ unsubscribe()

 void Subscriptor::unsubscribe ( std::atomic< bool > *const validity, const std::string & identifier = "" ) const
inherited

Unsubscribes a user from the object.

Note
The identifier and the validity pointer must be the same as the one supplied to subscribe().

Definition at line 156 of file subscriptor.cc.

## ◆ n_subscriptions()

 unsigned int Subscriptor::n_subscriptions ( ) const
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 301 of file subscriptor.h.

## ◆ list_subscribers() [1/2]

template<typename StreamType >
 void Subscriptor::list_subscribers ( StreamType & stream ) const
inlineinherited

List the subscribers to the input stream.

Definition at line 318 of file subscriptor.h.

## ◆ list_subscribers() [2/2]

 void Subscriptor::list_subscribers ( ) const
inherited

List the subscribers to deallog.

Definition at line 204 of file subscriptor.cc.

## ◆ serialize()

template<class Archive >
 void Subscriptor::serialize ( Archive & ar, const unsigned int version )
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 310 of file subscriptor.h.

## ◆ center

template<int dim, int spacedim = dim>
 const Point PolarManifold< dim, spacedim >::center

The center of the spherical coordinate system.

Definition at line 131 of file manifold_lib.h.

The documentation for this class was generated from the following files: