Reference documentation for deal.II version 8.1.0
Public Member Functions | Protected Attributes | Private Member Functions | Static Private Member Functions | List of all members
CylinderBoundary< dim, spacedim > Class Template Reference

#include <tria_boundary_lib.h>

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

Public Member Functions

 CylinderBoundary (const double radius=1.0, const unsigned int axis=0)
 
 CylinderBoundary (const double radius, const Point< spacedim > &direction, const Point< spacedim > &point_on_axis)
 
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 void get_intermediate_points_on_line (const typename Triangulation< dim, spacedim >::line_iterator &line, std::vector< Point< spacedim > > &points) const
 
virtual void get_intermediate_points_on_quad (const typename Triangulation< dim, spacedim >::quad_iterator &quad, std::vector< Point< spacedim > > &points) const
 
virtual void get_normals_at_vertices (const typename Triangulation< dim, spacedim >::face_iterator &face, typename Boundary< dim, spacedim >::FaceVertexNormals &face_vertex_normals) const
 
double get_radius () const
 
 DeclException0 (ExcRadiusNotSet)
 
- Public Member Functions inherited from StraightBoundary< dim, spacedim >
 StraightBoundary ()
 
virtual Tensor< 1, spacedim > normal_vector (const typename Triangulation< dim, spacedim >::face_iterator &face, const Point< spacedim > &p) const
 
virtual Point< spacedim > project_to_surface (const typename Triangulation< dim, spacedim >::line_iterator &line, const Point< spacedim > &candidate) const
 
virtual Point< spacedim > project_to_surface (const typename Triangulation< dim, spacedim >::quad_iterator &quad, const Point< spacedim > &candidate) const
 
virtual Point< spacedim > project_to_surface (const typename Triangulation< dim, spacedim >::hex_iterator &hex, const Point< spacedim > &candidate) const
 
- Public Member Functions inherited from Boundary< dim, spacedim >
virtual ~Boundary ()
 
Point< spacedim > get_new_point_on_face (const typename Triangulation< dim, spacedim >::face_iterator &face) const
 
void get_intermediate_points_on_face (const typename Triangulation< dim, spacedim >::face_iterator &face, std::vector< Point< spacedim > > &points) const
 
virtual void get_normals_at_vertices (const typename Triangulation< dim, spacedim >::face_iterator &face, FaceVertexNormals &face_vertex_normals) const
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
void subscribe (const char *identifier=0) const
 
void unsubscribe (const char *identifier=0) const
 
unsigned int n_subscriptions () const
 
void list_subscribers () const
 
 DeclException3 (ExcInUse, int, char *, std::string &,<< "Object of class "<< arg2<< " is still used by "<< arg1<< " other objects.\n"<< "(Additional information: "<< arg3<< ")\n"<< "Note the entry in the Frequently Asked Questions of "<< "deal.II (linked to from http://www.dealii.org/) for "<< "more information on what this error means.")
 
 DeclException2 (ExcNoSubscriber, char *, char *,<< "No subscriber with identifier \""<< arg2<< "\" did subscribe to this object of class "<< arg1)
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Protected Attributes

const double radius
 
const Point< spacedim > direction
 
const Point< spacedim > point_on_axis
 

Private Member Functions

void get_intermediate_points_between_points (const Point< spacedim > &p0, const Point< spacedim > &p1, std::vector< Point< spacedim > > &points) const
 

Static Private Member Functions

static Point< spacedim > get_axis_vector (const unsigned int axis)
 

Additional Inherited Members

- Public Types inherited from Boundary< dim, spacedim >
typedef Tensor< 1, spacedim > FaceVertexNormals[GeometryInfo< dim >::vertices_per_face]
 
- Protected Member Functions inherited from Boundary< dim, spacedim >
const std::vector< Point< 1 > > & get_line_support_points (const unsigned int n_intermediate_points) const
 

Detailed Description

template<int dim, int spacedim = dim>
class CylinderBoundary< dim, spacedim >

Boundary object for the hull of a cylinder. In three dimensions, points are projected on a circular tube along the x-, y- or z-axis (when using the first constructor of this class), or an arbitrarily oriented cylinder described by the direction of its axis and a point located on the axis. The radius of the tube can be given independently. Similar to HyperBallBoundary, new points are projected by dividing the straight line between the old two points and adjusting the radius from the axis.

This class was developed to be used in conjunction with the cylinder function of GridGenerator. It should be used for the hull of the cylinder only (boundary indicator 0). Its use is discussed in detail in the results section of step-49.

This class is derived from StraightBoundary rather than from Boundary, which would seem natural, since this way we can use the StraightBoundary::in_between() function.

Author
Guido Kanschat, 2001, Wolfgang Bangerth, 2007

Definition at line 51 of file tria_boundary_lib.h.

Constructor & Destructor Documentation

template<int dim, int spacedim = dim>
CylinderBoundary< dim, spacedim >::CylinderBoundary ( const double  radius = 1.0,
const unsigned int  axis = 0 
)

Constructor. Using default values for the constructor arguments yields a circular tube along the x-axis (axis=0). Choose axis=1 or axis=2 for a tube along the y- or z-axis, respectively.

template<int dim, int spacedim = dim>
CylinderBoundary< dim, spacedim >::CylinderBoundary ( const double  radius,
const Point< spacedim > &  direction,
const Point< spacedim > &  point_on_axis 
)

Constructor. If constructed with this constructor, the boundary described is a cylinder with an axis that points in direction direction and goes through the given point_on_axis. The direction may be arbitrarily scaled, and the given point may be any point on the axis.

Member Function Documentation

template<int dim, int spacedim = dim>
virtual Point<spacedim> CylinderBoundary< dim, spacedim >::get_new_point_on_line ( const typename Triangulation< dim, spacedim >::line_iterator &  line) const
virtual

Refer to the general documentation of this class and the documentation of the base class.

Reimplemented from StraightBoundary< dim, spacedim >.

template<int dim, int spacedim = dim>
virtual Point<spacedim> CylinderBoundary< dim, spacedim >::get_new_point_on_quad ( const typename Triangulation< dim, spacedim >::quad_iterator &  quad) const
virtual

Refer to the general documentation of this class and the documentation of the base class.

Reimplemented from StraightBoundary< dim, spacedim >.

template<int dim, int spacedim = dim>
virtual void CylinderBoundary< dim, spacedim >::get_intermediate_points_on_line ( const typename Triangulation< dim, spacedim >::line_iterator &  line,
std::vector< Point< spacedim > > &  points 
) const
virtual

Refer to the general documentation of this class and the documentation of the base class.

Calls get_intermediate_points_between_points.

Reimplemented from StraightBoundary< dim, spacedim >.

template<int dim, int spacedim = dim>
virtual void CylinderBoundary< dim, spacedim >::get_intermediate_points_on_quad ( const typename Triangulation< dim, spacedim >::quad_iterator &  quad,
std::vector< Point< spacedim > > &  points 
) const
virtual

Refer to the general documentation of this class and the documentation of the base class.

Only implemented for dim=3 and for points.size()==1.

Reimplemented from StraightBoundary< dim, spacedim >.

template<int dim, int spacedim = dim>
virtual void CylinderBoundary< dim, spacedim >::get_normals_at_vertices ( const typename Triangulation< dim, spacedim >::face_iterator &  face,
typename Boundary< dim, spacedim >::FaceVertexNormals face_vertex_normals 
) const
virtual

Compute the normals to the boundary at the vertices of the given face.

Refer to the general documentation of this class and the documentation of the base class.

Reimplemented from StraightBoundary< dim, spacedim >.

template<int dim, int spacedim = dim>
double CylinderBoundary< dim, spacedim >::get_radius ( ) const

Return the radius of the cylinder.

template<int dim, int spacedim = dim>
CylinderBoundary< dim, spacedim >::DeclException0 ( ExcRadiusNotSet  )

Exception. Thrown by the get_radius if the compute_radius_automatically, see below, flag is set true.

template<int dim, int spacedim = dim>
void CylinderBoundary< dim, spacedim >::get_intermediate_points_between_points ( const Point< spacedim > &  p0,
const Point< spacedim > &  p1,
std::vector< Point< spacedim > > &  points 
) const
private

Called by get_intermediate_points_on_line and by get_intermediate_points_on_quad.

Refer to the general documentation of get_intermediate_points_on_line in the documentation of the base class.

template<int dim, int spacedim = dim>
static Point<spacedim> CylinderBoundary< dim, spacedim >::get_axis_vector ( const unsigned int  axis)
staticprivate

Given a number for the axis, return a vector that denotes this direction.

Member Data Documentation

template<int dim, int spacedim = dim>
const double CylinderBoundary< dim, spacedim >::radius
protected

Radius of the cylinder.

Definition at line 152 of file tria_boundary_lib.h.

template<int dim, int spacedim = dim>
const Point<spacedim> CylinderBoundary< dim, spacedim >::direction
protected

The direction vector of the axis.

Definition at line 157 of file tria_boundary_lib.h.

template<int dim, int spacedim = dim>
const Point<spacedim> CylinderBoundary< dim, spacedim >::point_on_axis
protected

An arbitrary point on the axis.

Definition at line 162 of file tria_boundary_lib.h.


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