Vertex
- class itasca.flowplane.vertex.Vertex
Objects of this type should not be created (instantiated) directly in Python. Use the module functions that return instances of this type.
- aperture_hydraulic() float.
Get the hydraulic aperture limited by specified maximum (flowplane property aperture-maximum).
- aperture_mech() float.
Get the mechanical aperture.
- area() float.
Get the lumped area to the vertex.
- extra(slot: int) any.
Get the flowplane vertex extra data in the given slot.
- flowplane() flow plane pointer.
Get the flowplane associated with a given flow plane vertex.
- group([slot: str or int]) str.
Get the flowplane vertex 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 flowplane vertex. 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 flowplane vertex is part of. The keys of the dictionary are the slot names and the values are the group names.
- id() int.
Get the flowplane vertex id.
- in_group(group_name: str or int[, slot: str or int]) bool.
Test if the flowplane vertex 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) of the flow plane vertex.
- knot() flow knot pointer.
Get the flow knot associated with a given flow plane vertex.
- local1() float.
Get the local x-coordinate of a flow plane vertex.
- local2() float.
Get the local x-coordinate of a flow plane vertex.
- pos() vec.
Get the flowplane vertex flowplane vertex position (vector).
- pos_x() float.
Get the x-component of the flowplane vertex flowplane vertex position.
- pos_y() float.
Get the y-component of the flowplane vertex flowplane vertex position.
- pos_z() float.
Get the z-component of the flowplane vertex flowplane vertex position.
- prop(str) float.
Get a flow plane property.
- proppant_mconc() float.
Get the mass concentration of proppant of a flow plane vertex.
- proppant_thick() float.
Get the proppant thickness of a flow plane vertex (volume concentration times aperture).
- proppant_vconc() float.
Get the proppant volume concentration.
- set_aperture_mech(float) None.
Set the mechanical aperture.
- set_extra(slot: int, value: any) None.
Set the flowplane vertex extra data in the given slot.
- set_group(group_name: str or int[, slot: str or int]) None.
Set the flowplane vertex group name in a given slot.
- set_prop(str, float) None.
Set a flow plane property.
- subcontact1() contact pointer.
Get one of the sub-contacts of face-to-face contact used for interpolation.
- subcontact2() contact pointer.
Get one of the sub-contacts of face-to-face contact used for interpolation.
- valid() bool.
Returns True if this flowplane vertex is live.
- visc() float.
Get the viscosity of fluid at the vertex (viscosity will increase from the global value if the proppant concentration is greater than 0).
- weight1() float.
Get the interpolation weight associated with subcontact 1 for a flow plane vertex.
- weight2() float.
Get the interpolation weight associated with subcontact 2 for a flow plane vertex.
Was this helpful? ... | Itasca Software © 2024, Itasca | Updated: Aug 13, 2024 |