Skip to content
Snippets Groups Projects
Commit a7dacf6a authored by Dmitri Naumov's avatar Dmitri Naumov
Browse files

[MeL] Document isPntInElement nodes param. copydoc

Extend and unify documentation, fix function's argument name.
parent 7d283243
No related branches found
No related tags found
No related merge requests found
...@@ -80,12 +80,11 @@ public: ...@@ -80,12 +80,11 @@ public:
static const Element* getFace(const Element* e, unsigned i); static const Element* getFace(const Element* e, unsigned i);
/** /**
* Checks if a point is inside the element. * \copydoc MeshLib::Element::isPntInElement()
* @param pnt a 3D MathLib::Point3D object * @param nodes the nodes of the element.
* @param eps tolerance for numerical algorithm used or computing the property
* @return true if the point is not outside the element, false otherwise
*/ */
static bool isPntInElement(Node const* const* _nodes, MathLib::Point3d const& pnt, double eps); static bool isPntInElement(Node const* const* nodes,
MathLib::Point3d const& pnt, double eps);
/** /**
* Tests if the element is geometrically valid. * Tests if the element is geometrically valid.
......
...@@ -49,12 +49,11 @@ public: ...@@ -49,12 +49,11 @@ public:
typedef LinearEdgeReturn EdgeReturn; typedef LinearEdgeReturn EdgeReturn;
/** /**
* Checks if a point is inside the element. * \copydoc MeshLib::Element::isPntInElement()
* @param pnt a 3D MathLib::Point3d object * @param nodes the nodes of the element.
* @param eps tolerance for numerical algorithm used or computing the property
* @return true if the point is not outside the element, false otherwise
*/ */
static bool isPntInElement(Node const* const* _nodes, MathLib::Point3d const& pnt, double eps); static bool isPntInElement(Node const* const* nodes,
MathLib::Point3d const& pnt, double eps);
/** /**
* Tests if the element is geometrically valid. * Tests if the element is geometrically valid.
......
...@@ -43,16 +43,13 @@ public: ...@@ -43,16 +43,13 @@ public:
/// Edge rule /// Edge rule
typedef NoEdgeReturn EdgeReturn; typedef NoEdgeReturn EdgeReturn;
/// Checks if a point is inside the element. /// \copydoc MeshLib::Element::isPntInElement()
/// ///
/// Specifically this function tests if the squared euclidean distance /// Specifically this function tests if the squared euclidean distance
/// between the points \c _nodes and \c pnt is less then \c eps. /// between the points \c nodes and \c pnt is less then \c eps.
/// ///
/// \param pnt a 3D MathLib::Point3d object /// @param nodes the nodes of the element.
/// \param eps tolerance for numerical algorithm used for computing the static bool isPntInElement(Node const* const* nodes,
/// property
/// \return true if the point is not outside the element, false otherwise
static bool isPntInElement(Node const* const* _nodes,
MathLib::Point3d const& pnt, double eps); MathLib::Point3d const& pnt, double eps);
/// Tests if the element is geometrically valid. /// Tests if the element is geometrically valid.
......
...@@ -81,12 +81,11 @@ public: ...@@ -81,12 +81,11 @@ public:
static const Element* getFace(const Element* e, unsigned i); static const Element* getFace(const Element* e, unsigned i);
/** /**
* Checks if a point is inside the element. * \copydoc MeshLib::Element::isPntInElement()
* @param pnt a 3D MathLib::Point3d object * @param nodes the nodes of the element.
* @param eps tolerance for numerical algorithm used or computing the property
* @return true if the point is not outside the element, false otherwise
*/ */
static bool isPntInElement(Node const* const* _nodes, MathLib::Point3d const& pnt, double eps); static bool isPntInElement(Node const* const* nodes,
MathLib::Point3d const& pnt, double eps);
/** /**
* Tests if the element is geometrically valid. * Tests if the element is geometrically valid.
......
...@@ -80,12 +80,11 @@ public: ...@@ -80,12 +80,11 @@ public:
static const Element* getFace(const Element* e, unsigned i); static const Element* getFace(const Element* e, unsigned i);
/** /**
* Checks if a point is inside the element. * \copydoc MeshLib::Element::isPntInElement()
* @param pnt a 3D MathLib::Point3d object * @param nodes the nodes of the element.
* @param eps tolerance for numerical algorithm used or computing the property
* @return true if the point is not outside the element, false otherwise
*/ */
static bool isPntInElement(Node const* const* _nodes, MathLib::Point3d const& pnt, double eps); static bool isPntInElement(Node const* const* nodes,
MathLib::Point3d const& pnt, double eps);
/** /**
* Tests if the element is geometrically valid. * Tests if the element is geometrically valid.
......
...@@ -62,12 +62,11 @@ public: ...@@ -62,12 +62,11 @@ public:
typedef LinearEdgeReturn EdgeReturn; typedef LinearEdgeReturn EdgeReturn;
/** /**
* Checks if a point is inside the element. * \copydoc MeshLib::Element::isPntInElement()
* @param pnt a 3D MathLib::Point3d object * @param nodes the nodes of the element.
* @param eps tolerance for numerical algorithm used or computing the property
* @return true if the point is not outside the element, false otherwise
*/ */
static bool isPntInElement(Node const* const* _nodes, MathLib::Point3d const& pnt, double eps); static bool isPntInElement(Node const* const* nodes,
MathLib::Point3d const& pnt, double eps);
/** /**
* Tests if the element is geometrically valid. * Tests if the element is geometrically valid.
......
...@@ -108,10 +108,10 @@ public: ...@@ -108,10 +108,10 @@ public:
bool isEdge(unsigned idx1, unsigned idx2) const; bool isEdge(unsigned idx1, unsigned idx2) const;
/** /**
* Checks if a point is inside the element. * \copydoc MeshLib::Element::isPntInElement()
* @param pnt a 3D MathLib::Point3d object *
* @param eps tolerance for numerical algorithm used or computing the property * This is actually calling the correct implementation of this function
* @return true if the point is not outside the element, false otherwise * passing the element's nodes.
*/ */
bool isPntInElement(MathLib::Point3d const& pnt, double eps = std::numeric_limits<double>::epsilon()) const bool isPntInElement(MathLib::Point3d const& pnt, double eps = std::numeric_limits<double>::epsilon()) const
{ {
......
...@@ -75,12 +75,11 @@ public: ...@@ -75,12 +75,11 @@ public:
static const Element* getFace(const Element* e, unsigned i); static const Element* getFace(const Element* e, unsigned i);
/** /**
* Checks if a point is inside the element. * \copydoc MeshLib::Element::isPntInElement()
* @param pnt a 3D MathLib::Point3d object * @param nodes the nodes of the element.
* @param eps tolerance for numerical algorithm used or computing the property
* @return true if the point is not outside the element, false otherwise
*/ */
static bool isPntInElement(Node const* const* _nodes, MathLib::Point3d const& pnt, double eps); static bool isPntInElement(Node const* const* nodes,
MathLib::Point3d const& pnt, double eps);
/** /**
* Tests if the element is geometrically valid. * Tests if the element is geometrically valid.
......
...@@ -63,12 +63,11 @@ public: ...@@ -63,12 +63,11 @@ public:
typedef LinearEdgeReturn EdgeReturn; typedef LinearEdgeReturn EdgeReturn;
/** /**
* Checks if a point is inside the element. * \copydoc MeshLib::Element::isPntInElement()
* @param pnt a 3D MathLib::Point3d object * @param nodes the nodes of the element.
* @param eps tolerance for numerical algorithm used or computing the property
* @return true if the point is not outside the element, false otherwise
*/ */
static bool isPntInElement(Node const* const* _nodes, MathLib::Point3d const& pnt, double eps); static bool isPntInElement(Node const* const* nodes,
MathLib::Point3d const& pnt, double eps);
/** /**
* Tests if the element is geometrically valid. * Tests if the element is geometrically valid.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment