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

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

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

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

Inheritance diagram of granoo3.lib.attr, granoo3.lib.base, granoo3.lib.base_list, granoo3.lib.base_set, granoo3.lib.base_xset, granoo3.lib.beam, granoo3.lib.beam_list, granoo3.lib.beam_set, granoo3.lib.beam_xset, granoo3.lib.body, granoo3.lib.body_box, granoo3.lib.body_box_list, granoo3.lib.body_box_set, granoo3.lib.body_box_xset, granoo3.lib.body_cone, granoo3.lib.body_cone_list, granoo3.lib.body_cone_set, granoo3.lib.body_cone_xset, granoo3.lib.body_cylinder, granoo3.lib.body_cylinder_list, granoo3.lib.body_cylinder_set, granoo3.lib.body_cylinder_xset, granoo3.lib.body_list, granoo3.lib.body_polyhedron, granoo3.lib.body_polyhedron_list, granoo3.lib.body_polyhedron_set, granoo3.lib.body_polyhedron_xset, granoo3.lib.body_set, granoo3.lib.body_sphere, granoo3.lib.body_sphere_list, granoo3.lib.body_sphere_set, granoo3.lib.body_sphere_xset, granoo3.lib.body_xset, granoo3.lib.bond, granoo3.lib.bond_list, granoo3.lib.bond_set, granoo3.lib.bond_xset, granoo3.lib.box, granoo3.lib.collision_data, granoo3.lib.cone, granoo3.lib.cylinder, granoo3.lib.discrete_element, granoo3.lib.discrete_element_list, granoo3.lib.discrete_element_set, granoo3.lib.discrete_element_xset, granoo3.lib.disk, granoo3.lib.domain, granoo3.lib.element, granoo3.lib.element_box, granoo3.lib.element_box_list, granoo3.lib.element_box_set, granoo3.lib.element_box_xset, granoo3.lib.element_cone, granoo3.lib.element_cone_list, granoo3.lib.element_cone_set, granoo3.lib.element_cone_xset, granoo3.lib.element_cylinder, granoo3.lib.element_cylinder_list, granoo3.lib.element_cylinder_set, granoo3.lib.element_cylinder_xset, granoo3.lib.element_list, granoo3.lib.element_pair, granoo3.lib.element_pair_list, granoo3.lib.element_pair_set, granoo3.lib.element_pair_xset, granoo3.lib.element_polyhedron, granoo3.lib.element_polyhedron_list, granoo3.lib.element_polyhedron_set, granoo3.lib.element_polyhedron_xset, granoo3.lib.element_set, granoo3.lib.element_sphere, granoo3.lib.element_sphere_list, granoo3.lib.element_sphere_set, granoo3.lib.element_sphere_xset, granoo3.lib.element_xset, granoo3.lib.frame, granoo3.lib.ground, granoo3.lib.ground_box, granoo3.lib.ground_box_list, granoo3.lib.ground_box_set, granoo3.lib.ground_box_xset, granoo3.lib.ground_cone, granoo3.lib.ground_cone_list, granoo3.lib.ground_cone_set, granoo3.lib.ground_cone_xset, granoo3.lib.ground_cylinder, granoo3.lib.ground_cylinder_list, granoo3.lib.ground_cylinder_set, granoo3.lib.ground_cylinder_xset, granoo3.lib.ground_disk, granoo3.lib.ground_disk_list, granoo3.lib.ground_disk_set, granoo3.lib.ground_disk_xset, granoo3.lib.ground_plane, granoo3.lib.ground_plane_list, granoo3.lib.ground_plane_set, granoo3.lib.ground_plane_xset, granoo3.lib.ground_polyhedron, granoo3.lib.ground_polyhedron_list, granoo3.lib.ground_polyhedron_set, granoo3.lib.ground_polyhedron_xset, granoo3.lib.ground_rectangle, granoo3.lib.ground_rectangle_list, granoo3.lib.ground_rectangle_set, granoo3.lib.ground_rectangle_xset, granoo3.lib.ground_sphere, granoo3.lib.ground_sphere_list, granoo3.lib.ground_sphere_set, granoo3.lib.ground_sphere_xset, granoo3.lib.node, granoo3.lib.node_list, granoo3.lib.node_set, granoo3.lib.node_xset, granoo3.lib.normal_random, granoo3.lib.plane, granoo3.lib.plugin, granoo3.lib.point, granoo3.lib.polyhedron, granoo3.lib.problem, granoo3.lib.quaternion, granoo3.lib.reader, granoo3.lib.rectangle, granoo3.lib.sensor, granoo3.lib.shape2D, granoo3.lib.shape3D, granoo3.lib.sphere, granoo3.lib.spring, granoo3.lib.spring_list, granoo3.lib.spring_set, granoo3.lib.spring_xset, granoo3.lib.strain, granoo3.lib.strain_list, granoo3.lib.strain_set, granoo3.lib.strain_xset, granoo3.lib.sym_tensor, granoo3.lib.tensor, granoo3.lib.thermal, granoo3.lib.thermal_list, granoo3.lib.thermal_set, granoo3.lib.thermal_xset, granoo3.lib.time, granoo3.lib.tool, granoo3.lib.tool_box, granoo3.lib.tool_box_list, granoo3.lib.tool_box_set, granoo3.lib.tool_box_xset, granoo3.lib.tool_cone, granoo3.lib.tool_cone_list, granoo3.lib.tool_cone_set, granoo3.lib.tool_cone_xset, granoo3.lib.tool_cylinder, granoo3.lib.tool_cylinder_list, granoo3.lib.tool_cylinder_set, granoo3.lib.tool_cylinder_xset, granoo3.lib.tool_list, granoo3.lib.tool_polyhedron, granoo3.lib.tool_polyhedron_list, granoo3.lib.tool_polyhedron_set, granoo3.lib.tool_polyhedron_xset, granoo3.lib.tool_set, granoo3.lib.tool_sphere, granoo3.lib.tool_sphere_list, granoo3.lib.tool_sphere_set, granoo3.lib.tool_sphere_xset, granoo3.lib.tool_xset, granoo3.lib.uni_random, granoo3.lib.vector, granoo3.lib.viewer