itasca.block.gridpointarray

Array interface for 3DEC girdpoints.

Functions

itasca.block.gridpointarray.disp() → array float{gridpoint,3}.

Get a numpy array of the gridpoint displacement.

itasca.block.gridpointarray.extra(slot: int) → array float{gridpoint} or float{gridpoint,3}.

Get the gridpoint extra data in the given slot as an array. Extra variables accessed by array must be of type float or vec.

itasca.block.gridpointarray.fill_disp(data: array float{gridpoint, 3}) → None.

Fill an existing array with the gridpoint displacement. The array must be the correct shape.

itasca.block.gridpointarray.fill_pos(data: array float{gridpoint, 3}) → None.

Fill an existing array with the gridpoint centroid location. The array must be the correct shape.

itasca.block.gridpointarray.fill_vel(data: array float{gridpoint, 3}) → None.

Fill an existing array with the gridpoint velocity. The array must be the correct shape.

itasca.block.gridpointarray.hostblock() → array int{ngp}.

Return an array of the host block ID.

itasca.block.gridpointarray.ids() → array int{gridpoint}.

Get the gridpoint ids as an array.

itasca.block.gridpointarray.in_group(group_name: str, slot='default') → array bool{ngp}.

Return block group membership as a Boolean array.

itasca.block.gridpointarray.mass() → array int{ngp}.

Return an array of the gridpoint mass.

itasca.block.gridpointarray.pos() → array float{gridpoint,3}.

Get a numpy array of the gridpoint centroid location.

itasca.block.gridpointarray.pp() → array double{gridpoint}.

Get a numpy array of the porepressure at each gridpoint.

itasca.block.gridpointarray.set_disp(data: array float{gridpoint, 3}) → None.

Set the gridpoint displacement from an array.

itasca.block.gridpointarray.set_extra(slot: int, data: array float{gridpoint} or float{gridpoint, 3}) → None.

Set the gridpoint extra data in the given slot with an array. Extra variables set by array must be of type float or vec.

itasca.block.gridpointarray.set_group(membership: array bool{ngp}, group_name: str, slot="default") → None.

Set block group from an array. Where membership True set the corresponding block to be a member of group group_name in the given slot.

itasca.block.gridpointarray.set_pp(array double{gridpoint, 3}) → None.

Set the pore pressure at each gridpoint with a NumPy array.

itasca.block.gridpointarray.set_temperature(array double{gridpoint, 3}) → None.

Set the temperature at each gridpoint with a NumPy array.

itasca.block.gridpointarray.set_vel(data: array float{gridpoint, 3}) → None.

Set the gridpoint velocity from an array.

itasca.block.gridpointarray.temperature() → array double{gridpoint}.

Get a numpy array of the temperature at each gridpoint.

itasca.block.gridpointarray.vel() → array float{gridpoint,3}.

Get a numpy array of the gridpoint velocity.