// ------------------------------------------------------------------------ // // SPDX-License-Identifier: LGPL-2.1-or-later // Copyright (C) 2021 - 2023 by the deal.II authors // // This file is part of the deal.II library. // // Part of the source code is dual licensed under Apache-2.0 WITH // LLVM-exception OR LGPL-2.1-or-later. Detailed license information // governing the source code and code contributions can be found in // LICENSE.md and CONTRIBUTING.md at the top level directory of deal.II. // // ------------------------------------------------------------------------ #ifndef dealii_function_signed_distance_h #define dealii_function_signed_distance_h #include #include #include #include DEAL_II_NAMESPACE_OPEN namespace Functions { namespace SignedDistance { /** * Signed-distance level set function of a sphere: * $\psi(x) = \| x - x^c \| - R$. * Here, $x^c$ is the center of the sphere and $R$ is its radius. This * function is thus zero on the sphere, negative "inside" the ball having * the sphere as its boundary, and positive in the rest of * $\mathbb{R}^{dim}$. * * This function has gradient and Hessian equal to * $\partial_i \psi(x) = (x - x^c)/\| x - x^c \|$, * $\partial_i \partial_j \psi = * \delta_{ij}/\| x - x^c \| - (x_i - x_i^c)(x_j - x_j^c)/\| x - x^c \|^3$, * where $\delta_{ij}$ is the Kronecker delta function. * * @ingroup functions */ template class Sphere : public Function { public: /** * Constructor, takes the center and radius of the sphere. */ Sphere(const Point ¢er = Point(), const double radius = 1); double value(const Point &point, const unsigned int component = 0) const override; /** * @copydoc Function::gradient() * * @note The gradient is singular at the center of the sphere. If the * incoming @p point is too close to the center, a floating-point * exception may be thrown or entries in the gradient may be +inf/-inf * or +nan/-nan, depending on how the point is located relative to the * singularity. */ Tensor<1, dim> gradient(const Point &point, const unsigned int component = 0) const override; /** * @copydoc Function::hessian() * * @note The Hessian is singular at the center of the sphere. If the * incoming @p point is too close to the center, a floating-point * exception may be thrown or entries in the Hessian may be +inf/-inf * or +nan/-nan, depending on how the point is located relative to the * singularity. */ SymmetricTensor<2, dim> hessian(const Point &point, const unsigned int component = 0) const override; private: const Point center; const double radius; }; /** * Signed level set function of a plane in $\mathbb{R}^{dim}$: * $\psi(x) = n \cdot (x - x_p)$. * Here, $n$ is the plane normal and $x_p$ is a point in the plane. * Thus, with respect to the direction of the normal, this function is * positive above the plane, zero in the plane, and negative below the * plane. If the normal is normalized, $\psi$ will be the signed distance to * the closest point in the plane. * * @ingroup functions */ template class Plane : public Function { public: /** * Constructor, takes a point in the plane and the plane normal. */ Plane(const Point &point, const Tensor<1, dim> &normal); double value(const Point &point, const unsigned int component = 0) const override; Tensor<1, dim> gradient(const Point &, const unsigned int component = 0) const override; SymmetricTensor<2, dim> hessian(const Point &, const unsigned int component = 0) const override; private: const Point point_in_plane; const Tensor<1, dim> normal; }; /** * Signed-distance level set function to an ellipsoid defined by: * * @f[ * \sum_{i=1}^{dim} \frac{(x_i - c_i)^2}{R_i^2} = 1 * @f] * * Here, $c_i$ are the coordinates of the center of the ellipsoid and $R_i$ * are the elliptic radii. This function is zero on the ellipsoid, negative * inside the ellipsoid and positive outside the ellipsoid. * * @ingroup functions */ template class Ellipsoid : public Function { public: /** * Constructor, takes the center and radii of the ellipsoid. * * @param center Center of the ellipsoid. * @param radii Array of radii of the ellipsoid. * @param tolerance Tolerance of the distance computation. * @param max_iter Max. number of iteration of the distance computation algorithm. */ Ellipsoid(const Point ¢er, const std::array &radii, const double tolerance = 1e-14, const unsigned int max_iter = 10); double value(const Point &point, const unsigned int component = 0) const override; /** * Calculates the gradient of the signed distance function via the normal * of the closest point on the ellipsoid. */ Tensor<1, dim> gradient(const Point &, const unsigned int component = 0) const override; private: /** * Evaluates the ellipsoid function: * * @f[ * f(\vec{x}) = \sum_{i=1}^{dim} \frac{(x_i - c_i)^2}{R_i^2} - 1 * @f] */ double evaluate_ellipsoid(const Point &point) const; /** * Computes the closest point on the given ellipse for an arbitrary point. */ Point compute_closest_point_ellipse(const Point &point) const; /** * Computes the analytical normal vector of a origin centred ellipse at a * given @p point according to: * * / \ / b x a y \ * | n_x , n_y | = | ----- , ----- | * \ / \ a b / * * * @param point [x, y] * @return [n_x , n_y] */ Tensor<1, dim, double> compute_analyical_normal_vector_on_ellipse(const Point &point) const; /** * Compute the signed distance to a 2d ellipsoid i.e. ellipse. */ double compute_signed_distance_ellipse(const Point &point) const; const Point center; const std::array radii; const double tolerance; const unsigned int max_iter; }; /** * Signed-distance level set function of a rectangle. * * This function is zero on the rectangle, negative "inside" and positive * in the rest of $\mathbb{R}^{dim}$. * * Contour surfaces of the signed distance function of a 3D rectangle are * illustrated below: * * @image html signed_distance_hyper_rectangle.png * * @ingroup functions */ template class Rectangle : public Function { public: /** * Constructor, takes the bottom left point and the top right * point of the rectangle. * * @param bottom_left Bottom left point of the rectangle. * @param top_right Top right point of the rectangle. */ Rectangle(const Point &bottom_left, const Point &top_right); /** * Constructor, takes a bounding box. * * @param bounding_box Bounding box. */ Rectangle(const BoundingBox bounding_box); /** * Calculates the signed distance from a given point @p p to the rectangle. * The signed distance is negative for points inside the rectangle, zero * for points on the rectangle and positive for points outside the * rectangle. */ double value(const Point &p, const unsigned int component = 0) const override; private: const BoundingBox bounding_box; }; /** * Signed-distance level set function of Zalesak's disk proposed in * @cite zalesak1979fully. * * It is calculated by the set difference $\psi(x) = \max(\psi_{S}(x), * -\psi_{N}(x))$ of the level set functions of a sphere $\psi_{S}$ and a * rectangle $\psi_{N}$. This function is zero on the surface of the disk, * negative "inside" and positive in the rest of $\mathbb{R}^{dim}$. * * Contour surfaces of the signed distance function of a 3D Zalesak's disk * are illustrated below: * * @image html https://www.dealii.org/images/grids/signed_distance_zalesak_disk.png * * @ingroup functions */ template class ZalesakDisk : public Function { public: /** * Constructor, takes the radius and center of the disk together * with the width and the height of the notch. * * @param radius Radius of the disk. * @param center Center of the disk. * @param notch_width Width of the notch of the disk. * @param notch_height Height of the notch of the disk. */ ZalesakDisk(const Point ¢er, const double radius, const double notch_width, const double notch_height); /** * Calculates the signed distance from a given point @p p to the disk. * The signed distance is negative for points inside the disk, zero * for points on the disk and positive for points outside the * disk. */ double value(const Point &p, const unsigned int component = 0) const override; private: /** * Disk described by a sphere. */ const Functions::SignedDistance::Sphere sphere; /** * Notch described by a rectangle. */ const Functions::SignedDistance::Rectangle notch; }; } // namespace SignedDistance } // namespace Functions DEAL_II_NAMESPACE_CLOSE #endif