Wall

class itasca.wall.Wall

Objects of this type should not be created (instantiated) directly in Python. Use the module functions that return instances of this type.

closed() → bool.

Get the wall closure status. A closed wall is one where all edges are shared.

contact_count(all=False, type=None) → int.

Get number of contacts associated with this Wall. If the optional keyword argument type is given, the count is limited to the contact types specified. The type keyword argument should be a Python type object (one of: itasca.BallBallContact, itasca.BallPebbleContact, itasca.PebblePebbleContact, itasca.BallFacetContact or itasca.PebbleFacetContact). If the (optional) keyword argument all is True the count includes virtual contacts.

contacts([piece: object, ]all=False, type=None) → tuple of Contact objects.

Get a tuple of contacts associated with this Wall. An optional argument can be included which is a piece object (a Ball, a Pebble or a wallFacet). If the optional keyword argument type is given, the returned list is limited to the contact types specified. The type keyword argument should be a Python type object (one of: itasca.BallBallContact, itasca.BallPebbleContact, itasca.PebblePebbleContact, itasca.BallFacetContact or itasca.PebbleFacetContact). If the (optional) keyword argument all is True the returned list includes virtual contacts.

convex() → bool.

Get the convexity status. The wall must also be closed to be convex.

cutoff() → float.

Get the cutoff angle. The cutoff angle is used during contact resolution to determine whether or not contact state information is propagated.

delete() → None.

Delete this wall.

disp() → vec.

Get the wall displacement (vector).

disp_x() → float.

Get the x-component of the wall displacement.

disp_y() → float.

Get the y-component of the wall displacement.

disp_z() → float.

Get the z-component of the wall displacement.

euler() → vec.

Get the wall orientation (vector).

euler_x() → float.

Get the x-component of the wall orientation.

euler_y() → float.

Get the y-component of the wall orientation.

euler_z() → float.

Get the z-component of the wall orientation.

extra(slot: int) → any.

Get the wall extra data in the given slot.

facets() → Facet iterator object.

Get the facets of the wall.

force_contact() → vec.

Get the wall contact force (vector).

force_contact_x() → float.

Get the x-component of the wall contact force.

force_contact_y() → float.

Get the y-component of the wall contact force.

force_contact_z() → float.

Get the z-component of the wall contact force.

fragment() → int.

Get the wall fragment ID.

group([slot: str or int]) → str.

Get the wall group name in a given slot.

group_remove(group_name: str or int[, slot: str or int]) → bool.

Remove from the given group from all group slots of the wall. One argument of type string, giving the group name, is required. The return value is a bool which is True if the group was removed from any slot, otherwise False.

groups() → {slot: group_name}.

Get a dictionary describing which groups this wall is part of. The keys of the dictionary are the slot names and the values are the group names.

id() → int.

Get the wall id.

in_group(group_name: str or int[, slot: str or int]) → bool.

Test if the wall is part of a given group. If the optional argument slot is given, only that slot is searched. Otherwise, all group slots are searched.

inside(point: vec) → bool.

Test whether a point is inside a wall. The wall must be closed.

moment_contact() → vec.

Get the wall contact moment (vector).

moment_contact_x() → float.

Get the x-component of the wall contact moment.

moment_contact_y() → float.

Get the y-component of the wall contact moment.

moment_contact_z() → float.

Get the z-component of the wall contact moment.

name() → str.

Get the wall name. Once a wall has been created its name cannot be changed.

pos() → vec.

Get the wall location (vector).

pos_x() → float.

Get the x-component of the wall location.

pos_y() → float.

Get the y-component of the wall location.

pos_z() → float.

Get the z-component of the wall location.

rotation_center() → vec.

Get the wall center of rotation (vector).

rotation_center_x() → float.

Get the x-component of the wall center of rotation.

rotation_center_y() → float.

Get the y-component of the wall center of rotation.

rotation_center_z() → float.

Get the z-component of the wall center of rotation.

servo_active() → bool.

Get the wall servo activity status.

servo_force() → vec.

Get the wall servo force.

servo_gain() → float.

Get the wall servo gain.

servo_gainfactor() → float.

