itasca.gridpoint.Gridpoint Class Methods

class itasca.gridpoint.Gridpoint

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

accel() → vec.

Get the gridpoint acceleration (vector).

accel_x() → float.

Get the x-component of the gridpoint acceleration.

accel_y() → float.

Get the y-component of the gridpoint acceleration.

accel_z() → float.

Get the z-component of the gridpoint acceleration.

biot_modulus() → float.

Get the gridpoint fluid Biot modulus.

convergence() → float.

Get the gridpoint gridpoint convergence value, defined as the ratio of the currenct local force ratio (gridpoint ratio member) to the target force ratio (gridpoint ratio_target method). A value of 1 or less is therefore considered converged.

copy_to(destination: gridpoint) → None.

Copy the gridpoint state information from this gridpoint to the given gridpoint.

disp() → vec.

Get the gridpoint displacement (vector).

disp_small() → vec.

Get the gridpoint small displacement vector for the gridpoint. Small displacements are incremented from velocity and timestep only in small strain model. See the command model large. The small strain vector field is used in the interface logic to calculate overlaps (vector).

disp_small_x() → float.

Get the x-component of the gridpoint small displacement vector for the gridpoint. Small displacements are incremented from velocity and timestep only in small strain model. See the command model large. The small strain vector field is used in the interface logic to calculate overlaps.

disp_small_y() → float.

Get the y-component of the gridpoint small displacement vector for the gridpoint. Small displacements are incremented from velocity and timestep only in small strain model. See the command model large. The small strain vector field is used in the interface logic to calculate overlaps.

disp_small_z() → float.

Get the z-component of the gridpoint small displacement vector for the gridpoint. Small displacements are incremented from velocity and timestep only in small strain model. See the command model large. The small strain vector field is used in the interface logic to calculate overlaps.

disp_x() → float.

Get the x-component of the gridpoint displacement.

disp_y() → float.

Get the y-component of the gridpoint displacement.

disp_z() → float.

Get the z-component of the gridpoint displacement.

dynamic_mul() → float.

Get the gridpoint dynamic stepping multiplier.

extra(slot: int) → any.

Get the gridpoint extra data in the given slot.

fix(component: int) → bool.

Get the gridpoint fixity condition. The first argument is the vector component.

flow() → float.

Get the gridpoint unbalanced flow discharge at a gridpoint.

fluid_load() → float.

Get the gridpoint additional fluid load.

fluid_modulus() → float.

Get the gridpoint gridpoint fluid bulk modulus.

fluid_modulus_confined() → float.

Get the gridpoint fluid flow confined modulus times nodal volume. This is used in the fastflow solution scheme.

fluid_tension() → float.

Get the gridpoint gridpoint fluid tension limit.

fluid_unbal() → float.

Get the gridpoint fluid out-of-balance flow ? used in the fastflow solution scheme.

fluid_vol_inv() → float.

Get the gridpoint inverse of the fluid nodal volume..

force_app() → vec.

Get the gridpoint total applied force at a gridpoint. This includes all sources, including forces due to gravity (vector).

force_app_x() → float.

Get the x-component of the gridpoint total applied force at a gridpoint. This includes all sources, including forces due to gravity.

force_app_y() → float.

Get the y-component of the gridpoint total applied force at a gridpoint. This includes all sources, including forces due to gravity.

force_app_z() → float.

Get the z-component of the gridpoint total applied force at a gridpoint. This includes all sources, including forces due to gravity.

force_load() → vec.

Get the gridpoint user applied load (vector).

force_load_x() → float.

Get the x-component of the gridpoint user applied load.

force_load_y() → float.

Get the y-component of the gridpoint user applied load.

force_load_z() → float.

Get the z-component of the gridpoint user applied load.

force_unbal() → vec.

Get the gridpoint unbalanced force (vector).

force_unbal_x() → float.

Get the x-component of the gridpoint unbalanced force.

force_unbal_y() → float.

Get the y-component of the gridpoint unbalanced force.

force_unbal_z() → float.

Get the z-component of the gridpoint unbalanced force.

group([slot: str]) → str.

Get the gridpoint group name in a given slot.

group_remove(group_name: str) → bool.

Remove from the given group from all group slots of the gridpoint. 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 gridpoint is part of. The keys of the dictionary are the slot names and the values are the group names.

id() → int.

Get the gridpoint id.

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

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

local_small() → bool.

Get the gridpoint local small strain setting.

mass_add() → vec.

Get the gridpoint added mass vector for the gridpoint. This mass is added to the inertial mass of the gridpoint during equations of motion (vector).

mass_add_x() → float.

Get the x-component of the gridpoint added mass vector for the gridpoint. This mass is added to the inertial mass of the gridpoint during equations of motion.

mass_add_y() → float.

Get the y-component of the gridpoint added mass vector for the gridpoint. This mass is added to the inertial mass of the gridpoint during equations of motion.

mass_add_z() → float.

Get the z-component of the gridpoint added mass vector for the gridpoint. This mass is added to the inertial mass of the gridpoint during equations of motion.

mass_gravity() → float.

Get the gridpoint gravitational mass.

mass_inertial() → float.

Get the gridpoint gridpoint inertial mass.

pos() → vec.

Get the gridpoint centroid location (vector).

pos_x() → float.

Get the x-component of the gridpoint centroid location.

pos_y() → float.

Get the y-component of the gridpoint centroid location.

pos_z() → float.

Get the z-component of the gridpoint centroid location.

pp() → Float.

Get the gridpoint pore pressure.

pp_fix() → bool.

Get the gridpoint flag indicating that the pore-pressure in the gridpoint is fixed.

ratio() → float.

Get the gridpoint local gridpoint mechanical convergence ratio.

ratio_target() → float.

Get the gridpoint target local gridpoint mechanical convergence ratio. The default value is 1e-4. A local force ratio (gridpoint ratio method) below this value is considered converged. See the convergence Gridpoint method.

sat() → float.

Get the gridpoint gridpoint fluid saturation.

set_biot_modulus(value: float) → None.

Set the gridpoint fluid Biot modulus.

set_disp(value: vec) → None.

Set the gridpoint displacement (vector).

set_disp_small(value: vec) → None.

Set the gridpoint small displacement vector for the gridpoint. Small displacements are incremented from velocity and timestep only in small strain model. See the command model large. The small strain vector field is used in the interface logic to calculate overlaps (vector).

set_disp_small_x(value: float) → None.

Set the x-component of the gridpoint small displacement vector for the gridpoint. Small displacements are incremented from velocity and timestep only in small strain model. See the command model large. The small strain vector field is used in the interface logic to calculate overlaps.

set_disp_small_y(value: float) → None.

Set the y-component of the gridpoint small displacement vector for the gridpoint. Small displacements are incremented from velocity and timestep only in small strain model. See the command model large. The small strain vector field is used in the interface logic to calculate overlaps.

set_disp_small_z(value: float) → None.

Set the z-component of the gridpoint small displacement vector for the gridpoint. Small displacements are incremented from velocity and timestep only in small strain model. See the command model large. The small strain vector field is used in the interface logic to calculate overlaps.

set_disp_x(value: float) → None.

Set the x-component of the gridpoint displacement.

set_disp_y(value: float) → None.

Set the y-component of the gridpoint displacement.

set_disp_z(value: float) → None.

Set the z-component of the gridpoint displacement.

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

Set the gridpoint extra data in the given slot.

set_fix(component: int, fix: bool) → None.

Set the gridpoint fixity condition. The first argument is the vector component to set and the second components is a the fixity flag. The component starts at 0.

set_flow(value: float) → None.

Set the gridpoint unbalanced flow discharge at a gridpoint.

set_fluid_load(value: float) → None.

Set the gridpoint additional fluid load.

set_fluid_modulus(value: float) → None.

Set the gridpoint gridpoint fluid bulk modulus.

set_fluid_tension(value: float) → None.

Set the gridpoint gridpoint fluid tension limit.

set_fluid_unbal(value: float) → None.

Set the gridpoint fluid out-of-balance flow ? used in the fastflow solution scheme.

set_force_load(value: vec) → None.

Set the gridpoint user applied load (vector).

set_force_load_x(value: float) → None.

Set the x-component of the gridpoint user applied load.

set_force_load_y(value: float) → None.

Set the y-component of the gridpoint user applied load.

set_force_load_z(value: float) → None.

Set the z-component of the gridpoint user applied load.

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

Set the gridpoint group name in a given slot.

set_local_small(value: bool) → None.

Set the gridpoint local small strain setting.

set_mass_add(value: vec) → None.

Set the gridpoint added mass vector for the gridpoint. This mass is added to the inertial mass of the gridpoint during equations of motion (vector).

set_mass_add_x(value: float) → None.

Set the x-component of the gridpoint added mass vector for the gridpoint. This mass is added to the inertial mass of the gridpoint during equations of motion.

set_mass_add_y(value: float) → None.

Set the y-component of the gridpoint added mass vector for the gridpoint. This mass is added to the inertial mass of the gridpoint during equations of motion.

set_mass_add_z(value: float) → None.

Set the z-component of the gridpoint added mass vector for the gridpoint. This mass is added to the inertial mass of the gridpoint during equations of motion.

set_pos(value: vec) → None.

Set the gridpoint centroid location (vector).

set_pos_x(value: float) → None.

Set the x-component of the gridpoint centroid location.

set_pos_y(value: float) → None.

Set the y-component of the gridpoint centroid location.

set_pos_z(value: float) → None.

Set the z-component of the gridpoint centroid location.

set_pp(pp: float, update: bool=false) → None.

Set the gridpoint pore pressure. If the optional second argument is true in addition to modifying the gridpoint pore pressure, this method will fix the gridpoint pressure and update the accumulated pore pressure increment since the last mechanical step. The fluid flow calculation must be active for this option to be performed. To achieve the same result as the command zone gridpoint fix pore-pressure f, the methods pp_fix and pp must be used together.

set_pp_fix(value: bool) → None.

Set the gridpoint flag indicating that the pore-pressure in the gridpoint is fixed.

set_ratio_target(value: float) → None.

Set the gridpoint target local gridpoint mechanical convergence ratio. The default value is 1e-4. A local force ratio (gridpoint ratio method) below this value is considered converged. See the convergence Gridpoint method.

set_sat(value: float) → None.

Set the gridpoint gridpoint fluid saturation.

set_temp(value: float) → None.

Set the gridpoint current gridpoint temperature.

set_temp_change(value: float) → None.

Set the gridpoint amount of temperature change that has accumulated since the last thermal/mechanical coupling..

set_temp_source(value: float) → None.

Set the gridpoint applied FISH temperature source at a gridpoint.

set_tempfis(value: bool) → None.

Set the gridpoint flag indicating that temperature in this gridpoint is fixed.

set_vel(value: vec) → None.

Set the gridpoint velocity (vector).

set_vel_x(value: float) → None.

Set the x-component of the gridpoint velocity.

set_vel_y(value: float) → None.

Set the y-component of the gridpoint velocity.

set_vel_z(value: float) → None.

Set the z-component of the gridpoint velocity.

stiff() → float.

Get the gridpoint accumulated gridpoint effective stiffness.

temp() → float.

Get the gridpoint current gridpoint temperature.

temp_change() → float.

Get the gridpoint amount of temperature change that has accumulated since the last thermal/mechanical coupling..

temp_source() → float.

Get the gridpoint applied FISH temperature source at a gridpoint.

tempfis() → bool.

Get the gridpoint flag indicating that temperature in this gridpoint is fixed.

valid() → bool.

Returns True if this gridpoint is live.

vel() → vec.

Get the gridpoint velocity (vector).

vel_x() → float.

Get the x-component of the gridpoint velocity.

vel_y() → float.

Get the y-component of the gridpoint velocity.

vel_z() → float.

Get the z-component of the gridpoint velocity.

zones() → tuple of Zone objects.

Get a tuple of the zones attached to this gridpoint.