itasca.block.zonearray
Array interface for 3DEC zones.
Functions
-
itasca.block.zonearray.
extra
(slot: int) → array float{zone} or float{zone,3}. Get the zone extra data in the given slot as an array. Extra variables accessed by array must be of type float or vec.
-
itasca.block.zonearray.
fill_pos
(data: array float{zone, 3}) → None. Fill an existing array with the zone centroid location. The array must be the correct shape.
-
itasca.block.zonearray.
fluid_prop
(prop_name: str, fill_value=0.0) → array double{nzone}. Return an array of the fluid property
prop_name
for each zone. If a property is not specified in a zone,fill_value
is given for that zone.fill_value
is an optional argument and defaults to zero.
-
itasca.block.zonearray.
hostblock
() → array int{nzone}. Return an array of the host block ID.
-
itasca.block.zonearray.
ids
() → array int{zone}. Get the zone ids as an array.
-
itasca.block.zonearray.
in_group
(group_name: str, slot="default") → array bool{nzone}. Return block group membership as a Boolean array.
-
itasca.block.zonearray.
mass
() → array double{nzone}. Return an array of the zone mass.
-
itasca.block.zonearray.
pos
() → array float{zone,3}. Get a numpy array of the zone centroid location.
-
itasca.block.zonearray.
pp
() → array double{nzone}. Return an array of the zone pore pressures.
-
itasca.block.zonearray.
prop_scalar
(prop_name: str, fill_value=0.0) → array double{nzone}. Return an array of the property
prop_name
for each zone. Only properties of type double are supported by this function. If a property is not specified in a zone,fill_value
is given for that zone.fill_value
is an optional argument and defaults to zero.
-
itasca.block.zonearray.
set_extra
(slot: int, data: array float{zone} or float{zone, 3}) → None. Set the zone extra data in the given slot with an array. Extra variables set by array must be of type float or vec.
-
itasca.block.zonearray.
set_fluid_prop
(prop_name: str, array) → None. Set the fluid property
prop_name
of each zone. The input array should be shape (nzone,).
-
itasca.block.zonearray.
set_group
(membership: array bool{nzone}, 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.zonearray.
set_prop_scalar
(prop_name: str, array) → None. Set the property
prop_name
of each zone. Only properties of type double or vec3 are supported. The input array should be shape (nzone,).
-
itasca.block.zonearray.
set_stress
(array double{nzone, 3, 3}) → None. Set the zone stresses.
-
itasca.block.zonearray.
set_stress_flat
(array double{nzone, 6}) → None. Set the zone stresses.
-
itasca.block.zonearray.
set_thermal_prop
(prop_name: str, array) → None. Set the thermal property
prop_name
of each zone. The input array should be shape (nzone,).
-
itasca.block.zonearray.
state
() → array int{nzone}. Return an array of the zone state.
-
itasca.block.zonearray.
strain_inc
() → array double{nzone,3,3}. Get an array of the zone strain increment.
-
itasca.block.zonearray.
strain_inc_flat
() → array double{nzone,6}. Get an array of the zone strain increment. The return value is a 2D array where the component ordering is xx,yy,zz,xy,yz,xz.
-
itasca.block.zonearray.
strain_rate
() → array double{nzone,3,3}. Get an array of the zone strain rate.
-
itasca.block.zonearray.
strain_rate_flat
() → array double{nzone,6}. Get an array of the zone strain rate. The return value is a 2D array where the component ordering is xx,yy,zz,xy,yz,xz.
-
itasca.block.zonearray.
strain_rotation_inc
() → array double{nzone,3,3}. Get an array of the zone rotational increment tensor.
-
itasca.block.zonearray.
strain_rotation_inc_flat
() → array double{nzone,6}. Get an array of the zone rotational increment tensor. The return value is a 2D array where the component ordering is xx,yy,zz,xy,yz,xz.
-
itasca.block.zonearray.
strain_rotation_rate
() → array double{nzone,3,3}. Get an array of the zone rotational rate tensor.
-
itasca.block.zonearray.
strain_rotation_rate_flat
() → array double{nzone,6}. Get an array of the zone rotational rate tensor. The return value is a 2D array where the component ordering is xx,yy,zz,xy,yz,xz.
-
itasca.block.zonearray.
strain_shear_inc
() → array double{nzone}. Return an array of the zone shear strain increment .
-
itasca.block.zonearray.
strain_shear_rate
() → array double{nzone}. Return an array of the zone shear strain rate.
-
itasca.block.zonearray.
strain_vol_inc
() → array double{nzone}. Return an array of the zone volumetric strain increment.
-
itasca.block.zonearray.
strain_vol_rate
() → array double{nzone}. Return an array of the zone volumetric strain rate.
-
itasca.block.zonearray.
stress
() → array double{nzone,3,3}. Get an array of the zone stresses.
-
itasca.block.zonearray.
stress_flat
() → array double{nzone,6}. Get an array of the zone stresses. The return value is a 2D array where the component ordering is xx,yy,zz,xy,yz,xz.
-
itasca.block.zonearray.
thermal_prop
(prop_name: str, fill_value=0.0) → array double{nzone}. Return an array of the thermal property
prop_name
for each zone. If a property is not specified in a zone,fill_value
is given for that zone.fill_value
is an optional argument and defaults to zero.
-
itasca.block.zonearray.
volume
() → array double{nzone}. Return an array of the zone volumes.
Was this helpful? ... | PFC © 2021, Itasca | Updated: Feb 25, 2024 |