Skip to content

Groups

Module: xfea.model.groups

ConnectorsGroup(members: Iterable[ForwardRef(ConnectorBase)], **kwargs)

A set of connectors.

Parameters

Name Type Description
members Iterable[ConnectorBase] The connectors.

Attributes

Name Type Description
connectors OrderedSet[ConnectorBase] The connectors, in the order they were added.
model Model | None The model the group is registered to, if any.
Properties
connectorsset[ForwardRef(ConnectorBase)]read-only

The connectors, in the order they were added.

keyAny | Noneread-only

The object’s key (its number) in what it is registered to; None until it is given one.

membersset[_MemberType]read-only

The members, in the order they were added.

modelForwardRef(Model) | Noneread-only

The model the group is registered to, None if it is not registered to a model.

namestr

The object’s name.

partForwardRef(PartBase) | ForwardRef(Part) | ForwardRef(RigidPart) | Noneread-only

The part the group is registered to, None if it is not registered to a part.

registrationAny | None

The object this one is registered to (a part, a model, a step, …), or None.

sortedlist[_MemberType]read-only

The members as a list sorted by their key (their number in the model), ascending.

A member without a key attribute sorts as key 0.

uidUUID | Noneread-only

The object’s unique id, a UUID.

ConstraintsGroup(members: Iterable[ForwardRef(ConstraintBase)], **kwargs)

A set of constraints (rigid couplings and others).

Parameters

Name Type Description
members Iterable[ConstraintBase] The constraints.

Attributes

Name Type Description
constraints OrderedSet[ConstraintBase] The constraints, in the order they were added.
model Model | None The model the group is registered to, if any.
Properties
constraintsset[ForwardRef(ConstraintBase)]read-only

The constraints, in the order they were added.

keyAny | Noneread-only

The object’s key (its number) in what it is registered to; None until it is given one.

membersset[_MemberType]read-only

The members, in the order they were added.

modelForwardRef(Model) | Noneread-only

The model the group is registered to, None if it is not registered to a model.

namestr

The object’s name.

partForwardRef(PartBase) | ForwardRef(Part) | ForwardRef(RigidPart) | Noneread-only

The part the group is registered to, None if it is not registered to a part.

registrationAny | None

The object this one is registered to (a part, a model, a step, …), or None.

sortedlist[_MemberType]read-only

The members as a list sorted by their key (their number in the model), ascending.

A member without a key attribute sorts as key 0.

uidUUID | Noneread-only

The object’s unique id, a UUID.

EdgesGroup(members: Iterable[ForwardRef(Edge)], **kwargs)

A set of element edges.

Parameters

Name Type Description
members Iterable[Edge] The edges.
Properties
edgesset[ForwardRef(Edge)]read-only

The edges, in the order they were added.

keyAny | Noneread-only

The object’s key (its number) in what it is registered to; None until it is given one.

membersset[_MemberType]read-only

The members, in the order they were added.

modelForwardRef(Model) | Noneread-only

The model the group is registered to, None if it is not registered to a model.

namestr

The object’s name.

nodesset[ForwardRef(Node)]read-only

The nodes of the edges, each once.

partForwardRef(PartBase) | ForwardRef(Part) | ForwardRef(RigidPart) | Noneread-only

The part the group is registered to, None if it is not registered to a part.

registrationAny | None

The object this one is registered to (a part, a model, a step, …), or None.

sortedlist[_MemberType]read-only

The members as a list sorted by their key (their number in the model), ascending.

A member without a key attribute sorts as key 0.

uidUUID | Noneread-only

The object’s unique id, a UUID.

ElementsGroup(members: Iterable[ForwardRef(ElementBase)], **kwargs)

A set of elements, e.g. those given a section or whose results are wanted.

Parameters

Name Type Description
members Iterable[ElementBase] The elements.

Attributes

