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

#include <shape.h>

Inheritance diagram for Plane< dim >:
[legend]

Public Member Functions

 Plane (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
Tensor< 1, dim > gradient (const Point< dim > &evaluation_point, const unsigned int component=0) 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

Tensor< 1, dim > normal

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 Plane< dim >

Definition at line 1493 of file shape.h.

Constructor & Destructor Documentation

◆ Plane()

template<int dim>
Plane< dim >::Plane ( const Point< dim > & position,
const Tensor< 1, 3 > & orientation )
inline

Constructor for a infinite plane. The plane is normal to the Z axis in 3D and Y axis in 2D in the reference frame of the particle.

Parameters
positionThe point on the plane.
orientationThe orientation.

Definition at line 1501 of file shape.h.

References Shape< dim >::bounding_box_center, Shape< dim >::bounding_box_half_length, normal, Shape< dim >::orientation, Shape< dim >::position, and Shape< dim >::Shape().

Member Function Documentation

◆ displaced_volume()

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

Return the volume displaced by the solid.

Reimplemented from Shape< dim >.

Definition at line 482 of file shape.cc.

◆ gradient()

template<int dim>
Tensor< 1, dim > Plane< dim >::gradient ( const Point< dim > & evaluation_point,
const unsigned int component = 0 ) const
override

Return the analytical gradient of the distance.

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.

Definition at line 465 of file shape.cc.

References normal, Shape< dim >::rotation_matrix, tensor_nd_to_2d(), and tensor_nd_to_3d().

◆ static_copy()

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

Return a pointer to a copy of the Shape.

Implements Shape< dim >.

Definition at line 456 of file shape.cc.

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

◆ value()

template<int dim>
double Plane< 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 440 of file shape.cc.

References Shape< dim >::align_and_center(), normal, and Shape< dim >::reverse_align_and_center().

Member Data Documentation

◆ normal

template<int dim>
Tensor<1, dim> Plane< dim >::normal
private

Definition at line 1558 of file shape.h.


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