contains elements of type More...

#include <grid_objects_1d.h>

Inheritance diagram for ug::ConstrainingEdge:

Public Member Functions
void	add_constrained_object (Edge *pObj)

void	add_constrained_object (Vertex *pObj)

void	clear_constrained_edges ()

void	clear_constrained_objects ()

void	clear_constrained_vertices ()

template<>
Vertex *	constrained (size_t ind) const

template<>
Edge *	constrained (size_t ind) const

template<class TElem >
TElem *	constrained (size_t ind) const

Edge *	constrained_edge (size_t ind) const

Vertex *	constrained_vertex (size_t ind) const

	ConstrainingEdge ()

	ConstrainingEdge (const EdgeDescriptor &descriptor)

	ConstrainingEdge (Vertex v1, Vertex v2)

virtual int	container_section () const

virtual GridObject *	create_empty_instance () const
	create an instance of the derived type

bool	is_constrained_object (Edge *edge)

bool	is_constrained_object (Vertex *vrt)

virtual bool	is_constraining () const
	returns the id of the reference-object.

template<>
size_t	num_constrained () const

template<>
size_t	num_constrained () const

template<class TElem >
size_t	num_constrained () const

size_t	num_constrained_edges () const

size_t	num_constrained_vertices () const

virtual ReferenceObjectID	reference_object_id () const

bool	refine (std::vector< ConstrainingEdge * > &vNewEdgesOut, Vertex newVertex, Vertex *pSubstituteVrts=NULL)
	non virtual refine. Returns pointers to ConstrainingEdge.

virtual bool	refine (std::vector< Edge * > &vNewEdgesOut, Vertex newVertex, Vertex *pSubstituteVrts=NULL)
	virtual refine. Returns pointers to Edge.

virtual void	remove_constraint_link (const Edge *e)
	removes a constraint link to the grid object.

virtual void	remove_constraint_link (const Vertex *vrt)
	removes a constraint link to the grid object.

void	unconstrain_object (const Edge *edge)

void	unconstrain_object (const Vertex *vrt)

virtual	~ConstrainingEdge ()

Public Member Functions inherited from ug::Edge
virtual int	base_object_id () const

bool	get_opposing_side (Vertex v, Vertex *vrtOut)
	retrieves the vertex on the opposing side to the specified one.

bool	get_opposing_side (Vertex *v, VertexDescriptor &vrtOut)

uint	num_sides () const

virtual	~Edge ()

Public Member Functions inherited from ug::GridObject
uint	grid_data_index () const
	Returns the grid attachment data index of a geometric object.

virtual bool	is_constrained () const
	returns true if the object is constrained by other objects.

virtual	~GridObject ()

virtual void	remove_constraint_link (const Face *f)
	removes a constraint link to the grid object.

Public Member Functions inherited from ug::EdgeVertices
virtual size_t	num_vertices () const

Vertex *	operator[] (size_t index) const
	returns the i-th vertex.

size_t	size () const
	returns the number of vertices.

virtual Vertex *	vertex (size_t index) const

virtual ConstVertexArray	vertices () const

virtual	~EdgeVertices ()

Public Member Functions inherited from ug::IVertexGroup
Vertex *	operator[] (size_t index) const
	returns the i-th vertex.

size_t	size () const
	returns the number of vertices.

virtual	~IVertexGroup ()

Static Public Member Functions
static bool	type_match (GridObject *pObj)

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

Protected Attributes
std::vector< Edge * >	m_constrainedEdges

std::vector< Vertex * >	m_constrainedVertices

Protected Attributes inherited from ug::GridObject
uint	m_gridDataIndex

Protected Attributes inherited from ug::EdgeVertices
Vertex *	m_vertices [2]

Friends
class	Grid

Additional Inherited Members
Public Types inherited from ug::Edge
typedef Edge	grid_base_object

typedef Face	higher_dim_base_object

typedef Vertex	lower_dim_base_object

typedef Vertex	side

typedef Face	sideof

Public Types inherited from ug::IVertexGroup
typedef Vertex const	ConstVertexArray

Static Public Attributes inherited from ug::Edge
static const int	BASE_OBJECT_ID = EDGE

static const bool	CAN_BE_SIDE = true

static const int	dim = 1
	reference dimension

static const bool	HAS_SIDES = true

static const size_t	NUM_VERTICES = 2

Protected Member Functions inherited from ug::Edge
void	set_vertex (uint index, Vertex *pVrt)

Protected Member Functions inherited from ug::GridObject
void	set_grid_data_index (uint index)
	ATTENTION: Use this method with extreme care!

Protected Member Functions inherited from ug::EdgeVertices
void	assign_edge_vertices (const EdgeVertices &ev)

Detailed Description

contains elements of type

See also: HangingVertex and; ConstrainedEdge Edges of this type appear during hanging-vertex-refinement. Treat with care.