Name Type Description
elements OrderedSet[ElementBase] The elements, in the order they were added.
part PartBase | None The part the group is registered to, if any.
model Model | None The model the group is registered to, if any.
Properties
elementsset[ForwardRef(ElementBase) | ForwardRef(Element1DBase) | ForwardRef(Element2DBase) | ForwardRef(Element3DBase)]read-only

The elements, in the order they were added.

keyAny | Noneread-only

The object’s key (its number) in what it is registered to; None until it is given one.

membersset[_MemberType]read-only

The members, in the order they were added.

modelForwardRef(Model) | Noneread-only

The model the group is registered to, None if it is not registered to a model.

namestr

The object’s name.

partForwardRef(PartBase) | ForwardRef(Part) | ForwardRef(RigidPart) | Noneread-only

The part the group is registered to, None if it is not registered to a part.

registrationAny | None

The object this one is registered to (a part, a model, a step, …), or None.

sortedlist[_MemberType]read-only

The members as a list sorted by their key (their number in the model), ascending.

A member without a key attribute sorts as key 0.

uidUUID | Noneread-only

The object’s unique id, a UUID.

FacesGroup(members: Iterable[ForwardRef(Face)], **kwargs)

A set of element faces, e.g. a side a pressure acts on or a surface of a contact.

Parameters

Name Type Description
members Iterable[Face] The faces.

Attributes

Name Type Description
faces OrderedSet[Face] The faces, in the order they were added.
nodes OrderedSet[Node] The nodes of the faces, each once.
area float The total area of the faces, in the model’s area unit.
normal list[float] The unit vector of the faces’ average normal.
part PartBase | None The part the group is registered to, if any.
model Model | None The model of that part, if any.
Properties
areafloatread-only

The total area of the faces, in the model’s area unit (mm² for mm).

boundaryread-only

The outline of the faces’ mesh, as a Polygon of its boundary vertices.

centroidlist[float]read-only

The centroid of the faces’ centroids (x, y, z), in the model’s length unit; raises AttributeError for an empty group.

Each face counts the same, whatever its area.

facesset[ForwardRef(Face)]read-only

The faces, in the order they were added.

keyAny | Noneread-only

The object’s key (its number) in what it is registered to; None until it is given one.

membersset[_MemberType]read-only

The members, in the order they were added.

meshMeshread-only

The faces as a Mesh, one vertex per node: faces sharing a node share the vertex.

modelModel | Noneread-only

The model of the group’s part, None if none.

namestr

The object’s name.

nodesset[ForwardRef(Node)]read-only

The nodes of the faces, each once.

normallist[float]read-only

The unit vector of the faces’ average normal; raises AttributeError for an empty group.

partPartBase | Noneread-only

The part the group is registered to, None if none.

registrationAny | None

The object this one is registered to (a part, a model, a step, …), or None.

sortedlist[_MemberType]read-only

The members as a list sorted by their key (their number in the model), ascending.

A member without a key attribute sorts as key 0.

uidUUID | Noneread-only

The object’s unique id, a UUID.

FieldsGroup(members: Iterable[ForwardRef(ConditionsFieldBase)], **kwargs)

A set of condition fields: supports and initial conditions, each given to its nodes.

Parameters

Name Type Description
members Iterable[ConditionsFieldBase] The fields.

Attributes

Name Type Description
fields OrderedSet[ConditionsFieldBase] The fields, in the order they were added.
model Model | None The model the group is registered to, if any.
Properties
fieldsset[ForwardRef(ConditionsFieldBase)]read-only

The fields, in the order they were added.

keyAny | Noneread-only

The object’s key (its number) in what it is registered to; None until it is given one.

membersset[_MemberType]read-only

The members, in the order they were added.

modelForwardRef(Model) | Noneread-only

The model the group is registered to, None if it is not registered to a model.

namestr

The object’s name.

partForwardRef(PartBase) | ForwardRef(Part) | ForwardRef(RigidPart) | Noneread-only

The part the group is registered to, None if it is not registered to a part.

registrationAny | None

