![]() |
Lethe Open-Source Library version 1.2.0
Developer Guide
|
#include <shape.h>
Public Member Functions | |
| Superquadric (const Tensor< 1, dim > half_lengths, const Tensor< 1, dim > exponents, const double epsilon, const Point< dim > &position, const Tensor< 1, 3 > &orientation) | |
| double | value (const Point< dim > &evaluation_point, const unsigned int component=0) const override |
| double | value_with_cell_guess (const Point< dim > &evaluation_point, const typename DoFHandler< dim >::active_cell_iterator &cell, const unsigned int component=0) override |
| std::shared_ptr< Shape< dim > > | static_copy () const override |
| Tensor< 1, dim > | gradient (const Point< dim > &evaluation_point, const unsigned int component=0) const override |
| Tensor< 1, dim > | gradient_with_cell_guess (const Point< dim > &evaluation_point, const typename DoFHandler< dim >::active_cell_iterator &cell, const unsigned int component=0) override |
| void | closest_surface_point (const Point< dim > &p, Point< dim > &closest_point, const typename DoFHandler< dim >::active_cell_iterator &cell_guess) override |
| void | closest_surface_point (const Point< dim > &p, Point< dim > &closest_point) const override |
| double | superquadric (const Point< dim > ¢ered_point) const |
| Point< dim > | superquadric_gradient (const Point< dim > ¢ered_point) const |
| Public Member Functions inherited from Shape< dim > | |
| Shape (double radius, const Point< dim > &position, const Tensor< 1, 3 > &orientation) | |
| virtual std::tuple< double, Tensor< 1, dim >, Point< dim > > | distance_to_shape_with_cell_guess (Shape< dim > &shape, const typename DoFHandler< dim >::active_cell_iterator &cell, std::vector< Point< dim > > &candidate_points, double precision=1e-6, bool exact_distance_outside_of_contact=false) |
| virtual std::tuple< double, Tensor< 1, dim >, Point< dim > > | distance_to_shape (Shape< dim > &shape, std::vector< Point< dim > > &candidate_points, double precision=1e-6, bool exact_distance_outside_of_contact=false) |
| bool | bounding_box_contact (Shape< dim > &shape) |
| virtual double | displaced_volume () |
| virtual double | local_curvature_radius (Point< dim > p) |
| virtual double | local_curvature_radius_with_cell_guess (const Point< dim > &p, const typename DoFHandler< dim >::active_cell_iterator &cell) |
| virtual void | set_position (const Point< dim > &new_position) |
| virtual void | set_orientation (const Tensor< 1, 3 > &new_orientation) |
| virtual Point< dim > | get_position () |
| virtual Tensor< 1, 3 > | get_orientation () |
| virtual Tensor< 2, 3 > | get_rotation_matrix () |
| virtual Tensor< 1, dim > | get_bounding_box_half_length () |
| virtual Point< dim > | get_bounding_box_center () |
| virtual std::shared_ptr< Manifold< dim - 1, dim > > | get_shape_manifold () |
| virtual void | clear_cache () |
| Point< dim > | align_and_center (const Point< dim > &evaluation_point) const |
| Point< dim > | reverse_align_and_center (const Point< dim > &evaluation_point) const |
| std::string | point_to_string (const Point< dim > &evaluation_point) const |
| void | set_part_of_a_composite (const bool is_part_of_a_composite) |
| virtual void | set_layer_thickening (const double the_layer_thickening) |
Static Public Member Functions | |
| static double | sign (const double prm) |
| Static Public Member Functions inherited from Shape< dim > | |
| static double | smooth_max (const double a, const double b, const double smooth_factor=10) |
| static Tensor< 1, 3 > | rotation_matrix_to_xyz_angles (Tensor< 2, 3 > &rotation_matrix_representation) |
Private Attributes | |
| Tensor< 1, dim > | half_lengths |
| Tensor< 1, dim > | exponents |
| double | epsilon |
Additional Inherited Members | |
| Public Types inherited from Shape< dim > | |
| enum class | ShapeType : std::int8_t { sphere , hyper_rectangle , ellipsoid , torus , cone , cylinder , cylindrical_tube , cylindrical_helix , cut_hollow_sphere , death_star , composite , rbf , opencascade , superquadric , plane } |
| Public Attributes inherited from Shape< dim > | |
| enum Shape::ShapeType | type |
| double | effective_radius |
| std::string | additional_info_on_shape |
| Tensor< 1, dim > | bounding_box_half_length |
| Point< dim > | bounding_box_center |
| Protected Attributes inherited from Shape< dim > | |
| Point< dim > | position |
| Tensor< 1, 3 > | orientation |
| std::unordered_map< std::string, double > | value_cache |
| std::unordered_map< std::string, Tensor< 1, dim > > | gradient_cache |
| std::unordered_map< std::string, Point< dim > > | closest_point_cache |
| bool | part_of_a_composite |
| Tensor< 2, 3 > | rotation_matrix |
| double | layer_thickening |
This class defines superquadric shapes. Their signed distance function is: \(\left|\frac{x}{a}\right|^r + \left|\frac{y}{b}\right|^s + \left|\frac{z}{c}\right|^t - 1 = 0\).
| dim | Dimension of the shape |
|
inline |
Constructor for a superquadric shape.
| half_lengths | The half-lengths of each direction |
| exponents | The blockiness in each direction |
| epsilon | The tolerance for surface representation |
| position | The superquadric center |
| orientation | The superquadric orientation |
Definition at line 1580 of file shape.h.
References Shape< dim >::bounding_box_center, Shape< dim >::bounding_box_half_length, epsilon, exponents, half_lengths, Shape< dim >::orientation, Shape< dim >::position, and Shape< dim >::Shape().
|
overridevirtual |
Reimplemented from Shape< dim >.
Definition at line 517 of file shape.cc.
References Shape< dim >::align_and_center(), Shape< dim >::closest_point_cache, epsilon, Shape< dim >::point_to_string(), Shape< dim >::reverse_align_and_center(), superquadric(), and superquadric_gradient().
|
overridevirtual |
Sets the closest_point parameter to be the point on the surface of the shape which has the minimal distance from the given point p. Since this function is at the core of the calculations for superquadrics, it is redefined here.
| p | The point at which the evaluation is performed |
| closest_point | The reference to the closest point. This point will be modified by the function. |
| cell_guess | A guess of the cell containing the evaluation point, which is useful to reduce computation time |
Reimplemented from Shape< dim >.
Definition at line 490 of file shape.cc.
References Shape< dim >::closest_point_cache, closest_surface_point(), gradient(), Shape< dim >::gradient_cache, Shape< dim >::part_of_a_composite, Shape< dim >::point_to_string(), value(), and Shape< dim >::value_cache.
|
override |
Return the analytical gradient of the distance.
| evaluation_point | The point at which the function will be evaluated |
| component | This parameter is not used, but it is necessary because Shapes inherit from the Function class of deal.II. |
Definition at line 638 of file shape.cc.
References Shape< dim >::align_and_center(), closest_surface_point(), Shape< dim >::effective_radius, gradient(), Shape< dim >::gradient_cache, Shape< dim >::point_to_string(), and superquadric().
|
overridevirtual |
Return the gradient of the distance function.
| evaluation_point | The point at which the function will be evaluated |
| cell | The cell that is likely to contain the evaluation point |
| component | Not applicable |
Reimplemented from Shape< dim >.
Definition at line 666 of file shape.cc.
References Shape< dim >::closest_point_cache, closest_surface_point(), gradient(), Shape< dim >::gradient_cache, Shape< dim >::part_of_a_composite, Shape< dim >::point_to_string(), value(), and Shape< dim >::value_cache.
|
inlinestatic |
|
overridevirtual |
Return a pointer to a copy of the Shape.
Implements Shape< dim >.
Definition at line 625 of file shape.cc.
References epsilon, exponents, half_lengths, Shape< dim >::orientation, and Shape< dim >::position.
|
inline |
Computes the value of the superquadric from its equation.
| centered_point | point at which we make the evaluation, in the shape referential |
Definition at line 1691 of file shape.h.
References exponents, and half_lengths.
|
inline |
Computes the gradient of the superquadric from its equation.
| centered_point | point at which we make the evaluation, in the shape referential |
Definition at line 1703 of file shape.h.
References epsilon, exponents, gradient(), and half_lengths.
|
overridevirtual |
Return the evaluation of the signed distance function of this solid at the given point evaluation point.
| evaluation_point | The point at which the function will be evaluated |
| component | This parameter is not used, but it is necessary because Shapes inherit from the Function class of deal.II. |
Implements Shape< dim >.
Definition at line 564 of file shape.cc.
References Shape< dim >::align_and_center(), closest_surface_point(), Shape< dim >::layer_thickening, Shape< dim >::point_to_string(), superquadric(), and Shape< dim >::value_cache.
|
overridevirtual |
Return the evaluation of the signed distance function of this solid at the given point evaluation point with a guess for the cell containing the evaluation point.
| evaluation_point | The point at which the function will be evaluated |
| cell | The cell that is likely to contain the evaluation point |
| component | This parameter is not used, but it is necessary because Shapes inherit from the Function class of deal.II. |
Reimplemented from Shape< dim >.
Definition at line 592 of file shape.cc.
References Shape< dim >::closest_point_cache, closest_surface_point(), gradient(), Shape< dim >::gradient_cache, levelset, Shape< dim >::part_of_a_composite, Shape< dim >::point_to_string(), value(), and Shape< dim >::value_cache.
|
private |
|
private |
|
private |