itasca.zonearray Module
Array interface for FLAC zones.
itasca.zonearray Module Functions
-
itasca.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.zonearray.
faces
() → array int{nzone,6,4}. Return an array containing the gridpoint indices of each face of each zone. Indices of -1 indicate a non-existant face. The indicies are relative to the ordering of the itasca.gridpointarray return values.
-
itasca.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.zonearray.
flow
() → array double{nzone,3}. Return an array of the zone specific discharge vectors.
-
itasca.zonearray.
fluid_prop
(prop_name: str) → array double{nzone}. Return an array of the fluid property \(prop_name\).
-
itasca.zonearray.
gridpoints
() → array int{nzone,8}. Return an array containing the gridpoint indices of each zone. Indices of -1 indicate a non-existant gridpoint. The indices are relative to the ordering of the itasca.gridpointarray return values.
-
itasca.zonearray.
ids
() → array int{zone}. Get the zone ids as an array.
-
itasca.zonearray.
in_group
(group_name: str, slot="default") → array bool{nzone}. Return zone group membership as a Boolean array.
-
itasca.zonearray.
live_mechanical
() → array bool{nzone}. Return an array of True/False values, True values correspond to zones which have an active mechanical model.
-
itasca.zonearray.
neighbors
() → array int{nzone,6}. Return an array containing the indices of the zone adjacent to each zone. Indices of -1 indicate non-existant neighbor zone. The indicies are relative to the ordering of the itasca.zonearray return values.
-
itasca.zonearray.
overlay_stresses
() → array double{nzone,2,5,6}. Get a multidimensional numpy array of the zone overlay stresses. Non-existant tets have a stress of zero. The return value is a 4 dimentional array with axes: zone, overlay, tet, stress tensor component. The stress tensor component ordering is xx,yy,zz,xy,yz,xz.
-
itasca.zonearray.
pos
() → array float{zone,3}. Get a numpy array of the zone centroid location.
-
itasca.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.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.zonearray.
set_fluid_prop
(prop_name: str, data: array double{nzone}) → None. Set the fluid property \(prop_name\) with values from an array.
-
itasca.zonearray.
set_group
(membership: array bool{nzone}, group_name: str, slot="default") → None. Set zone group from an array. Where membership True set the corresponding zone to be a member of group group_name in the given slot.
-
itasca.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.zonearray.
set_stress
(array double{nzone, 3, 3}) → None. Set the zone stresses.
-
itasca.zonearray.
set_stress_flat
(array double{nzone, 6}) → None. Set the zone stresses.
-
itasca.zonearray.
strain
() → array double{nzone,3,3}. Get an array of the zone strains.
-
itasca.zonearray.
strain_flat
() → array double{nzone,6}. Get an array of the zone strains. The return value is a 2D array where the component ordering is xx,yy,zz,xy,yz,xz.
-
itasca.zonearray.
stress
() → array double{nzone,3,3}. Get an array of the zone stresses.
-
itasca.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.zonearray.
stress_max
() → array double{nzone}. Return an array of the maximum (most positive) principal value of the volume averaged tetra stress for each zone. Note that compressive stresses are negative in FLAC3D.
-
itasca.zonearray.
stress_min
() → array double{nzone}. Return an array of the minimum (most negative) principal value of the volume averaged tetra stress for each zone. Note that compressive stresses are negative in FLAC3D.
Was this helpful? ... | PFC 6.0 © 2019, Itasca | Updated: Nov 19, 2021 |