The object this one is registered to (a part, a model, a step, …), or None.

sortedlist[_MemberType]read-only

The members as a list sorted by their key (their number in the model), ascending.

A member without a key attribute sorts as key 0.

uidUUID | Noneread-only

The object’s unique id, a UUID.

GroupBase(member_class: type, members: Iterable[_MemberType] | None = None, **kwargs)

A set of model objects of one type (nodes, elements, faces, parts), kept in the order they were added.

A group is what supports, loads and outputs are given to: the nodes on a plane, the faces of a side. Groups of the same type combine with +, -, union(), intersection() and difference().

Parameters

Name Type Description
member_class type The type every member must be an instance of.
members Iterable, optional The members, or None for an empty group.

Attributes

Name Type Description
members OrderedSet The members, in the order they were added.
part PartBase | None The part the group is registered to, if any.
model Model | None The model the group is registered to, if any.
Properties
keyAny | Noneread-only

The object’s key (its number) in what it is registered to; None until it is given one.

membersset[_MemberType]read-only

The members, in the order they were added.

modelForwardRef(Model) | Noneread-only

The model the group is registered to, None if it is not registered to a model.

namestr

The object’s name.

partForwardRef(PartBase) | ForwardRef(Part) | ForwardRef(RigidPart) | Noneread-only

The part the group is registered to, None if it is not registered to a part.

registrationAny | None

The object this one is registered to (a part, a model, a step, …), or None.

sortedlist[_MemberType]read-only

The members as a list sorted by their key (their number in the model), ascending.

A member without a key attribute sorts as key 0.

uidUUID | Noneread-only

The object’s unique id, a UUID.

Methods
add_member(member)→_MemberType
add_member(member: _MemberType) -> _MemberType

Add a member to the group (nothing changes if it is in already); raises TypeError for a member of the wrong type.

Returns

Name Type Description
_MemberType The member.
add_members(members)→list[_MemberType]
add_members(members: Iterable[_MemberType]) -> list[_MemberType]

Add members to the group, as add_member() does each.

Returns

Name Type Description
List[_MemberType] The members, in the order given.
clear()

Remove every member from the group.

difference(other)→G
difference(other: G) -> G

A new group with the members of this group that are not in another of the same type (the same as -).

Parameters

Name Type Description
other G The other group, of the same type as this one.

Returns

Name Type Description
G The new group of the members only in this one.
group_by(key)→dict[Any, G]
group_by(key: Callable[[~_MemberType], Any]) -> dict[Any, G]

The members split into groups of the same type by the value a key function gives them.

Parameters

Name Type Description
key Callable[[_MemberType], Any] A function that gives the value to group a member by, such as lambda e: e.section.

Returns

Name Type Description
Dict[Any, G] One group per value, keyed by that value, each with this group’s name.
intersection(other)→G
intersection(other: G) -> G

A new group with the members that are in both this group and another of the same type.

Parameters

Name Type Description
other G The other group, of the same type as this one.

Returns

Name Type Description
G The new group of the common members.
remove_member(member)→bool
remove_member(member: object) -> bool

Remove a member from the group; one not in it is logged as a warning.

Parameters

Name Type Description
member _MemberType The member to remove.

Returns

Name Type Description
bool True if the member was removed, False if it was not in the group.
remove_members(members)→list[_MemberType]
remove_members(members: Iterable[_MemberType]) -> list[_MemberType]

Remove members from the group; those not in it are logged as warnings.

Parameters

Name Type Description
members Iterable[_MemberType] The members to remove.

Returns

Name Type Description
List[_MemberType] The members that were in the group and are removed.
sorted_by(key, reverse=False)→list[_MemberType]
sorted_by(
    key: Callable[[~_MemberType], str | int | float],
    reverse: bool = False,
) -> list[_MemberType]

The members as a list sorted by a key function, e.g. lambda n: n.z.

Parameters

Name Type Description
key Callable[[_MemberType], str | int | float] A function that gives the value to sort a member by.
reverse bool, optional True to sort in descending order; by default ascending.

Returns

Name Type Description
List[_MemberType] The sorted members.
subgroup(condition, **kwargs)→G
subgroup(condition: Callable[[~_MemberType], bool], **kwargs) -> G

A new group of the same type with the members that satisfy a condition, e.g. lambda n: n.z > 0.

Parameters

Name Type Description
condition Callable[[_MemberType], bool] A function that returns True for a member to keep.
**kwargs Passed to the new group’s constructor, such as name.

Returns

Name Type Description
G The new group, the members in their order here.
to_list()→list[_MemberType]

The members as a list, in the order they were added.

union(other)→G
union(other: G) -> G

A new group with the members of this group and of another of the same type (the same as +).

Parameters

Name Type Description
other G The other group, of the same type as this one.

Returns

Name Type Description
G The new group: this group’s members, then the other’s not already in it.
unique(key=None)→G
unique(key: Callable[[~_MemberType], Any] | None = None) -> G

A new group with one member per value of a key function: the first met, e.g. one node per location.

Parameters

Name Type Description
key Callable[[_MemberType], Any], optional A function that gives the value members must not share, such as lambda n: n.gkey; None compares the members themselves.

Returns

Name Type Description
G The new group.
InteractionsGroup(members: Iterable[ForwardRef(InteractionBase)], **kwargs)

A set of interactions (contact behaviours).

Parameters

Name Type Description
members Iterable[InteractionBase] The interactions.

Attributes

Name Type Description
interactions OrderedSet[InteractionBase] The interactions, in the order they were added.
model Model | None The model the group is registered to, if any.
Properties
interactionsset[ForwardRef(InteractionBase)]read-only

The interactions, in the order they were added.

keyAny | Noneread-only

The object’s key (its number) in what it is registered to; None until it is given one.

membersset[_MemberType]read-only

The members, in the order they were added.

modelForwardRef(Model) | Noneread-only

The model the group is registered to, None if it is not registered to a model.

namestr

The object’s name.

partForwardRef(PartBase) | ForwardRef(Part) | ForwardRef(RigidPart) | Noneread-only

The part the group is registered to, None if it is not registered to a part.

registrationAny | None

The object this one is registered to (a part, a model, a step, …), or None.

sortedlist[_MemberType]read-only

The members as a list sorted by their key (their number in the model), ascending.

A member without a key attribute sorts as key 0.

uidUUID | Noneread-only

The object’s unique id, a UUID.

InterfacesGroup(members: Iterable[ForwardRef(InterfaceBase)], **kwargs)

A set of interfaces between parts (contacts and ties).

Parameters

Name Type Description
members Iterable[InterfaceBase] The interfaces.

Attributes

Name Type Description
interfaces OrderedSet[InterfaceBase] The interfaces, in the order they were added.
model Model | None The model the group is registered to, if any.
Properties
interfacesset[ForwardRef(InterfaceBase)]read-only

The interfaces, in the order they were added.

keyAny | Noneread-only

The object’s key (its number) in what it is registered to; None until it is given one.

membersset[_MemberType]read-only

The members, in the order they were added.

modelForwardRef(Model) | Noneread-only

The model the group is registered to, None if it is not registered to a model.

namestr

The object’s name.

partForwardRef(PartBase) | ForwardRef(Part) | ForwardRef(RigidPart) | Noneread-only

The part the group is registered to, None if it is not registered to a part.

registrationAny | None

The object this one is registered to (a part, a model, a step, …), or None.

sortedlist[_MemberType]read-only

The members as a list sorted by their key (their number in the model), ascending.

A member without a key attribute sorts as key 0.

uidUUID | Noneread-only

The object’s unique id, a UUID.

MaterialsGroup(members: Iterable[ForwardRef(MaterialBase)], **kwargs)

A set of materials.

Parameters

Name Type Description
members Iterable[MaterialBase] The materials.

