![]() |
Lethe Open-Source Library version 1.2.0
Developer Guide
|
#include <shape.h>
Public Types | |
| enum class | BooleanOperation : int { Union , Difference , Intersection } |
| 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 Member Functions | |
| CompositeShape (std::map< unsigned int, std::shared_ptr< Shape< dim > > > constituents, std::map< unsigned int, std::tuple< BooleanOperation, unsigned int, unsigned int > > operations, const Point< dim > &position, const Tensor< 1, 3 > &orientation) | |
| CompositeShape (std::vector< std::shared_ptr< Shape< dim > > > constituents_vector, 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 |
| 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 |
| std::shared_ptr< Shape< dim > > | static_copy () const override |
| void | update_precalculations (DoFHandler< dim > &updated_dof_handler, const bool mesh_based_precalculations) |
| void | load_data_from_file () |
| void | remove_superfluous_data (DoFHandler< dim > &updated_dof_handler, const bool mesh_based_precalculations) |
| std::pair< double, Tensor< 1, dim > > | apply_boolean_operations (std::map< unsigned int, double > constituent_shapes_values, std::map< unsigned int, Tensor< 1, dim > > constituent_shapes_gradients) const |
| virtual void | clear_cache () override |
| void | set_layer_thickening (const double layer_thickening) override |
| 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 void | closest_surface_point (const Point< dim > &p, Point< dim > &closest_point, const typename DoFHandler< dim >::active_cell_iterator &cell_guess) |
| virtual void | closest_surface_point (const Point< dim > &p, Point< dim > &closest_point) const |
| 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 () |
| 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) |
Private Attributes | |
| std::map< unsigned int, std::shared_ptr< Shape< dim > > > | constituents |
| std::map< unsigned int, std::tuple< BooleanOperation, unsigned int, unsigned int > > | operations |
Additional Inherited Members | |
| 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) |
| 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 was designed so that specific composite shapes could be defined through the parameter file. Boolean operations such as union, difference, and intersection are allowed.
| dim | Dimension of the shape |
|
strong |
|
inline |
Constructs an assembly of shapes into a composite shape.
| constituents | The shapes from which this composite shape will be composed |
| operations | The list of operations to perform to construct the composite |
| position | |
| orientation |
Definition at line 2121 of file shape.h.
References Shape< dim >::bounding_box_center, Shape< dim >::bounding_box_half_length, constituents, Shape< dim >::effective_radius, operations, Shape< dim >::orientation, point_nd_to_3d(), Shape< dim >::position, and Shape< dim >::Shape().
|
inline |
Constructs an assembly of shapes into a composite shape from a vector of shapes. This constructor is mainly used for outputting multiple shapes with a global level set function defined as a union.
| constituents_vector | The shapes from which this composite sphere will be composed |
| position | |
| orientation |
Definition at line 2254 of file shape.h.
References constituents, Shape< dim >::effective_radius, operations, Shape< dim >::orientation, Shape< dim >::position, Shape< dim >::Shape(), and Union.
|
inline |
Computes the assigned boolean operations.
| constituent_shapes_values | map containing the computed values for the component shapes |
| constituent_shapes_gradients | map containing the computed gradients for the component shapes |
Definition at line 1518 of file shape.cc.
References Difference, gradient(), levelset, operations, and Union.
|
overridevirtual |
Clear the cache of the shape.
Reimplemented from Shape< dim >.
Definition at line 1596 of file shape.cc.
References Shape< dim >::clear_cache().
|
override |
Return the gradient of the distance function.
| evaluation_point | The point at which the function will be evaluated |
| component | Not applicable |
Definition at line 1357 of file shape.cc.
References Shape< dim >::align_and_center(), apply_boolean_operations(), constituents, Shape< dim >::effective_radius, gradient(), Shape< dim >::gradient_cache, levelset, Shape< dim >::point_to_string(), and Shape< dim >::reverse_align_and_center().
|
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 1406 of file shape.cc.
References Shape< dim >::align_and_center(), apply_boolean_operations(), constituents, Shape< dim >::effective_radius, gradient(), Shape< dim >::gradient_cache, levelset, Shape< dim >::part_of_a_composite, Shape< dim >::point_to_string(), and Shape< dim >::reverse_align_and_center().
| void CompositeShape< dim >::load_data_from_file | ( | ) |
Load data from file. To be called at initialization, after repartitioning or when shape has moved. This function is used only for RBF shapes and its composites at the moment.
Definition at line 1488 of file shape.cc.
References CompositeShape(), constituents, and load_data_from_file().
| void CompositeShape< dim >::remove_superfluous_data | ( | DoFHandler< dim > & | updated_dof_handler, |
| const bool | mesh_based_precalculations ) |
Remove data that affects only artificial cells (not locally owned and not ghost). The data is removed if it would never be accessed by the local process.
| updated_dof_handler | the reference to the new dof_handler |
| mesh_based_precalculations | mesh-based precalculations that can lead to slight shape misrepresentation (if RBF typed) |
Definition at line 1501 of file shape.cc.
References CompositeShape(), constituents, and remove_superfluous_data().
|
overridevirtual |
See base.
Reimplemented from Shape< dim >.
Definition at line 1606 of file shape.cc.
References constituents, Shape< dim >::layer_thickening, and Shape< dim >::set_layer_thickening().
|
overridevirtual |
Return a pointer to a copy of the Shape.
Implements Shape< dim >.
Definition at line 1460 of file shape.cc.
References constituents, operations, Shape< dim >::orientation, and Shape< dim >::position.
| void CompositeShape< dim >::update_precalculations | ( | DoFHandler< dim > & | updated_dof_handler, |
| const bool | mesh_based_precalculations ) |
Sets the proper dof handler, then computes/updates the map of cells and their likely non-null nodes.
| updated_dof_handler | the reference to the new dof_handler |
| mesh_based_precalculations | mesh-based precalculations that can lead to slight shape misrepresentation (if RBF typed) |
Definition at line 1469 of file shape.cc.
References CompositeShape(), constituents, and update_precalculations().
|
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 1277 of file shape.cc.
References Shape< dim >::align_and_center(), apply_boolean_operations(), constituents, levelset, Shape< dim >::point_to_string(), 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 1314 of file shape.cc.
References Shape< dim >::align_and_center(), apply_boolean_operations(), constituents, levelset, Shape< dim >::part_of_a_composite, Shape< dim >::point_to_string(), and Shape< dim >::value_cache.
|
private |
|
private |