Constructor & Destructor Documentation

◆ ConstrainingEdge() [1/3]

ug::ConstrainingEdge::ConstrainingEdge ( )

inline

Referenced by refine().

◆ ConstrainingEdge() [2/3]

ug::ConstrainingEdge::ConstrainingEdge	(	Vertex *	v1,
		Vertex *	v2
	)

inline

◆ ConstrainingEdge() [3/3]

ug::ConstrainingEdge::ConstrainingEdge ( const EdgeDescriptor & descriptor )

inline

References ug::EdgeVertices::vertex().

◆ ~ConstrainingEdge()

virtual ug::ConstrainingEdge::~ConstrainingEdge ( )

inlinevirtual

Member Function Documentation

◆ add_constrained_object() [1/2]

void ug::ConstrainingEdge::add_constrained_object ( Edge * pObj )

inline

References UG_ASSERT.

◆ add_constrained_object() [2/2]

void ug::ConstrainingEdge::add_constrained_object ( Vertex * pObj )

inline

References UG_ASSERT.

Referenced by ug::DeserializeMultiGridElements(), ug::GridReaderUGX::grid(), ug::HangingNodeRefiner_MultiGrid::perform_coarsening(), and ug::HangingNodeRefinerBase< TSelector >::refine_edge_with_hanging_vertex().

◆ clear_constrained_edges()

void ug::ConstrainingEdge::clear_constrained_edges ( )

inline

Referenced by ug::HangingNodeRefinerBase< TSelector >::process_constrained_edge().

◆ clear_constrained_objects()

void ug::ConstrainingEdge::clear_constrained_objects ( )

inline

◆ clear_constrained_vertices()

void ug::ConstrainingEdge::clear_constrained_vertices ( )

inline

Referenced by ug::HangingNodeRefinerBase< TSelector >::process_constrained_vertex().

◆ constrained() [1/3]

template<>

Vertex * ug::ConstrainingEdge::constrained ( size_t ind ) const

References constrained_vertex().

◆ constrained() [2/3]

template<>

Edge * ug::ConstrainingEdge::constrained ( size_t ind ) const

References constrained_edge().

◆ constrained() [3/3]

template<class TElem >

TElem * ug::ConstrainingEdge::constrained ( size_t ind ) const

◆ constrained_edge()

Edge * ug::ConstrainingEdge::constrained_edge ( size_t ind ) const

inline

References UG_ASSERT.

Referenced by ug::HangingNodeRefinerBase< TSelector >::assign_hnode_marks(), ug::CheckElementConsistency(), ug::CheckHangingNodeConsistency(), ug::CollectConstraining(), constrained(), and ug::SelectAssociatedConstrainedElements().

◆ constrained_vertex()

Vertex * ug::ConstrainingEdge::constrained_vertex ( size_t ind ) const

inline

References UG_ASSERT.

Referenced by ug::HangingNodeRefinerBase< TSelector >::assign_hnode_marks(), ug::CheckElementConsistency(), ug::CheckHangingNodeConsistency(), ug::HangingNodeRefiner_Grid::collect_objects_for_refine(), constrained(), ug::HangingNodeRefiner_MultiGrid::perform_coarsening(), and ug::SelectAssociatedConstrainedElements().

◆ container_section()

virtual int ug::ConstrainingEdge::container_section ( ) const

inlinevirtual

Reimplemented from ug::Edge.

References ug::CSEDGE_CONSTRAINING_EDGE.

◆ create_empty_instance()

virtual GridObject * ug::ConstrainingEdge::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.

◆ is_constrained_object() [1/2]

bool ug::ConstrainingEdge::is_constrained_object ( Edge * edge )

inline

References ug::find().

◆ is_constrained_object() [2/2]

bool ug::ConstrainingEdge::is_constrained_object ( Vertex * vrt )

inline

References ug::find().

◆ is_constraining()

virtual bool ug::ConstrainingEdge::is_constraining ( ) const

inlinevirtual

returns the id of the reference-object.

returns true if the object constrains other objects. This is normally only the case for special constraining objects. The default implementation returns false.

Reimplemented from ug::GridObject.

◆ num_constrained() [1/3]

template<>

size_t ug::ConstrainingEdge::num_constrained ( ) const

References num_constrained_vertices().

◆ num_constrained() [2/3]

template<>

size_t ug::ConstrainingEdge::num_constrained ( ) const

References num_constrained_edges().

◆ num_constrained() [3/3]

template<class TElem >

size_t ug::ConstrainingEdge::num_constrained ( ) const

◆ num_constrained_edges()

size_t ug::ConstrainingEdge::num_constrained_edges ( ) const

inline

Referenced by ug::HangingNodeRefinerBase< TSelector >::assign_hnode_marks(), ug::CheckElementConsistency(), ug::CheckHangingNodeConsistency(), ug::CollectConstraining(), num_constrained(), and ug::SelectAssociatedConstrainedElements().

