Block
-
class
itasca.block.
Block
- Objects of this type should not be created (instantiated) directly in Python. Use the module functions that return instances of this type.
-
area
() → float. Get the surface area of a block.
-
contacts
() → tuple of Contact objects. Get contact list of a block.
-
density
() → float. Get the block density.
-
dsf
() → float. Get the block density scaling factor.
-
extra
(slot: int) → any. Get the block extra data in the given slot.
-
faces
(bool) → tuple of faces. Get face list of a block.
-
force_app
() → vec. Get the block block appliad force (vector).
-
force_app_x
() → float. Get the x-component of the block block appliad force.
-
force_app_y
() → float. Get the y-component of the block block appliad force.
-
force_app_z
() → float. Get the z-component of the block block appliad force.
-
force_unbal
() → vec. Get the block block unbalance force (vector).
-
force_unbal_x
() → float. Get the x-component of the block block unbalance force.
-
force_unbal_y
() → float. Get the y-component of the block block unbalance force.
-
force_unbal_z
() → float. Get the z-component of the block block unbalance force.
-
gridpoints
() → tuple of Gridpoint objects. Get a tuple the gridpoint objects which are part of this block.
-
group
([slot: str or int]) → str. Get the block 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 block. 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 block is part of. The keys of the dictionary are the slot names and the values are the group names.
-
id
() → int. Get the block id.
-
in_group
(group_name: str or int[, slot: str or int]) → bool. Test if the block is part of a given group. If the optional argument slot is given, only that slot is searched. Otherwise, all group slots are searched.
-
index
() → int. Get the block index.
-
is_excavated
() → bool. Check if the block is excavated.
-
is_fix
() → bool. Check if the block is fixed.
Get hidden flag of a block.
-
is_rigid
() → bool. Get rigid flag of a block.
-
mass
() → float. Get the block mass.
-
master_slave
() → int. Get master_slave flag of a block.
-
moi
() → vec. Get the block block inertia (vector).
-
moi_x
() → float. Get the x-component of the block block inertia.
-
moi_y
() → float. Get the y-component of the block block inertia.
-
moi_z
() → float. Get the z-component of the block block inertia.
-
moment
() → vec. Get the block block moment (vector).
-
moment_x
() → float. Get the x-component of the block block moment.
-
moment_y
() → float. Get the y-component of the block block moment.
-
moment_z
() → float. Get the z-component of the block block moment.
-
pos
() → vec. Get the block block position (vector).
-
pos_x
() → float. Get the x-component of the block block position.
-
pos_y
() → float. Get the y-component of the block block position.
-
pos_z
() → float. Get the z-component of the block block position.
-
rvel
() → vec. Get the block rotational veolcity (vector).
-
rvel_x
() → float. Get the x-component of the block rotational veolcity.
-
rvel_y
() → float. Get the y-component of the block rotational veolcity.
-
rvel_z
() → float. Get the z-component of the block rotational veolcity.
-
set_density
(float) → float. Set the block density.
-
set_extra
(slot: int, value: any) → None. Set the block extra data in the given slot.
-
set_fix
(bool) → bool. Set the block.
-
set_force_app
(value: vec) → None. Set the block block appliad force (vector).
-
set_force_app_x
(value: float) → None. Set the x-component of the block block appliad force.
-
set_force_app_y
(value: float) → None. Set the y-component of the block block appliad force.
-
set_force_app_z
(value: float) → None. Set the z-component of the block block appliad force.
-
set_group
(group_name: str or int[, slot: str or int]) → None. Set the block group name in a given slot.
Set hidden flag of a block.
-
set_rvel
(value: vec) → None. Set the block rotational veolcity (vector).
-
set_rvel_x
(value: float) → None. Set the x-component of the block rotational veolcity.
-
set_rvel_y
(value: float) → None. Set the y-component of the block rotational veolcity.
-
set_rvel_z
(value: float) → None. Set the z-component of the block rotational veolcity.
-
set_velocity
(value: vec) → None. Set the block block veolcity (vector).
-
set_velocity_x
(value: float) → None. Set the x-component of the block block veolcity.
-
set_velocity_y
(value: float) → None. Set the y-component of the block block veolcity.
-
set_velocity_z
(value: float) → None. Set the z-component of the block block veolcity.
-
valid
() → bool. Returns True if this block is live.
-
velocity
() → vec. Get the block block veolcity (vector).
-
velocity_x
() → float. Get the x-component of the block block veolcity.
-
velocity_y
() → float. Get the y-component of the block block veolcity.
-
velocity_z
() → float. Get the z-component of the block block veolcity.
-
vol
() → float. Get the volume of a block.
-
zones
() → tuple of block zones. Get zone list of a block.
-
Was this helpful? ... | PFC © 2021, Itasca | Updated: Feb 25, 2024 |