ViennaGrid for Python
 All Classes Files Functions Variables
Public Member Functions | List of all members
TriangularPolar2D_Segment Class Reference

Wrapped segment of a triangular, polar domain. More...

#include <triangular.hpp>

Public Member Functions

 TriangularPolar2D_Segment (TriangularPolar2D_Segment_t &initial_segment, TriangularPolar2D_Segmentation &initial_segmentation)
unsigned int num_cells ()
 Return the number of cells contained in the segment.
TriangularPolar2D_Cell make_cell (TriangularPolar2D_Vertex vertex1, TriangularPolar2D_Vertex vertex2, TriangularPolar2D_Vertex vertex3)
 Create a new cell in the segment.
list get_cells ()
 Return a Python list containing all the cells contained in the segment.
TriangularPolar2D_Segment_t & get_segment ()
 Get a reference to the ViennaGrind segment object.

Detailed Description

Wrapped segment of a triangular, polar domain.

Since
0.1.0

Member Function Documentation

list TriangularPolar2D_Segment::get_cells ( )

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

Returns
Python list
Since
0.1.0
TriangularPolar2D_Segment_t & TriangularPolar2D_Segment::get_segment ( )

Get a reference to the ViennaGrind segment object.

Returns
Reference to the ViennaGrid segment object.
Since
0.1.0
TriangularPolar2D_Cell TriangularPolar2D_Segment::make_cell ( TriangularPolar2D_Vertex  vertex1,
TriangularPolar2D_Vertex  vertex2,
TriangularPolar2D_Vertex  vertex3 
)

Create a new cell in the segment.

Parameters
vertex1
vertex2
vertex3
Returns
The newly created cell.
Since
0.1.0
unsigned int TriangularPolar2D_Segment::num_cells ( )

Return the number of cells contained in the segment.

Returns
unsigned integer
Since
0.1.0

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