Reference documentation for deal.II version GIT 9c182271f7 2023-03-28 14:30:01+00:00
OpenCASCADE::ArclengthProjectionLineManifold< dim, spacedim > Class Template Referenceabstract

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

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

## Public Types

using FaceVertexNormals = std::array< Tensor< 1, spacedim >, GeometryInfo< dim >::vertices_per_face >

## Public Member Functions

ArclengthProjectionLineManifold (const TopoDS_Shape &sh, const double tolerance=1e-7)

virtual std::unique_ptr< Manifold< dim, spacedim > > clone () const override

virtual Point< 1 > pull_back (const Point< spacedim > &space_point) const override

virtual Point< spacedim > push_forward (const Point< 1 > &chart_point) 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

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

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

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

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

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

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

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

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 Tensor< 1, spacedim > normal_vector (const typename Triangulation< dim, spacedim >::face_iterator &face, const Point< spacedim > &p) const

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)

## Protected Attributes

const TopoDS_Shape sh

const double tolerance

const double length

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

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

## Detailed Description

### template<int dim, int spacedim> class OpenCASCADE::ArclengthProjectionLineManifold< dim, spacedim >

A Manifold object based on OpenCASCADE TopoDS_Shape objects which have topological dimension equal to one (TopoDS_Edge or TopoDS_Wire) where new points are located at the arclength average of the surrounding points. If the given TopoDS_Shape can be casted to a periodic (closed) curve, then this information is used internally to set the periodicity of the base ChartManifold class.

This class can only work on TopoDS_Edge or TopoDS_Wire objects, and it only makes sense when spacedim is three. If you use an object of topological dimension different from one, an exception is throw.

In debug mode there is an additional sanity check to make sure that the surrounding points actually live on the Manifold, i.e., calling OpenCASCADE::closest_point() on those points leaves them untouched. If this is not the case, an ExcPointNotOnManifold is thrown.

Definition at line 291 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 306 of file manifold.h.

## ◆ map_value_type

 using Subscriptor::map_value_type = decltype(counter_map)::value_type
privateinherited

The data type used in counter_map.

Definition at line 230 of file subscriptor.h.

## ◆ map_iterator

 using Subscriptor::map_iterator = decltype(counter_map)::iterator
privateinherited

The iterator type used in counter_map.

Definition at line 235 of file subscriptor.h.

## ◆ ArclengthProjectionLineManifold()

template<int dim, int spacedim>
 OpenCASCADE::ArclengthProjectionLineManifold< dim, spacedim >::ArclengthProjectionLineManifold ( const TopoDS_Shape & sh, const double tolerance = 1e-7 )

Default constructor with a TopoDS_Edge.

Definition at line 408 of file manifold_lib.cc.

## ◆ clone()

template<int dim, int spacedim>
 std::unique_ptr< Manifold< dim, spacedim > > OpenCASCADE::ArclengthProjectionLineManifold< dim, spacedim >::clone
overridevirtual

Clone the current Manifold.

Implements Manifold< dim, spacedim >.

Definition at line 427 of file manifold_lib.cc.

## ◆ pull_back()

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

Given a point on real space, find its arclength parameter. Throws an error in debug mode, if the point is not on the TopoDS_Edge given at construction time.

Implements ChartManifold< dim, spacedim, 1 >.

Definition at line 437 of file manifold_lib.cc.

## ◆ push_forward() [1/2]

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

Given an arclength parameter, find its image in real space.

Definition at line 467 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 937 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 946 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 971 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 1009 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 1067 of file manifold.cc.

## ◆ get_periodicity()

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

Return the periodicity associated with the submanifold.

Definition at line 1074 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 38 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 352 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 366 of file manifold.cc.

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

Definition at line 453 of file manifold.cc.

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

Definition at line 464 of file manifold.cc.

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

Definition at line 475 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 486 of file manifold.cc.

## ◆ get_new_point_on_hex() [2/2]

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

Definition at line 497 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 380 of file manifold.cc.

## ◆ get_new_point_on_face() [2/4]

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

Definition at line 420 of file manifold.cc.

## ◆ get_new_point_on_face() [3/4]

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

Definition at line 431 of file manifold.cc.

## ◆ get_new_point_on_face() [4/4]

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

Definition at line 442 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 400 of file manifold.cc.

## ◆ normal_vector() [1/3]

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

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

Definition at line 273 of file manifold.cc.

## ◆ normal_vector() [2/3]

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

Definition at line 143 of file manifold.cc.

## ◆ normal_vector() [3/3]

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

Definition at line 164 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 337 of file manifold.cc.

## ◆ get_normals_at_vertices() [2/3]

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

Definition at line 285 of file manifold.cc.

## ◆ get_normals_at_vertices() [3/3]

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

Definition at line 307 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 300 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 317 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 309 of file subscriptor.h.

## ◆ check_no_subscribers()

 void Subscriptor::check_no_subscribers ( ) const
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.

Note
Since this function is just a consistency check it does nothing in release mode.
If this function is called when there is an uncaught exception then, rather than aborting, this function prints an error message to the standard error stream and returns.

Definition at line 53 of file subscriptor.cc.

## ◆ sh

template<int dim, int spacedim>
 const TopoDS_Shape OpenCASCADE::ArclengthProjectionLineManifold< dim, spacedim >::sh
protected

The actual shape used to build this object.

Definition at line 324 of file manifold_lib.h.

## ◆ curve

template<int dim, int spacedim>
protected

A Curve adaptor. This is the one which is used in the computations, and it points to the right one above.

Definition at line 331 of file manifold_lib.h.

## ◆ tolerance

template<int dim, int spacedim>
 const double OpenCASCADE::ArclengthProjectionLineManifold< dim, spacedim >::tolerance
protected

Relative tolerance used in all internal computations.

Definition at line 339 of file manifold_lib.h.

## ◆ length

template<int dim, int spacedim>
 const double OpenCASCADE::ArclengthProjectionLineManifold< dim, spacedim >::length
protected

The total length of the curve. This is also used as a period if the edge is periodic.

Definition at line 345 of file manifold_lib.h.

## ◆ sub_manifold

 const FlatManifold ChartManifold< dim, spacedim, chartdim >::sub_manifold
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 1088 of file manifold.h.

## ◆ counter

 std::atomic Subscriptor::counter
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 219 of file subscriptor.h.

## ◆ counter_map

 std::map Subscriptor::counter_map
mutableprivateinherited

In this map, we count subscriptions for each different identification string supplied to subscribe().

Definition at line 225 of file subscriptor.h.

## ◆ validity_pointers

 std::vector *> Subscriptor::validity_pointers
mutableprivateinherited

In this vector, we store pointers to the validity bool in the SmartPointer objects that subscribe to this class.

Definition at line 241 of file subscriptor.h.

## ◆ object_info

 const std::type_info* Subscriptor::object_info
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 249 of file subscriptor.h.

## ◆ mutex

 std::mutex Subscriptor::mutex
staticprivateinherited

A mutex used to ensure data consistency when printing out the list of subscribers.

Definition at line 271 of file subscriptor.h.

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