Get the wall servo gain relaxation factor.

servo_gainupdate() → int.

Get the wall servo gain update interval.

servo_set_active(b: bool) → None.

Set the wall servo activity status.

servo_set_force(force: vec) → None.

Set the wall servo force.

servo_set_gainfactor(fac: float) → None.

Set the wall servo gain relaxation factor.

servo_set_gainupdate(i: int) → None.

Set the wall servo gain update interval.

servo_set_vmax(vmax: float) → None.

Set the wall servo cap velocity.

servo_vmax() → float.

Get the wall servo cap velocity.

set_cutoff(angle: float) → None.

Set the cutoff angle. The cutoff angle is used during contact resolution to determine whether or not contact state information is propagated.

set_disp(value: vec) → None.

Set the wall displacement (vector).

set_disp_x(value: float) → None.

Set the x-component of the wall displacement.

set_disp_y(value: float) → None.

Set the y-component of the wall displacement.

set_disp_z(value: float) → None.

Set the z-component of the wall displacement.

set_euler(value: vec) → None.

Set the wall orientation (vector).

set_euler_x(value: float) → None.

Set the x-component of the wall orientation.

set_euler_y(value: float) → None.

Set the y-component of the wall orientation.

set_euler_z(value: float) → None.

Set the z-component of the wall orientation.

set_extra(slot: int, value: any) → None.

Set the wall extra data in the given slot.

set_force_contact(value: vec) → None.

Set the wall contact force (vector).

set_force_contact_x(value: float) → None.

Set the x-component of the wall contact force.

set_force_contact_y(value: float) → None.

Set the y-component of the wall contact force.

set_force_contact_z(value: float) → None.

Set the z-component of the wall contact force.

set_fragment(id: int) → None.

Set wall fragment ID.

set_group(group_name: str or int[, slot: str or int]) → None.

Set the wall group name in a given slot.

set_moment_contact(value: vec) → None.

Set the wall contact moment (vector).

set_moment_contact_x(value: float) → None.

Set the x-component of the wall contact moment.

set_moment_contact_y(value: float) → None.

Set the y-component of the wall contact moment.

set_moment_contact_z(value: float) → None.

Set the z-component of the wall contact moment.

set_pos(value: vec) → None.

Set the wall location (vector).

set_pos_x(value: float) → None.

Set the x-component of the wall location.

set_pos_y(value: float) → None.

Set the y-component of the wall location.

set_pos_z(value: float) → None.

Set the z-component of the wall location.

set_prop(name: str, value: any) → None.

Set a property of all facets.

set_rotation_center(value: vec) → None.

Set the wall center of rotation (vector).

set_rotation_center_x(value: float) → None.

Set the x-component of the wall center of rotation.

set_rotation_center_y(value: float) → None.

Set the y-component of the wall center of rotation.

set_rotation_center_z(value: float) → None.

Set the z-component of the wall center of rotation.

set_spin(value: vec) → None.

Set the wall angular velocity (vector).

set_spin_x(value: float) → None.

Set the x-component of the wall angular velocity.

set_spin_y(value: float) → None.

Set the y-component of the wall angular velocity.

set_spin_z(value: float) → None.

Set the z-component of the wall angular velocity.

set_vel(value: vec) → None.

Set the wall velocity (vector).

set_vel_x(value: float) → None.

Set the x-component of the wall velocity.

set_vel_y(value: float) → None.

Set the y-component of the wall velocity.

set_vel_z(value: float) → None.

Set the z-component of the wall velocity.

spin() → vec.

Get the wall angular velocity (vector).

spin_x() → float.

Get the x-component of the wall angular velocity.

spin_y() → float.

Get the y-component of the wall angular velocity.

spin_z() → float.

Get the z-component of the wall angular velocity.

valid() → bool.

Returns True if this wall is live.

vel() → vec.

Get the wall velocity (vector).

vel_x() → float.

Get the x-component of the wall velocity.

vel_y() → float.

Get the y-component of the wall velocity.

vel_z() → float.

Get the z-component of the wall velocity.

vertices() → Vertex iterator object.

Get the vertices of this wall.