Constraints
Module: xfea.model.constraints
BeamMPC
Section titled “BeamMPC”BeamMPC(
constraint_type: str,
master=None,
slaves=None,
tol: float | None = None,
**kwargs,
)
A beam MPC: the slave nodes follow the master node as if joined to it by rigid beams.
Properties
keyAny | Noneread-only
The object’s key (its number) in what it is registered to; None until it is given one.
namestr
The object’s name.
registrationForwardRef(Model) | None
The model the constraint is registered to, or None.
uidUUID | Noneread-only
The object’s unique id, a UUID.
ConstraintBase
Section titled “ConstraintBase”ConstraintBase(**kwargs)
A rule that makes some nodes’ degrees of freedom follow others’, registered to a model.
Properties
keyAny | Noneread-only
The object’s key (its number) in what it is registered to; None until it is given one.
namestr
The object’s name.
registrationForwardRef(Model) | None
The model the constraint is registered to, or None.
uidUUID | Noneread-only
The object’s unique id, a UUID.
CouplingConstraint
Section titled “CouplingConstraint”CouplingConstraint(x=True, y=True, z=True, xx=True, yy=True, zz=True, **kwargs)
Nodes coupled to a reference node in some of the six directions (all by default).
Parameters
| Name | Type | Description |
|---|---|---|
| x, y, z | bool, optional | Couple the translations along global x, y, z. Default True. |
| xx, yy, zz | bool, optional | Couple the rotations about global x, y, z. Default True. |
Properties
keyAny | Noneread-only
The object’s key (its number) in what it is registered to; None until it is given one.
namestr
The object’s name.
registrationForwardRef(Model) | None
The model the constraint is registered to, or None.
uidUUID | Noneread-only
The object’s unique id, a UUID.
MultiPointConstraintBase
Section titled “MultiPointConstraintBase”MultiPointConstraintBase(
constraint_type: str,
master=None,
slaves=None,
tol: float | None = None,
**kwargs,
)
A multi-point constraint (MPC): nodes (slaves) tied to a master node, by a solver’s MPC type.
Parameters
| Name | Type | Description |
|---|---|---|
| constraint_type | str | The solver’s name for the MPC type, e.g. "TIE" or "BEAM". |
| master | Node, optional |
The node the others follow. |
| slaves | list[Node], optional |
The nodes that follow it. |
| tol | float, optional | A position tolerance, a length, or None. |
| name | str, optional | Unique identifier for the constraint. |
Properties
keyAny | Noneread-only
The object’s key (its number) in what it is registered to; None until it is given one.
namestr
The object’s name.
registrationForwardRef(Model) | None
The model the constraint is registered to, or None.
uidUUID | Noneread-only
The object’s unique id, a UUID.
RigidCoupling
Section titled “RigidCoupling”RigidCoupling(reference: Node, nodes, **kwargs)
Nodes that move with a reference node as one rigid body: its translation and its rotation.
How a beam is joined to a plate: the beam’s end node is the reference, the plate’s nodes over the beam’s profile follow it. A load or a support on the reference node acts on all of them.
Parameters
| Name | Type | Description |
|---|---|---|
| reference | Node |
The node the others follow. |
| nodes | list[Node] | NodesGroup |
The nodes that follow it (the reference node itself is left out). |
Properties
keyAny | Noneread-only
The object’s key (its number) in what it is registered to; None until it is given one.
namestr
The object’s name.
nodeslistread-only
The nodes that follow the reference, sorted by key.
referenceNoderead-only
The node the others follow.
registrationForwardRef(Model) | None
The model the constraint is registered to, or None.
uidUUID | Noneread-only
The object’s unique id, a UUID.
SurfaceConstraintBase
Section titled “SurfaceConstraintBase”SurfaceConstraintBase(tol: float | None = None, **kwargs)
How two surfaces are joined, used as the behavior of an interface between two parts.
The surfaces are the interface’s (its master and slave), not the constraint’s.
Parameters
| Name | Type | Description |
|---|---|---|
| tol | float, optional | Position tolerance, a length in the active unit system. None leaves it to the solver. |
| name | str, optional | Unique identifier for the constraint. |
Attributes
| Name | Type | Description |
|---|---|---|
| tol | float | None | Position tolerance, a length. |
Properties
keyAny | Noneread-only
The object’s key (its number) in what it is registered to; None until it is given one.
namestr
The object’s name.
registrationForwardRef(Model) | None
The model the constraint is registered to, or None.
uidUUID | Noneread-only
The object’s unique id, a UUID.
TieConstraint
Section titled “TieConstraint”TieConstraint(tol: float | None = None, **kwargs)
Two parts welded or glued where they touch: the slave surface’s nodes follow the master surface.
Give it as the behavior of detect_interfaces(),
e.g. model.detect_interfaces(behavior=TieConstraint(tol=1e-3), part_pairs=[(base, column)]).
Parameters
| Name | Type | Description |
|---|---|---|
| tol | float, optional | Position tolerance, a length in the active unit system; the solver plugin does not write it. |
| name | str, optional | Unique identifier for the constraint. |
Guidance (contact)
- Do not hold nodes on a tie’s slave (second) face with a support: the solver can leave them
untied. Hold the master side instead (
model.check()flags it).
Properties
keyAny | Noneread-only
The object’s key (its number) in what it is registered to; None until it is given one.
namestr
The object’s name.
registrationForwardRef(Model) | None
The model the constraint is registered to, or None.
uidUUID | Noneread-only
The object’s unique id, a UUID.
TieMPC
Section titled “TieMPC”TieMPC(
constraint_type: str,
master=None,
slaves=None,
tol: float | None = None,
**kwargs,
)
A tie MPC: the slave nodes move as the master node (their degrees of freedom made equal).
Properties
keyAny | Noneread-only
The object’s key (its number) in what it is registered to; None until it is given one.
namestr
The object’s name.
registrationForwardRef(Model) | None
The model the constraint is registered to, or None.
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