◆ num_constrained_vertices()

size_t ug::ConstrainingEdge::num_constrained_vertices ( ) const

inline

Referenced by ug::HangingNodeRefinerBase< TSelector >::assign_hnode_marks(), ug::CheckHangingNodeConsistency(), ug::HangingNodeRefiner_Grid::collect_objects_for_refine(), num_constrained(), ug::HangingNodeRefiner_MultiGrid::perform_coarsening(), and ug::SelectAssociatedConstrainedElements().

◆ reference_object_id()

virtual ReferenceObjectID ug::ConstrainingEdge::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::Edge.

References ug::ROID_EDGE.

◆ refine() [1/2]

bool ug::ConstrainingEdge::refine	(	std::vector< ConstrainingEdge * > &	vNewEdgesOut,
		Vertex *	newVertex,
		Vertex **	pSubstituteVrts = `NULL`
	)

non virtual refine. Returns pointers to ConstrainingEdge.

create 2 new constraining edges, connecting the original edges end-points with vrtNew. The refine has no effect on constrained objects. The user has to manually copy them.

See also: Edge::refine.

References refine().

◆ refine() [2/2]

bool ug::ConstrainingEdge::refine	(	std::vector< Edge * > &	vNewEdgesOut,
		Vertex *	newVertex,
		Vertex **	pSubstituteVrts = `NULL`
	)

virtual

virtual refine. Returns pointers to Edge.

create 2 new constraining edges, connecting the original edges end-points with vrtNew. The refine has no effect on constrained objects. The user has to manually copy them.

See also: Edge::refine.

Reimplemented from ug::Edge.

References ConstrainingEdge(), and ug::EdgeVertices::vertex().

Referenced by refine().

◆ remove_constraint_link() [1/2]

virtual void ug::ConstrainingEdge::remove_constraint_link ( const Edge * e )

inlinevirtual

removes a constraint link to the grid object.

This method is e.g. called on the constraining edges of a constrained vertex as soon as the constrained vertex is deleted.

Reimplemented from ug::GridObject.

◆ remove_constraint_link() [2/2]

virtual void ug::ConstrainingEdge::remove_constraint_link ( const Vertex * vrt )

inlinevirtual

removes a constraint link to the grid object.

This method is e.g. called on the constraining edges of a constrained vertex as soon as the constrained vertex is deleted.

Reimplemented from ug::GridObject.

◆ type_match()

static bool ug::ConstrainingEdge::type_match ( GridObject * pObj )

inlinestatic

Referenced by ug::HangingNodeRefinerBase< TSelector >::refine_edge_with_hanging_vertex().

◆ unconstrain_object() [1/2]

void ug::ConstrainingEdge::unconstrain_object ( const Edge * edge )

inline

References ug::find().

◆ unconstrain_object() [2/2]

void ug::ConstrainingEdge::unconstrain_object ( const Vertex * vrt )

inline

References ug::find().

Friends And Related Symbol Documentation

◆ Grid

friend class Grid

friend

Member Data Documentation

◆ m_constrainedEdges

std::vector<Edge*> ug::ConstrainingEdge::m_constrainedEdges

protected

◆ m_constrainedVertices

std::vector<Vertex*> ug::ConstrainingEdge::m_constrainedVertices

protected

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

ugbase/lib_grid/grid_objects/grid_objects_1d.h
ugbase/lib_grid/grid_objects/grid_objects_1d.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ConstrainingEdge() [1/3]

◆ ConstrainingEdge() [2/3]

◆ ConstrainingEdge() [3/3]

◆ ~ConstrainingEdge()

Member Function Documentation

◆ add_constrained_object() [1/2]

◆ add_constrained_object() [2/2]

◆ clear_constrained_edges()

◆ clear_constrained_objects()

◆ clear_constrained_vertices()

◆ constrained() [1/3]

◆ constrained() [2/3]

◆ constrained() [3/3]

◆ constrained_edge()

◆ constrained_vertex()

◆ container_section()

◆ create_empty_instance()

◆ is_constrained_object() [1/2]

◆ is_constrained_object() [2/2]

◆ is_constraining()

◆ num_constrained() [1/3]

◆ num_constrained() [2/3]

◆ num_constrained() [3/3]

◆ num_constrained_edges()

◆ num_constrained_vertices()

◆ reference_object_id()

◆ refine() [1/2]

◆ refine() [2/2]

◆ remove_constraint_link() [1/2]

◆ remove_constraint_link() [2/2]

◆ type_match()

◆ unconstrain_object() [1/2]

◆ unconstrain_object() [2/2]

Friends And Related Symbol Documentation

◆ Grid

Member Data Documentation

◆ m_constrainedEdges

◆ m_constrainedVertices