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

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

#include <linear.hpp>

Public Member Functions

unsigned int num_vertices ()
 Return the number of vertices contained in the domain.
void make_vertex (PointCartesian1D point)
 Create a new vertex in the domain based on the given point.
LinearCartesian1D_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.
LinearCartesian1D_Cell make_cell (LinearCartesian1D_Vertex vertex1, LinearCartesian1D_Vertex vertex2)
 Create a new cell in the segment.
list get_cells ()
 Return a Python list containing all the cells contained in the segment.
LinearCartesian1D_Domain_t & get_domain ()
 Get a reference to the ViennaGrid domain object.

Detailed Description

Domain of lines in the cartesian 1D space.

Since
0.1.0

Member Function Documentation

list LinearCartesian1D_Domain::get_cells ( )

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

Returns
Python list
Since
0.1.0
LinearCartesian1D_Domain_t & LinearCartesian1D_Domain::get_domain ( )

Get a reference to the ViennaGrid domain object.

Returns
Reference to the ViennaGrid domain object.
Since
0.1.0
LinearCartesian1D_Vertex LinearCartesian1D_Domain::get_vertex ( unsigned int  index)

Return the vertex identified by the given index.

Parameters
indexNumerical vertex ID as assigned by ViennaGrid on vertex creation.
Since
0.1.0
list LinearCartesian1D_Domain::get_vertices ( )

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

Returns
Python list
Since
0.1.0
LinearCartesian1D_Cell LinearCartesian1D_Domain::make_cell ( LinearCartesian1D_Vertex  vertex1,
LinearCartesian1D_Vertex  vertex2 
)

Create a new cell in the segment.

Parameters
vertex1
vertex2
Returns
The newly created cell.
Since
0.1.0
void LinearCartesian1D_Domain::make_vertex ( PointCartesian1D  point)

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

Parameters
pointPoint that represents the vertex. The point object will be copied.
Since
0.1.0
unsigned int LinearCartesian1D_Domain::num_cells ( )

Return the number of cells contained in the segment.

Returns
unsigned integer
Since
0.1.0
unsigned int LinearCartesian1D_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: