VolMesh.add_halfface

VolMesh.add_halfface(vertices, fkey=None, attr_dict=None, **kwattr)

Add a face to the volmesh object.

Parameters:

verticeslist[int]

A list of ordered vertex keys representing the face. For every vertex that does not yet exist, a new vertex is created.

fkeyint, optional

The face identifier.

attr_dictdict[str, Any], optional

dictionary of halfface attributes.

**kwattrdict[str, Any], optional

A dictionary of additional attributes compiled of remaining named arguments.

Returns:

int

The key of the face.

Raises:

ValueError

If the number of vertices is less than 3.

See also

add_vertex(), add_cell()

Notes

If no key is provided for the face, one is generated automatically. An automatically generated key is an integer that increments the highest integer value of any key used so far by 1.

If a key with an integer value is provided that is higher than the current highest integer key value, then the highest integer value is updated accordingly.