Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
Cone< dim > Class Template Reference

#include <shape.h>

Inheritance diagram for Cone< dim >:
[legend]

Public Member Functions

 Cone (double tan_base_angle, double height, const Point< dim > &position, const Tensor< 1, 3 > &orientation)
double value (const Point< dim > &evaluation_point, const unsigned int component=0) const override
std::shared_ptr< Shape< dim > > static_copy () const override
double displaced_volume () override
Public Member Functions inherited from Shape< dim >
 Shape (double radius, const Point< dim > &position, const Tensor< 1, 3 > &orientation)
virtual double value_with_cell_guess (const Point< dim > &evaluation_point, const typename DoFHandler< dim >::active_cell_iterator &cell, const unsigned int component=0)
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 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)
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 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)

Private Attributes

double tan_base_angle
double height
double base_radius
Tensor< 1, 2 > intermediate_q

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
}
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

Detailed Description

template<int dim>
class Cone< dim >

Definition at line 1895 of file shape.h.

Constructor & Destructor Documentation

◆ Cone()

template<int dim>
Cone< dim >::Cone ( double tan_base_angle,
double height,
const Point< dim > & position,
const Tensor< 1, 3 > & orientation )
inline

Constructs a cone.

Parameters
tan_base_angleThe tangent of the angle between the base of the cone and its curve side
heightThe height of the cone
positionThe position of the center of cone's base
orientationThe orientation of the cone axis, from its base to its tip

Definition at line 1905 of file shape.h.

References base_radius, height, intermediate_q, Shape< dim >::orientation, Shape< dim >::position, Shape< dim >::Shape(), and tan_base_angle.

Member Function Documentation

◆ displaced_volume()

template<int dim>
double Cone< dim >::displaced_volume ( )
overridevirtual

Return the volume displaced by the solid.

Reimplemented from Shape< dim >.

Definition at line 1174 of file shape.cc.

References base_radius, and height.

◆ static_copy()

template<int dim>
std::shared_ptr< Shape< dim > > Cone< dim >::static_copy ( ) const
overridevirtual

Return a pointer to a copy of the Shape.

Implements Shape< dim >.

Definition at line 1165 of file shape.cc.

References height, Shape< dim >::orientation, Shape< dim >::position, and tan_base_angle.

◆ value()

template<int dim>
double Cone< dim >::value ( const Point< dim > & evaluation_point,
const unsigned int component = 0 ) const
overridevirtual

Return the evaluation of the signed distance function of this solid at the given point evaluation point.

Parameters
evaluation_pointThe point at which the function will be evaluated
componentThis parameter is not used, but it is necessary because Shapes inherit from the Function class of deal.II.

Implements Shape< dim >.

Definition at line 1135 of file shape.cc.

References Shape< dim >::align_and_center(), intermediate_q, and Shape< dim >::layer_thickening.

Member Data Documentation

◆ base_radius

template<int dim>
double Cone< dim >::base_radius
private

Definition at line 1953 of file shape.h.

◆ height

template<int dim>
double Cone< dim >::height
private

Definition at line 1952 of file shape.h.

◆ intermediate_q

template<int dim>
Tensor<1, 2> Cone< dim >::intermediate_q
private

Definition at line 1955 of file shape.h.

◆ tan_base_angle

template<int dim>
double Cone< dim >::tan_base_angle
private

Definition at line 1951 of file shape.h.


The documentation for this class was generated from the following files: