Face

class itasca.block.face.Face

Objects of this type should not be created (instantiated) directly in Python. Use the module functions that return instances of this type.

area() → float.

Get the area of a face.

extra(slot: int) → any.

Get the face extra data in the given slot.

fblock() → blockptr.

Get the face block associated with this face.

fid() → int.

Get the DFN fracture ID for this face.

flowplane() → flowplanptr.

Get the fluid flow plane associated with this face.

gp(int) → gridpointptr.

Get the index of vertex number (int) of a face.

gridpoints() → gp list.

Get a list of gridpoints that make up this face.

group([slot: str or int]) → str.

Get the face 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 face. 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 face is part of. The keys of the dictionary are the slot names and the values are the group names.

hostblock() → blockptr.

Get the block to which a face belongs.

id() → int.

Get the face id.

in_group(group_name: str or int[, slot: str or int]) → bool.

Test if the face 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 face.

is_excavated() → bool.

Get the excavated status of the host block.

is_hidden() → bool.

Get the hidden state of the host block.

is_original() → bool.

Get the original block face indicator.

is_planar() → bool.

Get the planar flag for a face.

jset() → int.

Get the joint set ID for this face.

ngp() → int.

Get the number of vertices (gridpoints) on a face.

normal() → vec.

Get the face face normal vector (vector).

normal_x() → float.

Get the x-component of the face face normal vector.

normal_y() → float.

Get the y-component of the face face normal vector.

normal_z() → float.

Get the z-component of the face face normal vector.

pos() → vec.

Get the face location (vector).

pos_x() → float.

Get the x-component of the face location.

pos_y() → float.

Get the y-component of the face location.

pos_z() → float.

Get the z-component of the face location.

set_extra(slot: int, value: any) → None.

Set the face extra data in the given slot.

set_group(group_name: str or int[, slot: str or int]) → None.

Set the face group name in a given slot.

valid() → bool.

Returns True if this face is live.

zone() → zoneptr.

Get the index of that zone that contains the given face.