TriangularCartesian3D_Domain Class Reference

Domain of lines in the cartesian 3D space. More...

#include <triangular.hpp>

Public Member Functions
unsigned int	num_vertices ()
	Return the number of vertices contained in the domain.
void	make_vertex (PointCartesian3D point)
	Create a new vertex in the domain based on the given point.
TriangularCartesian3D_Vertex	get_vertex (unsigned int index)
	Return the vertex identified by the given index.
list	get_vertices ()
	Return a Python list containing all the vertices of the domain.
unsigned int	num_cells ()
	Return the number of cells contained in the segment.
TriangularCartesian3D_Cell	make_cell (TriangularCartesian3D_Vertex vertex1, TriangularCartesian3D_Vertex vertex2, TriangularCartesian3D_Vertex vertex3)
	Create a new cell in the segment.
list	get_cells ()
	Return a Python list containing all the cells contained in the segment.
TriangularCartesian3D_Domain_t &	get_domain ()
	Get a reference to the ViennaGrid domain object.

Detailed Description

Domain of lines in the cartesian 3D space.

Since

0.1.0

Member Function Documentation

list TriangularCartesian3D_Domain::get_cells

(

)

Return a Python list containing all the cells contained in the segment.

Returns

Python list

Since

0.1.0

TriangularCartesian3D_Domain_t & TriangularCartesian3D_Domain::get_domain

(

)

Get a reference to the ViennaGrid domain object.

Returns

Reference to the ViennaGrid domain object.

Since

0.1.0

TriangularCartesian3D_Vertex TriangularCartesian3D_Domain::get_vertex

(

unsigned int

index

)

Return the vertex identified by the given index.

Parameters

index

Numerical vertex ID as assigned by ViennaGrid on vertex creation.

Since

0.1.0

list TriangularCartesian3D_Domain::get_vertices

(

)

Return a Python list containing all the vertices of the domain.

Returns

Python list

Since

0.1.0

TriangularCartesian3D_Cell TriangularCartesian3D_Domain::make_cell	(	TriangularCartesian3D_Vertex	vertex1,
		TriangularCartesian3D_Vertex	vertex2,
		TriangularCartesian3D_Vertex	vertex3
	)

Create a new cell in the segment.

Parameters

vertex1
vertex2
vertex3

Returns

The newly created cell.

Since

0.1.0

void TriangularCartesian3D_Domain::make_vertex

(

PointCartesian3D

point

)

Create a new vertex in the domain based on the given point.

Parameters

point

Point that represents the vertex. The point object will be copied.

Since

0.1.0

unsigned int TriangularCartesian3D_Domain::num_cells

(

)

Return the number of cells contained in the segment.

Returns

unsigned integer

Since

0.1.0

unsigned int TriangularCartesian3D_Domain::num_vertices

(

)

Return the number of vertices contained in the domain.

Returns

unsigned integer

Since

0.1.0

---

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

• /home/jonancm/Documentos/GSoC 2013/viennagrid-python/src/domains/triangular.hpp
• /home/jonancm/Documentos/GSoC 2013/viennagrid-python/src/domains/triangular.cpp