MPMPoint

class itasca.mpoint.MPMPoint

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

deformation() → float.

Get the mpoint deformation scalar.

density() → float.

Get the mpoint density.

disp() → vec.

Get the mpoint mpoint displacement (vector).

disp_x() → float.

Get the x-component of the mpoint mpoint displacement.

disp_y() → float.

Get the y-component of the mpoint mpoint displacement.

disp_z() → float.

Get the z-component of the mpoint mpoint displacement.

extra(slot: int) → any.

Get the mpoint extra data in the given slot.

force_app() → vec.

Get the mpoint mpoint appliad force (vector).

force_app_x() → float.

Get the x-component of the mpoint mpoint appliad force.

force_app_y() → float.

Get the y-component of the mpoint mpoint appliad force.

force_app_z() → float.

Get the z-component of the mpoint mpoint appliad force.

force_unbal() → vec.

Get the mpoint mpoint unbalance force (vector).

force_unbal_x() → float.

Get the x-component of the mpoint mpoint unbalance force.

force_unbal_y() → float.

Get the y-component of the mpoint mpoint unbalance force.

force_unbal_z() → float.

Get the z-component of the mpoint mpoint unbalance force.

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

Get the mpoint 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 mpoint. 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 mpoint is part of. The keys of the dictionary are the slot names and the values are the group names.

has_prop(property_name: str) → bool.

Returns True if the mpoint has the given surface property.

id() → int.

Get the mpoint id.

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

Test if the mpoint 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 mpoint index.

mass() → float.

Get the mpoint mass.

pos() → vec.

Get the mpoint mpoint position (vector).

pos_x() → float.

Get the x-component of the mpoint mpoint position.

pos_y() → float.

Get the y-component of the mpoint mpoint position.

pos_z() → float.

Get the z-component of the mpoint mpoint position.

pp() → float.

Get the mpoint pore pressure.

pp_fix() → bool.

Get the mpoint pore pressure fix status.

prop(property_name: str) → any.

Get a surface property value of this mpoint.

props() → dict {str: any}.

Get a dictionary of all the surface properties of this mpoint.

set_density(float) → void.

Set the mpoint density.

set_disp(value: vec) → None.

Set the mpoint mpoint displacement (vector).

set_disp_x(value: float) → None.

Set the x-component of the mpoint mpoint displacement.

set_disp_y(value: float) → None.

Set the y-component of the mpoint mpoint displacement.

set_disp_z(value: float) → None.

Set the z-component of the mpoint mpoint displacement.

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

Set the mpoint extra data in the given slot.

set_force_app(value: vec) → None.

Set the mpoint mpoint appliad force (vector).

set_force_app_x(value: float) → None.

Set the x-component of the mpoint mpoint appliad force.

set_force_app_y(value: float) → None.

Set the y-component of the mpoint mpoint appliad force.

set_force_app_z(value: float) → None.

Set the z-component of the mpoint mpoint appliad force.

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

Set the mpoint group name in a given slot.

set_mass(float) → void.

Set the mpoint mass.

set_pos(value: vec) → None.

Set the mpoint mpoint position (vector).

set_pos_x(value: float) → None.

Set the x-component of the mpoint mpoint position.

set_pos_y(value: float) → None.

Set the y-component of the mpoint mpoint position.

set_pos_z(value: float) → None.

Set the z-component of the mpoint mpoint position.

set_pp(float) → void.

Set the mpoint pore pressure.

set_pp_fix(bool) → void.

Set the mpoint pore pressure fix status.

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

Set a surface property of this mpoint.

set_strain(strain: stens3) → None.

Set the strain tensor. The tensor components must be provided in the order xx,yy,zz,xy,yz,xz.

set_stress(stress: stens3) → None.

Set the stress tensor. The tensor components must be provided in the order xx,yy,zz,xy,yz,xz.

set_velocity(value: vec) → None.

Set the mpoint mpoint veolcity (vector).

set_velocity_x(value: float) → None.

Set the x-component of the mpoint mpoint veolcity.

set_velocity_y(value: float) → None.

Set the y-component of the mpoint mpoint veolcity.

set_velocity_z(value: float) → None.

Set the z-component of the mpoint mpoint veolcity.

strain() → stens3.

Get the strain tensor. The symmetric tensor components are used (xx,yy,zz,xy,yz,xz).

stress() → stens3.

Get the stress tensor. The symmetric tensor components are used (xx,yy,zz,xy,yz,xz).

valid() → bool.

Returns True if this mpoint is live.

velocity() → vec.

Get the mpoint mpoint veolcity (vector).

velocity_x() → float.

Get the x-component of the mpoint mpoint veolcity.

velocity_y() → float.

Get the y-component of the mpoint mpoint veolcity.

velocity_z() → float.

Get the z-component of the mpoint mpoint veolcity.

vol() → float.

Get the volume of a mpoint.