Attributes

Name Type Description
materials OrderedSet[MaterialBase] The materials, in the order they were added.
model Model | None The model the group is registered to, if any.
Properties
keyAny | Noneread-only

The object’s key (its number) in what it is registered to; None until it is given one.

materialsset[ForwardRef(MaterialBase)]read-only

The materials, in the order they were added.

membersset[_MemberType]read-only

The members, in the order they were added.

modelForwardRef(Model) | Noneread-only

The model the group is registered to, None if it is not registered to a model.

namestr

The object’s name.

partForwardRef(PartBase) | ForwardRef(Part) | ForwardRef(RigidPart) | Noneread-only

The part the group is registered to, None if it is not registered to a part.

registrationAny | None

The object this one is registered to (a part, a model, a step, …), or None.

sortedlist[_MemberType]read-only

The members as a list sorted by their key (their number in the model), ascending.

A member without a key attribute sorts as key 0.

uidUUID | Noneread-only

The object’s unique id, a UUID.

NodesGroup(members: Iterable[ForwardRef(Node)] | ForwardRef(Node), **kwargs)

A set of nodes, e.g. those a support holds or a load acts on.

Parameters

Name Type Description
members Iterable[Node] | Node The nodes, or a single node.

Attributes

Name Type Description
nodes OrderedSet[Node] The nodes, in the order they were added.
part PartBase | None The part the group is registered to, if any.
model Model | None The model the group is registered to, if any.
Properties
gkey_nodedict[str, ForwardRef(Node)]read-only

{gkey: node}: the nodes by their geometric key; of nodes at one location, the last one is kept.

keyAny | Noneread-only

The object’s key (its number) in what it is registered to; None until it is given one.

membersset[_MemberType]read-only

The members, in the order they were added.

modelForwardRef(Model) | Noneread-only

The model the group is registered to, None if it is not registered to a model.

namestr

The object’s name.

nodesset[ForwardRef(Node)]read-only

The nodes, in the order they were added.

partForwardRef(PartBase) | ForwardRef(Part) | ForwardRef(RigidPart) | Noneread-only

The part the group is registered to, None if it is not registered to a part.

registrationAny | None

The object this one is registered to (a part, a model, a step, …), or None.

sortedlist[_MemberType]read-only

The members as a list sorted by their key (their number in the model), ascending.

A member without a key attribute sorts as key 0.

uidUUID | Noneread-only

The object’s unique id, a UUID.

OrderedSet(items=())

A set that keeps its members in the order they were added.

A group’s members are paired with lists (a load per node, in order) and iterated to write input files: with a plain set the order changes from run to run, and after pickling, and the pairs come apart.

Methods
add(item)

Add an element.

copy()→OrderedSet

No docstring available.

discard(item)

Remove an element. Do not raise an exception if absent.

union(*others)→OrderedSet

No docstring available.

update(*iterables)

No docstring available.

PartsGroup(members: Iterable[ForwardRef(PartBase)], **kwargs)

A set of parts.

Parameters

Name Type Description
members Iterable[Part] The parts.

Attributes

Name Type Description
parts OrderedSet[Part] The parts, in the order they were added.
model Model | None The model the group is registered to, if any.
Properties
keyAny | Noneread-only

The object’s key (its number) in what it is registered to; None until it is given one.

membersset[_MemberType]read-only

The members, in the order they were added.

modelForwardRef(Model) | Noneread-only

The model the group is registered to, None if it is not registered to a model.

namestr

The object’s name.

partForwardRef(PartBase) | ForwardRef(Part) | ForwardRef(RigidPart) | Noneread-only

The part the group is registered to, None if it is not registered to a part.

partsset[ForwardRef(PartBase)]read-only

The parts, in the order they were added.

registrationAny | None

The object this one is registered to (a part, a model, a step, …), or None.

sortedlist[_MemberType]read-only

The members as a list sorted by their key (their number in the model), ascending.

