bitrl & cuberl Documentation
Simulation engine for reinforcement learning agents
Loading...
Searching...
No Matches
bitrl::utils::geom::EdgeElem< 1 > Class Reference

#include <edge_element.h>

Inheritance diagram for bitrl::utils::geom::EdgeElem< 1 >:
Collaboration diagram for bitrl::utils::geom::EdgeElem< 1 >:

Public Types

typedef Element< 1 >::neighbor_ptr_t neighbor_ptr_t
 
typedef Element< 1 >::neighbor_ref_t neighbor_ref_t
 
typedef Element< 1 >::node_ptr_t node_ptr_t
 
typedef Element< 1 >::edge_ptr_t edge_ptr_t
 
typedef Element< 1 >::cedge_ptr_t cedge_ptr_t
 
typedef Element< 1 >::edge_ref_t edge_ref_t
 
typedef Element< 1 >::cedge_ref_t cedge_ref_t
 
typedef Element< 1 >::face_ptr_t face_ptr_t
 
typedef Element< 1 >::cface_ptr_t cface_ptr_t
 
typedef Element< 1 >::face_ref_t face_ref_t
 
typedef Element< 1 >::cface_ref_t cface_ref_t
 
- Public Types inherited from bitrl::utils::geom::Element< 1 >
typedef Element< dim > * neighbor_ptr_t
 
typedef Element< dim > & neighbor_ref_t
 
typedef const Element< dim > & cneighbor_ref_t
 
typedef Node< dim > * node_ptr_t
 
typedef element_traits< Element< dim > >::edge_ptr_t edge_ptr_t
 
typedef element_traits< Element< dim > >::cedge_ptr_t cedge_ptr_t
 
typedef element_traits< Element< dim > >::edge_ref_t edge_ref_t
 
typedef element_traits< Element< dim > >::cedge_ref_t cedge_ref_t
 
typedef element_traits< Element< dim > >::face_ptr_t face_ptr_t
 
typedef element_traits< Element< dim > >::cface_ptr_t cface_ptr_t
 
typedef element_traits< Element< dim > >::face_ref_t face_ref_t
 
typedef element_traits< Element< dim > >::cface_ref_t cface_ref_t
 

Public Member Functions

 EdgeElem (uint_t id, uint_t proc_id=0)
 Constructor.
 
virtual uint_t n_nodes () const override
 How many nodes the element has.
 
virtual void set_node (uint_t i, node_ptr_t node) override final
 Set the i-th node.
 
virtual node_ptr_t get_node (uint_t n) override final
 Returns the i-th node.
 
virtual uint_t n_vertices () const override final
 How many vertices the element has.
 
virtual uint_t n_edges () const override final
 How many edges the element has.
 
virtual uint_t n_faces () const override final
 How many faces the element has.
 
virtual void resize_faces () override final
 Resize the space for the faces an EdgeElem<1> does not have edges/faces these are Node type.
 
virtual void set_face (uint_t, face_ptr_t) override final
 Set the f-th face of the element An EdgeElem<1> does not have extra faces.
 
virtual cface_ref_t get_face (uint_t f) const override
 Returns the f-face.
 
virtual face_ref_t get_face (uint_t f) override
 Returns the f-face.
 
virtual uint_t n_neighbors () const
 Returns the number of neighbors.
 
virtual void face_vertices (uint_t f, std::vector< uint_t > &ids) const override final
 Returns the node ids of the vertices of the given face.
 
virtual real_t volume () const override final
 Returns the volume of the element.
 
virtual uint_t which_face_am_i (cface_ref_t face) const override final
 Returns the local id relevant to the calling object of the passed object.
 
virtual const DynVec< real_tface_normal_vector (uint_t f) const override final
 Returns the face normal vector.
 
- Public Member Functions inherited from bitrl::utils::geom::Element< 1 >
virtual ~Element ()
 Destructor.
 
virtual void set_node (uint_t i, node_ptr_t node)
 Set the i-th node.
 
virtual void append_node (node_ptr_t node)
 Append a node to the nodes list.
 
virtual void resize_nodes ()
 Reserve space for nodes.
 
virtual void set_face (uint_t f, face_ptr_t face)=0
 Set the f-th face of the element.
 
virtual void set_neighbor (uint_t n, neighbor_ptr_t neigh)
 Set the i-th neighbor.
 
virtual void resize_neighbors ()
 Reserve space for neighbors.
 
virtual cneighbor_ref_t get_neighbor (uint_t n) const
 Access the n-th neighbor.
 
virtual neighbor_ptr_t neighbor_ptr (uint_t n)
 Access the n-th neighbor pointer.
 
virtual const neighbor_ptr_t neighbor_ptr (uint_t n) const
 Access the n-th neighbor pointer.
 
virtual GeomPoint< dim > centroid () const
 Returns the average location of the vertices of the element.
 
virtual uint_t which_face_am_i (cface_ref_t face) const=0
 Returns the local id relevant to the calling object of the passed object.
 
uint_t which_neighbor_am_i (const Element< dim > &element) const
 Returns the local id relevant to the calling object of the passed object.
 
std::vector< node_ptr_tget_vertices () const
 Return the vertices of the element.
 
- Public Member Functions inherited from bitrl::utils::geom::MeshEntity
 MeshEntity ()
 Constructor.
 
 MeshEntity (uint_t id, uint_t pid, const std::any &data)
 Constructor.
 
uint_t get_id () const
 Returns the id of the element.
 
void set_id (uint_t id)
 Set the id of the element.
 
uint_t get_pid () const
 Returns the id of the element.
 
void set_pid (uint_t id)
 Set the id of the element.
 
bool has_valid_id () const
 
bool is_active () const
 
void set_active_flag (bool f)
 

Additional Inherited Members

- Protected Member Functions inherited from bitrl::utils::geom::Element< 1 >
 Element ()
 Constructor.
 
 Element (uint_t id, uint_t pid)
 Constructor.
 
 Element (uint_t id, uint_t pid, const std::any &data)
 Constructor.
 
- Protected Attributes inherited from bitrl::utils::geom::Element< 1 >
std::vector< neighbor_ptr_tneginbors_
 The neighbors of the element.
 
std::vector< node_ptr_tnodes_
 The nodes of the element.
 

Member Typedef Documentation

◆ cedge_ptr_t

typedef Element<1>::cedge_ptr_t bitrl::utils::geom::EdgeElem< 1 >::cedge_ptr_t

◆ cedge_ref_t

typedef Element<1>::cedge_ref_t bitrl::utils::geom::EdgeElem< 1 >::cedge_ref_t

◆ cface_ptr_t

typedef Element<1>::cface_ptr_t bitrl::utils::geom::EdgeElem< 1 >::cface_ptr_t

◆ cface_ref_t

typedef Element<1>::cface_ref_t bitrl::utils::geom::EdgeElem< 1 >::cface_ref_t

◆ edge_ptr_t

typedef Element<1>::edge_ptr_t bitrl::utils::geom::EdgeElem< 1 >::edge_ptr_t

◆ edge_ref_t

typedef Element<1>::edge_ref_t bitrl::utils::geom::EdgeElem< 1 >::edge_ref_t

◆ face_ptr_t

typedef Element<1>::face_ptr_t bitrl::utils::geom::EdgeElem< 1 >::face_ptr_t

◆ face_ref_t

typedef Element<1>::face_ref_t bitrl::utils::geom::EdgeElem< 1 >::face_ref_t

◆ neighbor_ptr_t

typedef Element<1>::neighbor_ptr_t bitrl::utils::geom::EdgeElem< 1 >::neighbor_ptr_t

◆ neighbor_ref_t

typedef Element<1>::neighbor_ref_t bitrl::utils::geom::EdgeElem< 1 >::neighbor_ref_t

◆ node_ptr_t

typedef Element<1>::node_ptr_t bitrl::utils::geom::EdgeElem< 1 >::node_ptr_t

Constructor & Destructor Documentation

◆ EdgeElem()

bitrl::utils::geom::EdgeElem< 1 >::EdgeElem ( uint_t  id,
uint_t  proc_id = 0 
)

Constructor.

Member Function Documentation

◆ face_normal_vector()

virtual const DynVec< real_t > bitrl::utils::geom::EdgeElem< 1 >::face_normal_vector ( uint_t  f) const
inlinefinaloverridevirtual

Returns the face normal vector.

Implements bitrl::utils::geom::Element< 1 >.

◆ face_vertices()

void bitrl::utils::geom::EdgeElem< 1 >::face_vertices ( uint_t  f,
std::vector< uint_t > &  ids 
) const
finaloverridevirtual

Returns the node ids of the vertices of the given face.

Implements bitrl::utils::geom::Element< 1 >.

◆ get_face() [1/2]

EdgeElem< 1 >::cface_ref_t bitrl::utils::geom::EdgeElem< 1 >::get_face ( uint_t  f) const
overridevirtual

Returns the f-face.

Implements bitrl::utils::geom::Element< 1 >.

◆ get_face() [2/2]

EdgeElem< 1 >::face_ref_t bitrl::utils::geom::EdgeElem< 1 >::get_face ( uint_t  f)
overridevirtual

Returns the f-face.

Implements bitrl::utils::geom::Element< 1 >.

◆ get_node()

EdgeElem< 1 >::node_ptr_t bitrl::utils::geom::EdgeElem< 1 >::get_node ( uint_t  n)
finaloverridevirtual

Returns the i-th node.

Reimplemented from bitrl::utils::geom::Element< 1 >.

◆ n_edges()

virtual uint_t bitrl::utils::geom::EdgeElem< 1 >::n_edges ( ) const
inlinefinaloverridevirtual

How many edges the element has.

Implements bitrl::utils::geom::Element< 1 >.

◆ n_faces()

virtual uint_t bitrl::utils::geom::EdgeElem< 1 >::n_faces ( ) const
inlinefinaloverridevirtual

How many faces the element has.

Implements bitrl::utils::geom::Element< 1 >.

◆ n_neighbors()

virtual uint_t bitrl::utils::geom::EdgeElem< 1 >::n_neighbors ( ) const
inlinevirtual

Returns the number of neighbors.

Implements bitrl::utils::geom::Element< 1 >.

◆ n_nodes()

virtual uint_t bitrl::utils::geom::EdgeElem< 1 >::n_nodes ( ) const
inlineoverridevirtual

How many nodes the element has.

Implements bitrl::utils::geom::Element< 1 >.

◆ n_vertices()

virtual uint_t bitrl::utils::geom::EdgeElem< 1 >::n_vertices ( ) const
inlinefinaloverridevirtual

How many vertices the element has.

Implements bitrl::utils::geom::Element< 1 >.

◆ resize_faces()

virtual void bitrl::utils::geom::EdgeElem< 1 >::resize_faces ( )
inlinefinaloverridevirtual

Resize the space for the faces an EdgeElem<1> does not have edges/faces these are Node type.

Implements bitrl::utils::geom::Element< 1 >.

◆ set_face()

virtual void bitrl::utils::geom::EdgeElem< 1 >::set_face ( uint_t  ,
face_ptr_t   
)
inlinefinaloverridevirtual

Set the f-th face of the element An EdgeElem<1> does not have extra faces.

◆ set_node()

void bitrl::utils::geom::EdgeElem< 1 >::set_node ( uint_t  i,
node_ptr_t  node 
)
finaloverridevirtual

Set the i-th node.

◆ volume()

real_t bitrl::utils::geom::EdgeElem< 1 >::volume ( ) const
finaloverridevirtual

Returns the volume of the element.

Implements bitrl::utils::geom::Element< 1 >.

◆ which_face_am_i()

virtual uint_t bitrl::utils::geom::EdgeElem< 1 >::which_face_am_i ( cface_ref_t  face) const
inlinefinaloverridevirtual

Returns the local id relevant to the calling object of the passed object.


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