platonic solid with eight faces. More...

#include <grid_objects_3d.h>

Inheritance diagram for ug::Octahedron:

Public Types
typedef Volume	BaseClass

Public Types inherited from ug::Volume
typedef Volume	grid_base_object

typedef void	higher_dim_base_object

typedef Face	lower_dim_base_object

typedef Face	side

typedef Volume	sideof

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

Public Member Functions
virtual bool	collapse_edge (std::vector< Volume * > &vNewVolumesOut, int edgeIndex, Vertex newVertex, std::vector< Vertex > *pvSubstituteVertices=NULL)

virtual int	container_section () const

virtual Edge *	create_edge (int index)
	create the edge with index i and return it. More...

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

virtual Face *	create_face (int index)
	create the face with index i and return it. More...

virtual EdgeDescriptor	edge_desc (int index) const

virtual void	edge_desc (int index, EdgeDescriptor &edOut) const

virtual FaceDescriptor	face_desc (int index) const

virtual void	face_desc (int index, FaceDescriptor &fdOut) const

virtual int	get_edge_index_from_vertices (const size_t vi0, const size_t vi1) const
	returns the local index of the edge which connects the two vertex indices. More...

virtual int	get_face_edge_index (const size_t faceInd, const size_t faceEdgeInd) const
	returns the local index of the j-th edge of the i-th face of the volume More...

virtual void	get_flipped_orientation (VolumeDescriptor &vdOut) const

virtual std::pair< GridBaseObjectId, int >	get_opposing_object (Vertex *vrt) const
	returns an index to the obbject, which lies on the opposite side of the volume to the given vertex. More...

virtual void	get_vertex_indices_of_edge (size_t &ind1Out, size_t &ind2Out, size_t edgeInd) const
	returns the local indices of an edge of the volume. More...

virtual void	get_vertex_indices_of_face (std::vector< size_t > &indsOut, size_t side) const
	returns the local indices of a face of the volume. More...

virtual bool	is_regular_ref_rule (int edgeMarks) const
	returns true if the specified edgeMarks would lead to a regular refinement More...

virtual uint	num_edges () const

virtual uint	num_faces () const

virtual size_t	num_vertices () const

	Octahedron ()

	Octahedron (const OctahedronDescriptor &td)

	Octahedron (Vertex v1, Vertex v2, Vertex v3, Vertex v4, Vertex v5, Vertex v6)

virtual ReferenceObjectID	reference_object_id () const

virtual bool	refine (std::vector< Volume * > &vNewVolumesOut, Vertex ppNewVertexOut, Vertex newEdgeVertices, Vertex *newFaceVertices, Vertex newVolumeVertex, const Vertex &prototypeVertex, Vertex *pSubstituteVertices=NULL, vector3 corners=NULL, bool *isSnapPoint=NULL)
	Creates new volume elements through refinement. More...

virtual Vertex *	vertex (size_t index) const

virtual ConstVertexArray	vertices () const

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

int	get_local_side_index (FaceVertices *f) const
	returns the local index of the given face or -1, if the face is not part of the volume. More...

virtual bool	get_opposing_side (FaceVertices *f, FaceDescriptor &fdOut) const
	retrieves the face-descriptor for the opposing side to the specified one. More...

uint	num_sides () const

virtual	~Volume ()

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

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

size_t	size () const
	returns the number of vertices. More...

virtual	~VolumeVertices ()

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

size_t	size () const
	returns the number of vertices. More...

virtual	~IVertexGroup ()

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

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

Static Public Attributes
static const size_t	NUM_VERTICES = 6

Static Public Attributes inherited from ug::Volume
static const int	BASE_OBJECT_ID = VOLUME

static const bool	CAN_BE_SIDE = false

static const int	dim = 3
	reference dimension More...

static const bool	HAS_SIDES = true

Protected Member Functions
virtual 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! More...

Protected Attributes
Vertex *	m_vertices [6]

Protected Attributes inherited from ug::GridObject
uint	m_gridDataIndex

Detailed Description

platonic solid with eight faces.

order of vertices should be the same as described in

See also: OctahedronDescriptor

Member Typedef Documentation

◆ BaseClass

typedef Volume ug::Octahedron::BaseClass

Constructor & Destructor Documentation

◆ Octahedron() [1/3]

ug::Octahedron::Octahedron ( )

inline

◆ Octahedron() [2/3]

ug::Octahedron::Octahedron ( const OctahedronDescriptor & td )

References ug::OctahedronDescriptor::vertex().

◆ Octahedron() [3/3]

ug::Octahedron::Octahedron	(	Vertex *	v1,
		Vertex *	v2,
		Vertex *	v3,
		Vertex *	v4,
		Vertex *	v5,
		Vertex *	v6
	)

Member Function Documentation

◆ collapse_edge()