A member without a key attribute sorts as key 0.

uidUUID | Noneread-only

The object’s unique id, a UUID.

ReleaseFieldsGroup(members: Iterable[ForwardRef(BeamReleaseField)], **kwargs)

A set of beam end release fields, each a release given to beam ends.

Parameters

Name Type Description
members Iterable[BeamReleaseField] The beam end release fields.

Attributes

Name Type Description
fields OrderedSet[BeamReleaseField] The beam end release fields, in the order they were added.
model Model | None The model the group is registered to, if any.
Properties
fieldsset[ForwardRef(BeamReleaseField)]read-only

The beam end release fields, in the order they were added.

keyAny | Noneread-only

The object’s key (its number) in what it is registered to; None until it is given one.

membersset[_MemberType]read-only

The members, in the order they were added.

modelForwardRef(Model) | Noneread-only

The model the group is registered to, None if it is not registered to a model.

namestr

The object’s name.

partForwardRef(PartBase) | ForwardRef(Part) | ForwardRef(RigidPart) | Noneread-only

The part the group is registered to, None if it is not registered to a part.

registrationAny | None

The object this one is registered to (a part, a model, a step, …), or None.

sortedlist[_MemberType]read-only

The members as a list sorted by their key (their number in the model), ascending.

A member without a key attribute sorts as key 0.

uidUUID | Noneread-only

The object’s unique id, a UUID.

ReleasesGroup(members: Iterable[ForwardRef(BeamEndReleaseBase)], **kwargs)

A set of beam end releases.

Parameters

Name Type Description
members Iterable[BeamEndReleaseBase] The beam end releases.

Attributes

Name Type Description
releases OrderedSet[BeamEndReleaseBase] The beam end releases, in the order they were added.
model Model | None The model the group is registered to, if any.
Properties
keyAny | Noneread-only

The object’s key (its number) in what it is registered to; None until it is given one.

membersset[_MemberType]read-only

The members, in the order they were added.

modelForwardRef(Model) | Noneread-only

The model the group is registered to, None if it is not registered to a model.

namestr

The object’s name.

partForwardRef(PartBase) | ForwardRef(Part) | ForwardRef(RigidPart) | Noneread-only

The part the group is registered to, None if it is not registered to a part.

registrationAny | None

The object this one is registered to (a part, a model, a step, …), or None.

releasesset[ForwardRef(BeamEndReleaseBase)]read-only

The beam end releases, in the order they were added.

sortedlist[_MemberType]read-only

The members as a list sorted by their key (their number in the model), ascending.

A member without a key attribute sorts as key 0.

uidUUID | Noneread-only

The object’s unique id, a UUID.

SectionsGroup(members: Iterable[ForwardRef(SectionBase)], **kwargs)

A set of sections.

Parameters

Name Type Description
members Iterable[SectionBase] The sections.

Attributes

Name Type Description
sections OrderedSet[SectionBase] The sections, in the order they were added.
model Model | None The model the group is registered to, if any.
Properties
keyAny | Noneread-only

The object’s key (its number) in what it is registered to; None until it is given one.

membersset[_MemberType]read-only

The members, in the order they were added.

modelForwardRef(Model) | Noneread-only

The model the group is registered to, None if it is not registered to a model.

namestr

The object’s name.

partForwardRef(PartBase) | ForwardRef(Part) | ForwardRef(RigidPart) | Noneread-only

The part the group is registered to, None if it is not registered to a part.

registrationAny | None

The object this one is registered to (a part, a model, a step, …), or None.

sectionsset[ForwardRef(SectionBase)]read-only

The sections, in the order they were added.

sortedlist[_MemberType]read-only

The members as a list sorted by their key (their number in the model), ascending.

A member without a key attribute sorts as key 0.

uidUUID | Noneread-only

The object’s unique id, a UUID.

© 2026 Francesco Ranaudo · Text and pictures CC BY 4.0 · Code Elastic License 2.0 · how to reuse them