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

Wrapped segmentation of a linear, cylindrical domain. More...

#include <linear.hpp>

Public Member Functions

 LinearCylindrical3D_Segmentation (LinearCylindrical3D_Domain &dom)
unsigned int num_segments ()
 Return the number of segments that form the segmentation.
LinearCylindrical3D_Segment make_segment ()
 Create a new segment in the segmentation.
list get_segments ()
 Return a Python list containing all the segments that form the segmentation.
LinearCylindrical3D_Domain_t & get_domain ()
 Get a reference to the ViennaGrid domain object to which the segmentation corresponds.
LinearCylindrical3D_Segmentation_t & get_segmentation ()
 Get a reference to the ViennaGrind segmentation object.

Detailed Description

Wrapped segmentation of a linear, cylindrical domain.

Since
0.1.0

Member Function Documentation

LinearCylindrical3D_Domain_t & LinearCylindrical3D_Segmentation::get_domain ( )

Get a reference to the ViennaGrid domain object to which the segmentation corresponds.

Returns
Reference to the ViennaGrid domain object to which the segmentation corresponds.
Since
0.1.0
LinearCylindrical3D_Segmentation_t & LinearCylindrical3D_Segmentation::get_segmentation ( )

Get a reference to the ViennaGrind segmentation object.

Returns
Reference to the ViennaGrid segmentation object.
Since
0.1.0
list LinearCylindrical3D_Segmentation::get_segments ( )

Return a Python list containing all the segments that form the segmentation.

Returns
Python list
Since
0.1.0
LinearCylindrical3D_Segment LinearCylindrical3D_Segmentation::make_segment ( )

Create a new segment in the segmentation.

Returns
The newly created segment.
Since
0.1.0
unsigned int LinearCylindrical3D_Segmentation::num_segments ( )

Return the number of segments that form the segmentation.

Returns
unsigned integer
Since
0.1.0

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