Gridpoint

class itasca.block.gridpoint.Gridpoint

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

disp() vec.

Get the gridpoint gridpoint force (vector).

disp_x() float.

Get the x-component of the gridpoint gridpoint force.

disp_y() float.

Get the y-component of the gridpoint gridpoint force.

disp_z() float.

Get the z-component of the gridpoint gridpoint force.

extra(slot: int) any.

Get the gridpoint extra data in the given slot.

fblock() fbptr.

Get the host face block for the gridpoint.

flowknot() float.

Get the flowknot corresponding to this gridpoint.

flux() float.

Get the thermal flux at the gridpoint.

flux_app() float.

Get the applied thermal flux at the gridpoint.

force() float.

Get the force vector.

force_app() vec.

Get the gridpoint gridpoint applied force (vector).

force_app_x() float.

Get the x-component of the gridpoint gridpoint applied force.

force_app_y() float.

Get the y-component of the gridpoint gridpoint applied force.

force_app_z() float.

Get the z-component of the gridpoint gridpoint applied force.

force_inc() vec.

Get the gridpoint gridpoint increment force (vector).

force_inc_x() float.

Get the x-component of the gridpoint gridpoint increment force.

force_inc_y() float.

Get the y-component of the gridpoint gridpoint increment force.

force_inc_z() float.

Get the z-component of the gridpoint gridpoint increment force.

force_reaction() vec.

Get the gridpoint gridpoint reaction force (vector).

force_reaction_x() float.

Get the x-component of the gridpoint gridpoint reaction force.

force_reaction_y() float.

Get the y-component of the gridpoint gridpoint reaction force.

force_reaction_z() float.

Get the z-component of the gridpoint gridpoint reaction force.

force_unbal() vec.

Get the gridpoint gridpoint unbalanced force (vector).

force_unbal_x() float.

Get the x-component of the gridpoint gridpoint unbalanced force.

force_unbal_y() float.

Get the y-component of the gridpoint gridpoint unbalanced force.

force_unbal_z() float.

Get the z-component of the gridpoint gridpoint unbalanced force.

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

Get the gridpoint 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 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.

hostblock() hbptr.

Get the block to which a gridpoint belongs.

id() int.

Get the gridpoint id.

in_group(group_name: str or int[, slot: str or int]) 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.

index() int.

Get the block gridpoint index (offset).

mass() float.

Get the gridpoint mass.

mass_dynamic() float.

Get the dynamic mass for the block gridpoint.

mass_thermal() float.

Get the thermal mass.

pos() vec.

Get the gridpoint gridpoint position (vector).

pos_x() float.

Get the x-component of the gridpoint gridpoint position.

pos_y() float.

Get the y-component of the gridpoint gridpoint position.

pos_z() float.

Get the z-component of the gridpoint gridpoint position.

pp() float.

Get the gridpoint pore pressure.

set_disp(value: vec) None.

Set the gridpoint gridpoint force (vector).

set_disp_x(value: float) None.

Set the x-component of the gridpoint gridpoint force.

set_disp_y(value: float) None.

Set the y-component of the gridpoint gridpoint force.

set_disp_z(value: float) None.

Set the z-component of the gridpoint gridpoint force.

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

Set the gridpoint extra data in the given slot.

set_force_app(value: vec) None.

Set the gridpoint gridpoint applied force (vector).

set_force_app_x(value: float) None.

Set the x-component of the gridpoint gridpoint applied force.

set_force_app_y(value: float) None.

Set the y-component of the gridpoint gridpoint applied force.

set_force_app_z(value: float) None.

Set the z-component of the gridpoint gridpoint applied force.

set_force_inc(value: vec) None.

Set the gridpoint gridpoint increment force (vector).

set_force_inc_x(value: float) None.

Set the x-component of the gridpoint gridpoint increment force.

set_force_inc_y(value: float) None.

Set the y-component of the gridpoint gridpoint increment force.

set_force_inc_z(value: float) None.

Set the z-component of the gridpoint gridpoint increment force.

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

Set the gridpoint group name in a given slot.

set_pp(float) None.

Set the gridpoint pore pressure.

set_temp(float) None.

Set the gridpoint temperature.

set_vel(value: vec) None.

Set the gridpoint gridpoint velocity (vector).

set_vel_app(value: vec) None.

Set the gridpoint gridpoint applied velocity (vector).

set_vel_app_x(value: float) None.

Set the x-component of the gridpoint gridpoint applied velocity.

set_vel_app_y(value: float) None.

Set the y-component of the gridpoint gridpoint applied velocity.

set_vel_app_z(value: float) None.

Set the z-component of the gridpoint gridpoint applied velocity.

set_vel_x(value: float) None.

Set the x-component of the gridpoint gridpoint velocity.

set_vel_y(value: float) None.

Set the y-component of the gridpoint gridpoint velocity.

set_vel_z(value: float) None.

Set the z-component of the gridpoint gridpoint velocity.

temp() float.

Get the gridpoint temperature.

valid() bool.

Returns True if this gridpoint is live.

vel() vec.

Get the gridpoint gridpoint velocity (vector).

vel_app() vec.

Get the gridpoint gridpoint applied velocity (vector).

vel_app_x() float.

Get the x-component of the gridpoint gridpoint applied velocity.

vel_app_y() float.

Get the y-component of the gridpoint gridpoint applied velocity.

vel_app_z() float.

Get the z-component of the gridpoint gridpoint applied velocity.

vel_x() float.

Get the x-component of the gridpoint gridpoint velocity.

vel_y() float.

Get the y-component of the gridpoint gridpoint velocity.

vel_z() float.

Get the z-component of the gridpoint gridpoint velocity.