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

Wrapped segment of a linear, cartesian 3D domain. More...

#include <linear.hpp>

Public Member Functions

 LinearCartesian3D_Segment (LinearCartesian3D_Segment_t &initial_segment, LinearCartesian3D_Segmentation &initial_segmentation)
unsigned int num_cells ()
 Return the number of cells contained in the segment.
LinearCartesian3D_Cell make_cell (LinearCartesian3D_Vertex vertex1, LinearCartesian3D_Vertex vertex2)
 Create a new cell in the segment.
list get_cells ()
 Return a Python list containing all the cells contained in the segment.
LinearCartesian3D_Segment_t & get_segment ()
 Get a reference to the ViennaGrind segment object.

Detailed Description

Wrapped segment of a linear, cartesian 3D domain.

Since
0.1.0

Member Function Documentation

list LinearCartesian3D_Segment::get_cells ( )

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

Returns
Python list
Since
0.1.0
LinearCartesian3D_Segment_t & LinearCartesian3D_Segment::get_segment ( )

Get a reference to the ViennaGrind segment object.

Returns
Reference to the ViennaGrid segment object.
Since
0.1.0
LinearCartesian3D_Cell LinearCartesian3D_Segment::make_cell ( LinearCartesian3D_Vertex  vertex1,
LinearCartesian3D_Vertex  vertex2 
)

Create a new cell in the segment.

Parameters
vertex1
vertex2
Returns
The newly created cell.
Since
0.1.0
unsigned int LinearCartesian3D_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: