Zone
- class itasca.block.zone.Zone
Objects of this type should not be created (instantiated) directly in Python. Use the module functions that return instances of this type.
- extra(slot: int) any.
Get the zone extra data in the given slot.
- gp(int) gpptr.
Get a zone gridpoint int (1, 2, 3 or 4), indicating the four surrounding gridpoints.
- group([slot: str or int]) str.
Get the zone 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 zone. 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 zone is part of. The keys of the dictionary are the slot names and the values are the group names.
- hostblock() bptr.
Get the block to which a zone belongs.
- id() int.
Get the zone id.
- in_group(group_name: str or int[, slot: str or int]) bool.
Test if the zone 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 index (offset) for the zone.
- is_excavated() bool.
Get the excavated state of the zone.
Get the hidden state of the zone.
- mass() float.
Get zone mass.
- model() float.
Get the zone material model as a string.
- pos() vec.
Get the zone location (vector).
- pos_x() float.
Get the x-component of the zone location.
- pos_y() float.
Get the y-component of the zone location.
- pos_z() float.
Get the z-component of the zone location.
- pp() float.
Get the zone pore pressure (average of gridpoint pore pressures).
- prop(str) float.
Get a property.
- prop_fluid(str) float.
Get a fluid property of the zone.
- prop_thermal(str) float.
Get a thermal property of the zone.
- props() dict {str: any}.
Get a list of all properies.
- set_extra(slot: int, value: any) None.
Set the zone extra data in the given slot.
- set_group(group_name: str or int[, slot: str or int]) None.
Set the zone group name in a given slot.
- set_model(str) None.
Set the zone material model as a string.
- set_prop(str, float) None.
Set the a property.
- set_prop_fluid(str, float) float.
Set a thermal property of the zone.
- set_prop_thermal(str, float) None.
Set a thermal property of the zone.
- set_state(int) None.
Set the plasticity state indicator (sum of integer values).
- set_stress(stens3) None.
Set the zone stress tensor.
- state() int.
Get the plasticity state indicator (sum of integer values).
- strain_inc() stens3.
Get the zone strain increment, based on the current displacement field.
- strain_rate() stens3.
Get the zone strain rate, based on the current velocity field.
- strain_rotation_inc() stens3.
Get the zone rotational increment tensor, based on the current displacement field.
- strain_rotation_rate() stens3.
Get the zone rotation rate tensor, based on the current velocity field.
- strain_shear_int() float.
Get the zone shear strain increment based on the current displacement field.
- strain_shear_rate() float.
Get the zone shear strain rate based on the current velocity field.
- strain_total() float.
Get the value of the von Mises strain for a zone.
- strain_vol_int() float.
Get the zone volumetric strain increment based on the current displacement field.
- strain_vol_rate() float.
Get the zone volumetric strain rate based on the current velocity field.
- stress() stens3.
Get the zone stress tensor.
- stress_effective() stens3.
Get the zone effective stress.
- stress_int() float.
Get the intermediate principal stress.
- stress_max() float.
Get the maximum (most positive) principal stress.
- stress_min() float.
Get the minimum (most negative) principal stress.
- stress_prin_dir() [vec3,sten3].
Get the zone principal stress directions.
- valid() bool.
Returns True if this zone is live.
- vol() float.
Get the zone volume.
Was this helpful? ... | Itasca Software © 2024, Itasca | Updated: Aug 13, 2024 |