Welcome to granoo’s Python bindings documentation
Here, you can find the documentation of the GranOO’s Python bindings from the C++ API. The Python bindings offer a simple interface to the C++ GranOO API. For using Python bindings, you just need to invoke the lib module of the granoo3 python package.
`
import granoo3.lib as granoo
`
The following documentation is related to the content of the granoo3.lib module.
granoo3.lib Module
pygranoo3 (or granoo3.lib) is the granoo python bindings for the C++ granoo’s API
Functions
|
smart standard output for error messages |
|
smart standard output |
|
smart standard output for warning message |
Classes
specify if xml attribute is OPTIONAL or REQUIRED |
|
base class for whole granoo item |
|
an simple un-named list of base |
|
an advanced named list of base. |
|
extended version of set with additional features |
|
a mechanical spring that links two elements |
|
an simple un-named list of beam |
|
an advanced named list of beam. |
|
extended version of set with additional features |
|
the base class that models rigid body |
|
A body with a given shape |
|
an simple un-named list of body_box |
|
an advanced named list of body_box. |
|
extended version of set with additional features |
|
A body with a given shape |
|
an simple un-named list of body_cone |
|
an advanced named list of body_cone. |
|
extended version of set with additional features |
|
A body with a given shape |
|
an simple un-named list of body_cylinder |
|
an advanced named list of body_cylinder. |
|
extended version of set with additional features |
|
an simple un-named list of body |
|
A body with a given shape |
|
an simple un-named list of body_polyhedron |
|
an advanced named list of body_polyhedron. |
|
extended version of set with additional features |
|
an advanced named list of body. |
|
A body with a given shape |
|
an simple un-named list of body_sphere |
|
an advanced named list of body_sphere. |
|
extended version of set with additional features |
|
extended version of set with additional features |
|
an abstract class that represents a link between two elements |
|
an simple un-named list of bond |
|
an advanced named list of bond. |
|
extended version of set with additional features |
|
a box shape defined by 3 values (lx, ly, lz) |
|
utility class that stores contact detection information |
|
a conical shape defined by two values (radius and length) |
|
a cylindrical shape defined by two values (radius and length) |
|
a discrete_element is a dem element with a spherical shape |
|
an simple un-named list of discrete_element |
|
an advanced named list of discrete_element. |
|
extended version of set with additional features |
|
a surface disk shape defined by one value (radius) |
|
utility singleton class for input/output |
|
abstract class for modeling a dem element. |
|
a dem element with shape |
|
an simple un-named list of element_box |
|
an advanced named list of element_box. |
|
extended version of set with additional features |
|
a dem element with shape |
|
an simple un-named list of element_cone |
|
an advanced named list of element_cone. |
|
extended version of set with additional features |
|
a dem element with shape |
|
an simple un-named list of element_cylinder |
|
an advanced named list of element_cylinder. |
|
extended version of set with additional features |
|
an simple un-named list of element |
|
utility class that makes (un-mechanical) pairs between to element |
|
an simple un-named list of element_pair |
|
an advanced named list of element_pair. |
|
extended version of set with additional features |
|
a dem element with shape |
|
an simple un-named list of element_polyhedron |
|
an advanced named list of element_polyhedron. |
|
extended version of set with additional features |
|
an advanced named list of element. |
|
a dem element with shape |
|
an simple un-named list of element_sphere |
|
an advanced named list of element_sphere. |
|
extended version of set with additional features |
|
extended version of set with additional features |
|
a class that model a frame |
|
a cubic periodic boundary in full 3D |
|
an simple un-named list of full3D |
|
an advanced named list of full3D. |
|
extended version of set with additional features |
|
a class that model a shape that does nothing. |
|
A ground with a given shape |
|
an simple un-named list of ground_box |
|
an advanced named list of ground_box. |
|
extended version of set with additional features |
|
A ground with a given shape |
|
an simple un-named list of ground_cone |
|
an advanced named list of ground_cone. |
|
extended version of set with additional features |
|
A ground with a given shape |
|
an simple un-named list of ground_cylinder |
|
an advanced named list of ground_cylinder. |
|
extended version of set with additional features |
|
A ground with a given shape |
|
an simple un-named list of ground_disk |
|
an advanced named list of ground_disk. |
|
extended version of set with additional features |
|
A ground with a given shape |
|
an simple un-named list of ground_plane |
|
an advanced named list of ground_plane. |
|
extended version of set with additional features |
|
A ground with a given shape |
|
an simple un-named list of ground_polyhedron |
|
an advanced named list of ground_polyhedron. |
|
extended version of set with additional features |
|
A ground with a given shape |
|
an simple un-named list of ground_rectangle |
|
an advanced named list of ground_rectangle. |
|
extended version of set with additional features |
|
A ground with a given shape |
|
an simple un-named list of ground_sphere |
|
an advanced named list of ground_sphere. |
|
extended version of set with additional features |
|
the base class that models a material point |
|
an simple un-named list of node |
|
an advanced named list of node. |
|
extended version of set with additional features |
|
A function that pick values randomly inside a given range |
|
utility class for managing periodic boundary |
|
an infinite plane |
|
the plugin base class |
|
a class that model a point in the 3D space |
|
a polyhedral shape defined through an *.off file |
|
utility singleton class for managing computation |
|
a quaternion able to model rigid body rotation and rotating frame operation |
|
xml reader utility class |
|
a surface rectangular shape defined by two values (ly, lz) |
|
utility class for adding numerical sensors (numeric trackers) |
|
base class for surface shape |
|
base class for 3D volume shapes |
|
a spherical shape defined by one value (radius) |
|
a mechanical spring that links two elements |
|
an simple un-named list of spring |
|
an advanced named list of spring. |
|
extended version of set with additional features |
|
a class associated to element that models strain tensors |
|
an simple un-named list of strain |
|
an advanced named list of strain. |
|
extended version of set with additional features |
|
class that model a perfect shape that contains discrete_element |
|
a support_shape with shape |
|
an simple un-named list of support_shape_box |
|
an advanced named list of support_shape_box. |
|
extended version of set with additional features |
|
a support_shape with shape |
|
an simple un-named list of support_shape_cone |
|
an advanced named list of support_shape_cone. |
|
extended version of set with additional features |
|
a support_shape with shape |
|
an simple un-named list of support_shape_cylinder |
|
an advanced named list of support_shape_cylinder. |
|
extended version of set with additional features |
|
an simple un-named list of support_shape |
|
a support_shape with shape |
|
an simple un-named list of support_shape_polyhedron |
|
an advanced named list of support_shape_polyhedron. |
|
extended version of set with additional features |
|
an advanced named list of support_shape. |
|
a support_shape with shape |
|
an simple un-named list of support_shape_sphere |
|
an advanced named list of support_shape_sphere. |
|
extended version of set with additional features |
|
extended version of set with additional features |
|
a symmetric tensor in the 3x3 matrix form, that accepts changing frame operation |
|
a tensor in the 3x3 matrix form, that accepts changing frame operation |
|
a class associated to element that models thermal properties |
|
an simple un-named list of thermal |
|
an advanced named list of thermal. |
|
extended version of set with additional features |
|
utility class for time and iteration management |
|
A tool is a single body that may interacts with discrete_element |
|
a dem tool with shape |
|
an simple un-named list of tool_box |
|
an advanced named list of tool_box. |
|
extended version of set with additional features |
|
a dem tool with shape |
|
an simple un-named list of tool_cone |
|
an advanced named list of tool_cone. |
|
extended version of set with additional features |
|
a dem tool with shape |
|
an simple un-named list of tool_cylinder |
|
an advanced named list of tool_cylinder. |
|
extended version of set with additional features |
|
an simple un-named list of tool |
|
a dem tool with shape |
|
an simple un-named list of tool_polyhedron |
|
an advanced named list of tool_polyhedron. |
|
extended version of set with additional features |
|
an advanced named list of tool. |
|
a dem tool with shape |
|
an simple un-named list of tool_sphere |
|
an advanced named list of tool_sphere. |
|
extended version of set with additional features |
|
extended version of set with additional features |
|
A function that pick values randomly inside a given range |
|
an euclidean vector |
|
utility singleton class for granoo viewer |
Class Inheritance Diagram
