Public Member Functions | Static Public Member Functions | Protected Attributes | Private Member Functions | Static Private Member Functions

CylinderBoundary< dim > Class Template Reference
[Boundary description for triangulations]

Inheritance diagram for CylinderBoundary< dim >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CylinderBoundary (const double radius=1.0, const unsigned int axis=0)
 CylinderBoundary (const double radius, const Point< dim > direction, const Point< dim > point_on_axis)
virtual Point< dim > get_new_point_on_line (const typename Triangulation< dim >::line_iterator &line) const
virtual Point< dim > get_new_point_on_quad (const typename Triangulation< dim >::quad_iterator &quad) const
virtual void get_intermediate_points_on_line (const typename Triangulation< dim >::line_iterator &line, std::vector< Point< dim > > &points) const
virtual void get_intermediate_points_on_quad (const typename Triangulation< dim >::quad_iterator &quad, std::vector< Point< dim > > &points) const
virtual void get_normals_at_vertices (const typename Triangulation< dim >::face_iterator &face, typename Boundary< dim >::FaceVertexNormals &face_vertex_normals) const
double get_radius () const

Static Public Member Functions

::ExceptionBaseExcRadiusNotSet ()

Protected Attributes

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

Private Member Functions

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

Static Private Member Functions

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

Detailed Description

template<int dim>
class CylinderBoundary< dim >

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

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 45 of file tria_boundary_lib.h.


Constructor & Destructor Documentation

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

Constructor. Per default 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>
CylinderBoundary< dim >::CylinderBoundary ( const double  radius,
const Point< dim >  direction,
const Point< dim >  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>
virtual Point<dim> CylinderBoundary< dim >::get_new_point_on_line ( const typename Triangulation< dim >::line_iterator &  line ) const [virtual]

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

template<int dim>
virtual Point<dim> CylinderBoundary< dim >::get_new_point_on_quad ( const typename Triangulation< dim >::quad_iterator &  quad ) const [virtual]

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

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

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

Calls get_intermediate_points_between_points.

template<int dim>
virtual void CylinderBoundary< dim >::get_intermediate_points_on_quad ( const typename Triangulation< dim >::quad_iterator &  quad,
std::vector< Point< dim > > &  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.

template<int dim>
virtual void CylinderBoundary< dim >::get_normals_at_vertices ( const typename Triangulation< dim >::face_iterator &  face,
typename Boundary< dim >::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.

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

Return the radius of the cylinder.

template<int dim>
::ExceptionBase& CylinderBoundary< dim >::ExcRadiusNotSet (  ) [static]

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

template<int dim>
void CylinderBoundary< dim >::get_intermediate_points_between_points ( const Point< dim > &  p0,
const Point< dim > &  p1,
std::vector< Point< dim > > &  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>
static Point<dim> CylinderBoundary< dim >::get_axis_vector ( const unsigned int  axis ) [static, private]

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


Member Data Documentation

template<int dim>
const double CylinderBoundary< dim >::radius [protected]

Radius of the cylinder.

Definition at line 150 of file tria_boundary_lib.h.

template<int dim>
const Point<dim> CylinderBoundary< dim >::direction [protected]

The direction vector of the axis.

Definition at line 155 of file tria_boundary_lib.h.

template<int dim>
const Point<dim> CylinderBoundary< dim >::point_on_axis [protected]

An arbitrary point on the axis.

Definition at line 160 of file tria_boundary_lib.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

deal.II documentation generated on Fri Feb 3 2012 06:04:06 by doxygen 1.7.2