bool ug::Octahedron::collapse_edge	(	std::vector< Volume * > &	vNewVolumesOut,
		int	edgeIndex,
		Vertex *	newVertex,
		std::vector< Vertex * > *	pvSubstituteVertices = `NULL`
	)

virtual

The collapse_edge method creates new geometric objects by collapsing the specified edge. The user that calls this function is responsible to either register the new volumes with a grid (the grid from which the vertices are), or to take responsibility for deletion of the acquired memory (delete each element in vNewFacesOut).

edgeIndex specifies the edge which shall be collapsed. edgeIndex has to lie between 0 and this->num_edges().
Vertices adjacent to the collapsed edge will be replaced by newVertex.
If you specify pvSubstituteVertices, the created volumes will reference the vertices in pvSubstituteVertices. Note that pvSubstituteVertices has to contain exactly as many vertices as the volume in which you collapse the edge. Vertices with the same index correlate.

Reimplemented from ug::Volume.

References UG_LOG.

◆ container_section()

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

inlinevirtual

Reimplemented from ug::Volume.

References ug::CSVOL_OCTAHEDRON.

◆ create_edge()

Edge * ug::Octahedron::create_edge ( int index )

virtual

create the edge with index i and return it.

Reimplemented from ug::Volume.

References ug::hex_rules::EDGE_VRT_INDS, and ug::hex_rules::NUM_EDGES.

◆ create_empty_instance()

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

◆ create_face()

Face * ug::Octahedron::create_face ( int index )

virtual

create the face with index i and return it.

Reimplemented from ug::Volume.

References ug::hex_rules::FACE_VRT_INDS, and ug::hex_rules::NUM_FACES.

◆ edge_desc() [1/2]

EdgeDescriptor ug::Octahedron::edge_desc ( int index ) const

virtual

Reimplemented from ug::Volume.

◆ edge_desc() [2/2]

void ug::Octahedron::edge_desc	(	int	index,
		EdgeDescriptor &	edOut
	)		const

virtual

Reimplemented from ug::Volume.

References ug::hex_rules::EDGE_VRT_INDS, ug::hex_rules::NUM_EDGES, and ug::EdgeDescriptor::set_vertices().

◆ face_desc() [1/2]

FaceDescriptor ug::Octahedron::face_desc ( int index ) const

virtual

Reimplemented from ug::Volume.

◆ face_desc() [2/2]

void ug::Octahedron::face_desc	(	int	index,
		FaceDescriptor &	fdOut
	)		const

virtual

Reimplemented from ug::Volume.

References ug::hex_rules::FACE_VRT_INDS, ug::hex_rules::NUM_FACES, ug::FaceDescriptor::set_num_vertices(), and ug::FaceDescriptor::set_vertex().

◆ get_edge_index_from_vertices()

int ug::Octahedron::get_edge_index_from_vertices	(	const size_t	vi0,
		const size_t	vi1
	)		const

virtual

returns the local index of the edge which connects the two vertex indices.

Default implementation throws a UGError

Reimplemented from ug::Volume.

References ug::hex_rules::EDGE_FROM_VRTS.

◆ get_face_edge_index()

int ug::Octahedron::get_face_edge_index	(	const size_t	faceInd,
		const size_t	faceEdgeInd
	)		const

virtual

returns the local index of the j-th edge of the i-th face of the volume

Default implementation throws a UGError

Reimplemented from ug::Volume.

References ug::hex_rules::FACE_EDGE_INDS.

◆ get_flipped_orientation()

void ug::Octahedron::get_flipped_orientation ( VolumeDescriptor & vdOut ) const

virtual

Writes vertices to the volume-descriptor so that it defines a volume with flipped orientation. If you want to flip the orientation of a volume in a grid, please consider using the grids flip_orientation method.

Please note: The default implementation returns the original volume and has to be reimplemented by derived classes.

Reimplemented from ug::Volume.

References ug::VolumeDescriptor::set_num_vertices(), and ug::VolumeDescriptor::set_vertex().

◆ get_opposing_object()

std::pair< GridBaseObjectId, int > ug::Octahedron::get_opposing_object ( Vertex * vrt ) const

virtual

returns an index to the obbject, which lies on the opposite side of the volume to the given vertex.

The method returs a pair <GridBaseObjectId, int>, where GridBaseObjectId is either VERTEX, EDGE, or FACE and where the second entry specifies the local index of the object in the given volume.

Reimplemented from ug::Volume.

References ug::hex_rules::NUM_VERTICES, ug::hex_rules::OPPOSED_OBJECT, and UG_THROW.

◆ get_vertex_indices_of_edge()

void ug::Octahedron::get_vertex_indices_of_edge	(	size_t &	ind1Out,
		size_t &	ind2Out,
		size_t	edgeInd
	)		const

virtual

