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

cerr(arg1)	smart standard output for error messages
cout(arg1)	smart standard output
cwarn(arg1)	smart standard output for warning message

Classes

attr	specify if xml attribute is OPTIONAL or REQUIRED
base	base class for whole granoo item
base_list	an simple un-named list of base
base_set	an advanced named list of base.
base_xset	extended version of set with additional features
beam	a mechanical spring that links two elements
beam_list	an simple un-named list of beam
beam_set	an advanced named list of beam.
beam_xset	extended version of set with additional features
body	the base class that models rigid body
body_box	A body with a given shape
body_box_list	an simple un-named list of body_box
body_box_set	an advanced named list of body_box.
body_box_xset	extended version of set with additional features
body_cone	A body with a given shape
body_cone_list	an simple un-named list of body_cone
body_cone_set	an advanced named list of body_cone.
body_cone_xset	extended version of set with additional features
body_cylinder	A body with a given shape
body_cylinder_list	an simple un-named list of body_cylinder
body_cylinder_set	an advanced named list of body_cylinder.
body_cylinder_xset	extended version of set with additional features
body_list	an simple un-named list of body
body_polyhedron	A body with a given shape
body_polyhedron_list	an simple un-named list of body_polyhedron
body_polyhedron_set	an advanced named list of body_polyhedron.
body_polyhedron_xset	extended version of set with additional features
body_set	an advanced named list of body.
body_sphere	A body with a given shape
body_sphere_list	an simple un-named list of body_sphere
body_sphere_set	an advanced named list of body_sphere.
body_sphere_xset	extended version of set with additional features
body_xset	extended version of set with additional features
bond	an abstract class that represents a link between two elements
bond_list	an simple un-named list of bond
bond_set	an advanced named list of bond.
bond_xset	extended version of set with additional features
box	a box shape defined by 3 values (lx, ly, lz)
collision_data	utility class that stores contact detection information
cone	a conical shape defined by two values (radius and length)
cylinder	a cylindrical shape defined by two values (radius and length)
discrete_element	a discrete_element is a dem element with a spherical shape
discrete_element_list	an simple un-named list of discrete_element
discrete_element_set	an advanced named list of discrete_element.
discrete_element_xset	extended version of set with additional features
disk	a surface disk shape defined by one value (radius)
domain	utility singleton class for input/output
element	abstract class for modeling a dem element.
element_box	a dem element with shape
element_box_list	an simple un-named list of element_box
element_box_set	an advanced named list of element_box.
element_box_xset	extended version of set with additional features
element_cone	a dem element with shape
element_cone_list	an simple un-named list of element_cone
element_cone_set	an advanced named list of element_cone.
element_cone_xset	extended version of set with additional features
element_cylinder	a dem element with shape
element_cylinder_list	an simple un-named list of element_cylinder
element_cylinder_set	an advanced named list of element_cylinder.
element_cylinder_xset	extended version of set with additional features
element_list	an simple un-named list of element
element_pair	utility class that makes (un-mechanical) pairs between to element
element_pair_list	an simple un-named list of element_pair
element_pair_set	an advanced named list of element_pair.
element_pair_xset	extended version of set with additional features
element_polyhedron	a dem element with shape
element_polyhedron_list	an simple un-named list of element_polyhedron
element_polyhedron_set	an advanced named list of element_polyhedron.
element_polyhedron_xset	extended version of set with additional features
element_set	an advanced named list of element.
element_sphere	a dem element with shape
element_sphere_list	an simple un-named list of element_sphere
element_sphere_set	an advanced named list of element_sphere.
element_sphere_xset	extended version of set with additional features
element_xset	extended version of set with additional features
frame	a class that model a frame
full3D	a cubic periodic boundary in full 3D
full3D_list	an simple un-named list of full3D
full3D_set	an advanced named list of full3D.
full3D_xset	extended version of set with additional features
ground	a class that model a shape that does nothing.
ground_box	A ground with a given shape
ground_box_list	an simple un-named list of ground_box
ground_box_set	an advanced named list of ground_box.
ground_box_xset	extended version of set with additional features
ground_cone	A ground with a given shape
ground_cone_list	an simple un-named list of ground_cone
ground_cone_set	an advanced named list of ground_cone.
ground_cone_xset	extended version of set with additional features
ground_cylinder	A ground with a given shape
ground_cylinder_list	an simple un-named list of ground_cylinder
ground_cylinder_set	an advanced named list of ground_cylinder.
ground_cylinder_xset	extended version of set with additional features
ground_disk	A ground with a given shape
ground_disk_list	an simple un-named list of ground_disk
ground_disk_set	an advanced named list of ground_disk.
ground_disk_xset	extended version of set with additional features
ground_plane	A ground with a given shape
ground_plane_list	an simple un-named list of ground_plane
ground_plane_set	an advanced named list of ground_plane.
ground_plane_xset	extended version of set with additional features
ground_polyhedron	A ground with a given shape
ground_polyhedron_list	an simple un-named list of ground_polyhedron
ground_polyhedron_set	an advanced named list of ground_polyhedron.
ground_polyhedron_xset	extended version of set with additional features
ground_rectangle	A ground with a given shape
ground_rectangle_list	an simple un-named list of ground_rectangle
ground_rectangle_set	an advanced named list of ground_rectangle.
ground_rectangle_xset	extended version of set with additional features
ground_sphere	A ground with a given shape
ground_sphere_list	an simple un-named list of ground_sphere
ground_sphere_set	an advanced named list of ground_sphere.
ground_sphere_xset	extended version of set with additional features
node	the base class that models a material point
node_list	an simple un-named list of node
node_set	an advanced named list of node.
node_xset	extended version of set with additional features
normal_random	A function that pick values randomly inside a given range
periodic_boundary	utility class for managing periodic boundary
plane	an infinite plane
plugin	the plugin base class
point	a class that model a point in the 3D space
polyhedron	a polyhedral shape defined through an *.off file
problem	utility singleton class for managing computation
quaternion	a quaternion able to model rigid body rotation and rotating frame operation
reader	xml reader utility class
rectangle	a surface rectangular shape defined by two values (ly, lz)
sensor	utility class for adding numerical sensors (numeric trackers)
shape2D	base class for surface shape
shape3D	base class for 3D volume shapes
sphere	a spherical shape defined by one value (radius)
spring	a mechanical spring that links two elements
spring_list	an simple un-named list of spring
spring_set	an advanced named list of spring.
spring_xset	extended version of set with additional features
strain	a class associated to element that models strain tensors
strain_list	an simple un-named list of strain
strain_set	an advanced named list of strain.
strain_xset	extended version of set with additional features
support_shape	class that model a perfect shape that contains discrete_element
support_shape_box	a support_shape with shape
support_shape_box_list	an simple un-named list of support_shape_box
support_shape_box_set	an advanced named list of support_shape_box.
support_shape_box_xset	extended version of set with additional features
support_shape_cone	a support_shape with shape
support_shape_cone_list	an simple un-named list of support_shape_cone
support_shape_cone_set	an advanced named list of support_shape_cone.
support_shape_cone_xset	extended version of set with additional features
support_shape_cylinder	a support_shape with shape
support_shape_cylinder_list	an simple un-named list of support_shape_cylinder
support_shape_cylinder_set	an advanced named list of support_shape_cylinder.
support_shape_cylinder_xset	extended version of set with additional features
support_shape_list	an simple un-named list of support_shape
support_shape_polyhedron	a support_shape with shape
support_shape_polyhedron_list	an simple un-named list of support_shape_polyhedron
support_shape_polyhedron_set	an advanced named list of support_shape_polyhedron.
support_shape_polyhedron_xset	extended version of set with additional features
support_shape_set	an advanced named list of support_shape.
support_shape_sphere	a support_shape with shape
support_shape_sphere_list	an simple un-named list of support_shape_sphere
support_shape_sphere_set	an advanced named list of support_shape_sphere.
support_shape_sphere_xset	extended version of set with additional features
support_shape_xset	extended version of set with additional features
sym_tensor	a symmetric tensor in the 3x3 matrix form, that accepts changing frame operation
tensor	a tensor in the 3x3 matrix form, that accepts changing frame operation
thermal	a class associated to element that models thermal properties
thermal_list	an simple un-named list of thermal
thermal_set	an advanced named list of thermal.
thermal_xset	extended version of set with additional features
time	utility class for time and iteration management
tool	A tool is a single body that may interacts with discrete_element
tool_box	a dem tool with shape
tool_box_list	an simple un-named list of tool_box
tool_box_set	an advanced named list of tool_box.
tool_box_xset	extended version of set with additional features
tool_cone	a dem tool with shape
tool_cone_list	an simple un-named list of tool_cone
tool_cone_set	an advanced named list of tool_cone.
tool_cone_xset	extended version of set with additional features
tool_cylinder	a dem tool with shape
tool_cylinder_list	an simple un-named list of tool_cylinder
tool_cylinder_set	an advanced named list of tool_cylinder.
tool_cylinder_xset	extended version of set with additional features
tool_list	an simple un-named list of tool
tool_polyhedron	a dem tool with shape
tool_polyhedron_list	an simple un-named list of tool_polyhedron
tool_polyhedron_set	an advanced named list of tool_polyhedron.
tool_polyhedron_xset	extended version of set with additional features
tool_set	an advanced named list of tool.
tool_sphere	a dem tool with shape
tool_sphere_list	an simple un-named list of tool_sphere
tool_sphere_set	an advanced named list of tool_sphere.
tool_sphere_xset	extended version of set with additional features
tool_xset	extended version of set with additional features
uni_random	A function that pick values randomly inside a given range
vector	an euclidean vector
viewer	utility singleton class for granoo viewer

Class Inheritance Diagram