diff --git a/MeshLib/Elements/HexRule8.h b/MeshLib/Elements/HexRule8.h index 9c6bbf64ca8e99ffbe2829f8baffc2a94b89d9ba..9fcd441757147dedcaa080cb9824255b5a124ed3 100644 --- a/MeshLib/Elements/HexRule8.h +++ b/MeshLib/Elements/HexRule8.h @@ -80,12 +80,11 @@ public: static const Element* getFace(const Element* e, unsigned i); /** - * Checks if a point is inside the element. - * @param pnt a 3D MathLib::Point3D object - * @param eps tolerance for numerical algorithm used or computing the property - * @return true if the point is not outside the element, false otherwise + * \copydoc MeshLib::Element::isPntInElement() + * @param nodes the nodes of the element. */ - 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. diff --git a/MeshLib/Elements/LineRule2.h b/MeshLib/Elements/LineRule2.h index 9583918cb13f44b7c0857a4878e4a6e7b7b99b4e..ebfa3dd28614dd5c0d8a3e67f38fdb8c6deac511 100644 --- a/MeshLib/Elements/LineRule2.h +++ b/MeshLib/Elements/LineRule2.h @@ -49,12 +49,11 @@ public: typedef LinearEdgeReturn EdgeReturn; /** - * Checks if a point is inside the element. - * @param pnt a 3D MathLib::Point3d object - * @param eps tolerance for numerical algorithm used or computing the property - * @return true if the point is not outside the element, false otherwise + * \copydoc MeshLib::Element::isPntInElement() + * @param nodes the nodes of the element. */ - 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. diff --git a/MeshLib/Elements/PointRule1.h b/MeshLib/Elements/PointRule1.h index d807cea2866c61797d9e1861a6e99cfef47a9757..64a7be67ee3d09beebed48634e3fcc1655fdbd6f 100644 --- a/MeshLib/Elements/PointRule1.h +++ b/MeshLib/Elements/PointRule1.h @@ -43,16 +43,13 @@ public: /// Edge rule typedef NoEdgeReturn EdgeReturn; - /// Checks if a point is inside the element. + /// \copydoc MeshLib::Element::isPntInElement() /// /// 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 eps tolerance for numerical algorithm used for computing the - /// property - /// \return true if the point is not outside the element, false otherwise - static bool isPntInElement(Node const* const* _nodes, + /// @param nodes the nodes of the element. + static bool isPntInElement(Node const* const* nodes, MathLib::Point3d const& pnt, double eps); /// Tests if the element is geometrically valid. diff --git a/MeshLib/Elements/PrismRule6.h b/MeshLib/Elements/PrismRule6.h index 0630d52ecfe8994f218036ce8d8985f38ad0ba4e..32340a942cff66be41b582522995d3cb1665aa5a 100644 --- a/MeshLib/Elements/PrismRule6.h +++ b/MeshLib/Elements/PrismRule6.h @@ -81,12 +81,11 @@ public: static const Element* getFace(const Element* e, unsigned i); /** - * Checks if a point is inside the element. - * @param pnt a 3D MathLib::Point3d object - * @param eps tolerance for numerical algorithm used or computing the property - * @return true if the point is not outside the element, false otherwise + * \copydoc MeshLib::Element::isPntInElement() + * @param nodes the nodes of the element. */ - 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. diff --git a/MeshLib/Elements/PyramidRule5.h b/MeshLib/Elements/PyramidRule5.h index 803723984e065b4e90ba6f76f879e96e4d5d3462..48b48d81a44b6d48b90996c5dbc911031c9d64f7 100644 --- a/MeshLib/Elements/PyramidRule5.h +++ b/MeshLib/Elements/PyramidRule5.h @@ -80,12 +80,11 @@ public: static const Element* getFace(const Element* e, unsigned i); /** - * Checks if a point is inside the element. - * @param pnt a 3D MathLib::Point3d object - * @param eps tolerance for numerical algorithm used or computing the property - * @return true if the point is not outside the element, false otherwise + * \copydoc MeshLib::Element::isPntInElement() + * @param nodes the nodes of the element. */ - 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. diff --git a/MeshLib/Elements/QuadRule4.h b/MeshLib/Elements/QuadRule4.h index 8cad04ddc4e2005cadba0c3ca7e771e8b4e8a817..d8516c0cd17fdb4a305744abd9fbcdf516381464 100644 --- a/MeshLib/Elements/QuadRule4.h +++ b/MeshLib/Elements/QuadRule4.h @@ -62,12 +62,11 @@ public: typedef LinearEdgeReturn EdgeReturn; /** - * Checks if a point is inside the element. - * @param pnt a 3D MathLib::Point3d object - * @param eps tolerance for numerical algorithm used or computing the property - * @return true if the point is not outside the element, false otherwise + * \copydoc MeshLib::Element::isPntInElement() + * @param nodes the nodes of the element. */ - 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. diff --git a/MeshLib/Elements/TemplateElement.h b/MeshLib/Elements/TemplateElement.h index d93a4c95bc19de24c56b8e3083dcb6186eb78467..4885a548c40aa092d3059a608d38cf14c89c6d54 100644 --- a/MeshLib/Elements/TemplateElement.h +++ b/MeshLib/Elements/TemplateElement.h @@ -108,10 +108,10 @@ public: bool isEdge(unsigned idx1, unsigned idx2) const; /** - * Checks if a point is inside the element. - * @param pnt a 3D MathLib::Point3d object - * @param eps tolerance for numerical algorithm used or computing the property - * @return true if the point is not outside the element, false otherwise + * \copydoc MeshLib::Element::isPntInElement() + * + * This is actually calling the correct implementation of this function + * passing the element's nodes. */ bool isPntInElement(MathLib::Point3d const& pnt, double eps = std::numeric_limits<double>::epsilon()) const { diff --git a/MeshLib/Elements/TetRule4.h b/MeshLib/Elements/TetRule4.h index 53927c6272d4f0767ab7e6e0fc6316ef77fd8fd8..c9327e39f7a2bac54bb7777ca1c838b2b6e8708a 100644 --- a/MeshLib/Elements/TetRule4.h +++ b/MeshLib/Elements/TetRule4.h @@ -75,12 +75,11 @@ public: static const Element* getFace(const Element* e, unsigned i); /** - * Checks if a point is inside the element. - * @param pnt a 3D MathLib::Point3d object - * @param eps tolerance for numerical algorithm used or computing the property - * @return true if the point is not outside the element, false otherwise + * \copydoc MeshLib::Element::isPntInElement() + * @param nodes the nodes of the element. */ - 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. diff --git a/MeshLib/Elements/TriRule3.h b/MeshLib/Elements/TriRule3.h index 6f08356c0c583de60b43cb2c5b8160fcc7e70724..7521f1b383e310678d825de93c6e208cf7aada58 100644 --- a/MeshLib/Elements/TriRule3.h +++ b/MeshLib/Elements/TriRule3.h @@ -63,12 +63,11 @@ public: typedef LinearEdgeReturn EdgeReturn; /** - * Checks if a point is inside the element. - * @param pnt a 3D MathLib::Point3d object - * @param eps tolerance for numerical algorithm used or computing the property - * @return true if the point is not outside the element, false otherwise + * \copydoc MeshLib::Element::isPntInElement() + * @param nodes the nodes of the element. */ - 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.