ug4
ug::RegularVertex Class Reference

A basic vertex-type. More...

#include <grid_objects_0d.h>

+ Inheritance diagram for ug::RegularVertex:

Public Member Functions

virtual int container_section () const
 
virtual GridObjectcreate_empty_instance () const
 create an instance of the derived type More...
 
virtual ReferenceObjectID reference_object_id () const
 
virtual ~RegularVertex ()
 
- Public Member Functions inherited from ug::Vertex
virtual int base_object_id () const
 
uint32 get_hash_value () const
 returns a value that can be used for hashing. More...
 
uint num_sides () const
 
virtual ~Vertex ()
 
- Public Member Functions inherited from ug::GridObject
uint grid_data_index () const
 Returns the grid attachment data index of a geometric object. More...
 
virtual bool is_constrained () const
 returns true if the object is constrained by other objects. More...
 
virtual bool is_constraining () const
 returns the id of the reference-object. More...
 
virtual ~GridObject ()
 
virtual void remove_constraint_link (const Vertex *vrt)
 removes a constraint link to the grid object. More...
 
virtual void remove_constraint_link (const Edge *e)
 removes a constraint link to the grid object. More...
 
virtual void remove_constraint_link (const Face *f)
 removes a constraint link to the grid object. More...
 

Static Public Member Functions

static bool type_match (GridObject *pObj)
 
- Static Public Member Functions inherited from ug::Vertex
static bool type_match (GridObject *pObj)
 

Friends

class Grid
 

Additional Inherited Members

- Public Types inherited from ug::Vertex
typedef Vertex grid_base_object
 
typedef Edge higher_dim_base_object
 
typedef void lower_dim_base_object
 
typedef Vertex side
 
typedef Edge sideof
 
- Static Public Attributes inherited from ug::Vertex
static const int BASE_OBJECT_ID = VERTEX
 
static const bool CAN_BE_SIDE = true
 
static const int dim = 0
 reference dimension More...
 
static const bool HAS_SIDES = false
 
static const size_t NUM_VERTICES = 1
 
- Protected Member Functions inherited from ug::GridObject
void set_grid_data_index (uint index)
 ATTENTION: Use this method with extreme care! More...
 
- Protected Attributes inherited from ug::Vertex
uint32 m_hashValue
 
- Protected Attributes inherited from ug::GridObject
uint m_gridDataIndex
 

Detailed Description

A basic vertex-type.

This type represents the most commonly used vertex.

Constructor & Destructor Documentation

◆ ~RegularVertex()

virtual ug::RegularVertex::~RegularVertex ( )
inlinevirtual

Member Function Documentation

◆ container_section()

virtual int ug::RegularVertex::container_section ( ) const
inlinevirtual

Reimplemented from ug::Vertex.

References ug::CSVRT_REGULAR_VERTEX.

◆ create_empty_instance()

virtual GridObject* ug::RegularVertex::create_empty_instance ( ) const
inlinevirtual

create an instance of the derived type

Make sure to overload this method in derivates of this class!

Reimplemented from ug::GridObject.

◆ reference_object_id()

virtual ReferenceObjectID ug::RegularVertex::reference_object_id ( ) const
inlinevirtual

A reference object represents a class of geometric objects. Tetrahedrons, Triangles etc are such classes. Reference ids should be defined in the file in which concrete geometric objects are defined.

Reimplemented from ug::Vertex.

References ug::ROID_VERTEX.

◆ type_match()

static bool ug::RegularVertex::type_match ( GridObject pObj)
inlinestatic

Friends And Related Function Documentation

◆ Grid

friend class Grid
friend

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