Documentation (as a template dummy class) of Geometry_traits. More...
#include <Geometry_traits.h>
Collaboration diagram for FEVV::Geometry_traits_documentation_dummy< MeshT, KernelT >:
Public Types | |
| typedef MeshT | Mesh |
| Unused internaly but nice to embed for unforseen caller usage. More... | |
| typedef KernelT | Kernel |
| Unused internaly but nice to embed for unforseen caller usage. More... | |
| typedef Kernel::Point | Point |
| typedef Kernel::Normal | Vector |
| typedef Kernel::Scalar | Scalar |
Public Member Functions | |
| Scalar | get_x (const Point &p1) |
| Returns the normal of the three argument points (implemented as get_x() free function . More... | |
| Scalar | get_y (const Point &p1) |
| Returns the normal of the three argument points (implemented as get_y() free function . More... | |
| Scalar | get_z (const Point &p1) |
| Returns the normal of the three argument points (implemented as get_z() free function . More... | |
| Vector | normalize (const Vector &v) |
| Returns the normalization of vector 'v'. More... | |
| Scalar | length2 (const Vector &v) |
| Returns the square of the length of vector v. More... | |
| Scalar | length (const Vector &v) |
| Returns the length of vector v. More... | |
| Scalar | length (const Point &p, const Point &q) |
| Returns the distance between points p and q. More... | |
| Vector | normal (const Point &p, const Point &q, const Point &r) |
| Returns a vector that is normal to the plane passing through points p, q and r. More... | |
| Vector | unit_normal (const Point &p, const Point &q, const Point &r) |
| Returns a unit vector that is normal to the plane passing through points p, q and r. More... | |
| Vector | add_v (const Vector &u, const Vector &v) |
| Returns the sum of vectors u and v. More... | |
| Vector | add_pv (const Point &p, const Vector &v) |
| Returns the sum of point p and vector v. More... | |
| Vector | sub_pv (const Point &p, const Vector &v) |
| Returns the subtraction of vector v from point p. More... | |
| Vector | sub_p (const Point &p, const Point &q) |
| Returns the vector from point q to point p. More... | |
| Vector | sub_v (const Vector &u, const Vector &v) |
| Returns the subtraction of vector v from vector u. More... | |
| Vector | scalar_mult (const Vector &v, Scalar s) |
| Returns the multiplication of vector v by scalar s. More... | |
| Scalar | dot_product (const Vector &u, const Vector &v) |
| Returns the dot product of vectors u and v. More... | |
| Vector | cross_product (const Vector &u, const Vector &v) |
| Returns the cross product of vectors u and v. More... | |
Static Public Attributes | |
| static const Point | ORIGIN |
| The point at the origin. More... | |
| static const Vector | NULL_VECTOR |
| The zero length vector. More... | |
Detailed Description
template<typename MeshT, typename KernelT>
class FEVV::Geometry_traits_documentation_dummy< MeshT, KernelT >
Documentation (as a template dummy class) of Geometry_traits.
- Template Parameters
-
MeshT refer to Geometry_traits template parameters documentation KernelT refer to Geometry_traits template parameters documentation
Definition at line 175 of file Geometry_traits.h.
Member Typedef Documentation
◆ Kernel
template<typename MeshT , typename KernelT >
| typedef KernelT FEVV::Geometry_traits_documentation_dummy< MeshT, KernelT >::Kernel |
Unused internaly but nice to embed for unforseen caller usage.
Definition at line 181 of file Geometry_traits.h.
◆ Mesh
template<typename MeshT , typename KernelT >
| typedef MeshT FEVV::Geometry_traits_documentation_dummy< MeshT, KernelT >::Mesh |
Unused internaly but nice to embed for unforseen caller usage.
Definition at line 179 of file Geometry_traits.h.
◆ Point
template<typename MeshT , typename KernelT >
| typedef Kernel::Point FEVV::Geometry_traits_documentation_dummy< MeshT, KernelT >::Point |
Definition at line 182 of file Geometry_traits.h.
◆ Scalar
template<typename MeshT , typename KernelT >
| typedef Kernel::Scalar FEVV::Geometry_traits_documentation_dummy< MeshT, KernelT >::Scalar |
Definition at line 184 of file Geometry_traits.h.
◆ Vector
template<typename MeshT , typename KernelT >
| typedef Kernel::Normal FEVV::Geometry_traits_documentation_dummy< MeshT, KernelT >::Vector |
Definition at line 183 of file Geometry_traits.h.
Member Function Documentation
◆ add_pv()
template<typename MeshT , typename KernelT >
| Vector FEVV::Geometry_traits_documentation_dummy< MeshT, KernelT >::add_pv | ( | const Point & | p, |
| const Vector & | v | ||
| ) |
Returns the sum of point p and vector v.
◆ add_v()
template<typename MeshT , typename KernelT >
| Vector FEVV::Geometry_traits_documentation_dummy< MeshT, KernelT >::add_v | ( | const Vector & | u, |
| const Vector & | v | ||
| ) |
Returns the sum of vectors u and v.
◆ cross_product()
template<typename MeshT , typename KernelT >
| Vector FEVV::Geometry_traits_documentation_dummy< MeshT, KernelT >::cross_product | ( | const Vector & | u, |
| const Vector & | v | ||
| ) |
Returns the cross product of vectors u and v.
◆ dot_product()
template<typename MeshT , typename KernelT >
| Scalar FEVV::Geometry_traits_documentation_dummy< MeshT, KernelT >::dot_product | ( | const Vector & | u, |
| const Vector & | v | ||
| ) |
Returns the dot product of vectors u and v.
◆ get_x()
template<typename MeshT , typename KernelT >
| Scalar FEVV::Geometry_traits_documentation_dummy< MeshT, KernelT >::get_x | ( | const Point & | p1 | ) |
Returns the normal of the three argument points (implemented as get_x() free function .
◆ get_y()
template<typename MeshT , typename KernelT >
| Scalar FEVV::Geometry_traits_documentation_dummy< MeshT, KernelT >::get_y | ( | const Point & | p1 | ) |
Returns the normal of the three argument points (implemented as get_y() free function .
◆ get_z()
template<typename MeshT , typename KernelT >
| Scalar FEVV::Geometry_traits_documentation_dummy< MeshT, KernelT >::get_z | ( | const Point & | p1 | ) |
Returns the normal of the three argument points (implemented as get_z() free function .
◆ length() [1/2]
template<typename MeshT , typename KernelT >
| Scalar FEVV::Geometry_traits_documentation_dummy< MeshT, KernelT >::length | ( | const Point & | p, |
| const Point & | q | ||
| ) |
Returns the distance between points p and q.
◆ length() [2/2]
template<typename MeshT , typename KernelT >
| Scalar FEVV::Geometry_traits_documentation_dummy< MeshT, KernelT >::length | ( | const Vector & | v | ) |
Returns the length of vector v.
◆ length2()
template<typename MeshT , typename KernelT >
| Scalar FEVV::Geometry_traits_documentation_dummy< MeshT, KernelT >::length2 | ( | const Vector & | v | ) |
Returns the square of the length of vector v.
◆ normal()
template<typename MeshT , typename KernelT >
| Vector FEVV::Geometry_traits_documentation_dummy< MeshT, KernelT >::normal | ( | const Point & | p, |
| const Point & | q, | ||
| const Point & | r | ||
| ) |
Returns a vector that is normal to the plane passing through points p, q and r.
◆ normalize()
template<typename MeshT , typename KernelT >
| Vector FEVV::Geometry_traits_documentation_dummy< MeshT, KernelT >::normalize | ( | const Vector & | v | ) |
Returns the normalization of vector 'v'.
◆ scalar_mult()
template<typename MeshT , typename KernelT >
| Vector FEVV::Geometry_traits_documentation_dummy< MeshT, KernelT >::scalar_mult | ( | const Vector & | v, |
| Scalar | s | ||
| ) |
Returns the multiplication of vector v by scalar s.
◆ sub_p()
template<typename MeshT , typename KernelT >
| Vector FEVV::Geometry_traits_documentation_dummy< MeshT, KernelT >::sub_p | ( | const Point & | p, |
| const Point & | q | ||
| ) |
Returns the vector from point q to point p.
◆ sub_pv()
template<typename MeshT , typename KernelT >
| Vector FEVV::Geometry_traits_documentation_dummy< MeshT, KernelT >::sub_pv | ( | const Point & | p, |
| const Vector & | v | ||
| ) |
Returns the subtraction of vector v from point p.
◆ sub_v()
template<typename MeshT , typename KernelT >
| Vector FEVV::Geometry_traits_documentation_dummy< MeshT, KernelT >::sub_v | ( | const Vector & | u, |
| const Vector & | v | ||
| ) |
Returns the subtraction of vector v from vector u.
◆ unit_normal()
template<typename MeshT , typename KernelT >
| Vector FEVV::Geometry_traits_documentation_dummy< MeshT, KernelT >::unit_normal | ( | const Point & | p, |
| const Point & | q, | ||
| const Point & | r | ||
| ) |
Returns a unit vector that is normal to the plane passing through points p, q and r.
Member Data Documentation
◆ NULL_VECTOR
template<typename MeshT , typename KernelT >
|
static |
The zero length vector.
Definition at line 284 of file Geometry_traits.h.
◆ ORIGIN
template<typename MeshT , typename KernelT >
|
static |
The point at the origin.
Definition at line 279 of file Geometry_traits.h.
The documentation for this class was generated from the following file:
- /Users/mac/builds/efd823a3/0/MEPP-team/MEPP2/FEVV/Wrappings/Geometry_traits.h
