lizzy.entities

class lizzy.entities.Node(x: float, y: float, z: float, idx: int)

Class representing a mesh node.

idx

Unique index of the node.

Type:: int

coords

(x, y, z) coordinates of the node in 3D space [m].

Type:: np.ndarray

triangles

Triangular elements connected to this node.

Type:: list

triangle_ids

Indices of triangular elements connected to this node.

Type:: list

lines

Lines connected to this node.

Type:: list

line_ids

Indices of lines connected to this node.

Type:: list

nodes

Neighbouring nodes connected to this node by an edge.

Type:: list

node_ids

Indices of neighbouring nodes.

Type:: list

class lizzy.entities.Line(node_1: Node, node_2: Node, idx: int)

Class representing a line between two nodes in the mesh.

idx

Unique index of the line.

Type:: int

nodes

The two nodes at the endpoints of the line.

Type:: tuple

midpoint

Midpoint coordinates of the line [m].

Type:: np.ndarray

length

Length of the line [m].

Type:: float

class lizzy.entities.Triangle(node_1: Node, node_2: Node, node_3: Node, line_1: Line, line_2: Line, line_3: Line, n: int)

Class representing a triangular element.

idx

Unique index of the element.

Type:: int

material_tag

Name of the material assigned to this element.

Type:: str

A

Area of the triangular element [m²].

Type:: float

h

Thickness of the element in the out-of-plane direction [m].

Type:: float

k

Permeability tensor of the element [m²].

Type:: np.ndarray

porosity

Porosity of the element.

Type:: float

nodes

The three nodes of the triangle.

Type:: tuple

node_ids

Indices of the three nodes.

Type:: tuple

lines

The three edges of the triangle.

Type:: tuple

line_ids

Indices of the three edges.

Type:: tuple

centroid

Centroid coordinates of the triangle [m].

Type:: np.ndarray

n

Unit normal vector of the triangle plane.

Type:: np.ndarray

class lizzy.entities.CV(node: Node)

Class representing a control volume in the mesh.

node

The mesh node at the centre of this control volume.

Type:: Node

idx

Unique index of the control volume (matches the node index).

Type:: int

area

Area of the control volume [m²].

Type:: float