returns the local indices of an edge of the volume.

Default implementation throws a UGError

Reimplemented from ug::Volume.

References ug::hex_rules::EDGE_VRT_INDS, and ug::hex_rules::NUM_EDGES.

◆ get_vertex_indices_of_face()

void ug::Octahedron::get_vertex_indices_of_face	(	std::vector< size_t > &	indsOut,
		size_t	side
	)		const

virtual

returns the local indices of a face of the volume.

Default implementation throws a UGError

Reimplemented from ug::Volume.

References ug::hex_rules::FACE_VRT_INDS, and ug::hex_rules::NUM_FACES.

◆ is_regular_ref_rule()

bool ug::Octahedron::is_regular_ref_rule ( int edgeMarks ) const

virtual

returns true if the specified edgeMarks would lead to a regular refinement

A regular refinement leads to new elements which are all similar to the original element. I.e. which are of the same type and which have similar angles.

Note: this method does not perform refinement. Use 'refine' with the specified edges instead.

Parameters

edgeMarks If the i-th edge shall be refined, the expression 'edgeMarks & (1<<i) != 0' has to be true. You can specify multiple refine-edges using or-combinations: 'edgeMarks = (1<<i) | (1<<j)' would indicate that the i-th and the j-th edge shall be refined.

Reimplemented from ug::Volume.

References ug::hex_rules::IsRegularRefRule().

◆ num_edges()

uint ug::Octahedron::num_edges ( ) const

virtual

Reimplemented from ug::Volume.

◆ num_faces()

uint ug::Octahedron::num_faces ( ) const

virtual

Reimplemented from ug::Volume.

◆ num_vertices()

virtual size_t ug::Octahedron::num_vertices ( ) const

inlinevirtual

Reimplemented from ug::VolumeVertices.

◆ reference_object_id()

virtual ReferenceObjectID ug::Octahedron::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::Volume.

References ug::ROID_OCTAHEDRON.

◆ refine()

bool ug::Octahedron::refine	(	std::vector< Volume * > &	vNewVolumesOut,
		Vertex **	ppNewVertexOut,
		Vertex **	newEdgeVertices,
		Vertex **	newFaceVertices,
		Vertex *	newVolumeVertex,
		const Vertex &	prototypeVertex,
		Vertex **	pSubstituteVertices = `NULL`,
		vector3 *	corners = `NULL`,
		bool *	isSnapPoint = `NULL`
	)

virtual

Creates new volume elements through refinement.

Make sure that newEdgeVertices contains 6 vertex pointers. newFaceVertices is ignored for Octahedrons.

Reimplemented from ug::Volume.

References ug::Refine().

◆ set_vertex()

virtual void ug::Octahedron::set_vertex	(	uint	index,
		Vertex *	pVrt
	)

inlineprotectedvirtual

creates the volumes that result from the splitting of the edge with index 'splitEdgeIndex'. creates the volumes that result from the collapsing of the edge with index 'splitEdgeIndex'.

Reimplemented from ug::Volume.

◆ type_match()

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

inlinestatic

◆ vertex()

virtual Vertex* ug::Octahedron::vertex ( size_t index ) const

inlinevirtual

Reimplemented from ug::VolumeVertices.

Referenced by ug::CalculateVolume(), and ug::SplitOctahedronToTetrahedrons().

◆ vertices()

virtual ConstVertexArray ug::Octahedron::vertices ( ) const

inlinevirtual

Reimplemented from ug::VolumeVertices.

Member Data Documentation

◆ m_vertices

Vertex* ug::Octahedron::m_vertices[6]

protected

◆ NUM_VERTICES

const size_t ug::Octahedron::NUM_VERTICES = 6

static

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

ugbase/lib_grid/grid_objects/grid_objects_3d.h
ugbase/lib_grid/grid_objects/grid_objects_3d.cpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ BaseClass

Constructor & Destructor Documentation

◆ Octahedron() [1/3]

◆ Octahedron() [2/3]

◆ Octahedron() [3/3]

Member Function Documentation

◆ collapse_edge()

◆ container_section()

◆ create_edge()

◆ create_empty_instance()

◆ create_face()

◆ edge_desc() [1/2]

◆ edge_desc() [2/2]

◆ face_desc() [1/2]

◆ face_desc() [2/2]

◆ get_edge_index_from_vertices()

◆ get_face_edge_index()

◆ get_flipped_orientation()

◆ get_opposing_object()

◆ get_vertex_indices_of_edge()

◆ get_vertex_indices_of_face()

◆ is_regular_ref_rule()

◆ num_edges()

◆ num_faces()

◆ num_vertices()

◆ reference_object_id()

◆ refine()

◆ set_vertex()

◆ type_match()

◆ vertex()

◆ vertices()

Member Data Documentation

◆ m_vertices

◆ NUM_VERTICES