Boundary conditions
Module: xfea.model.bcs
Boundary conditions on nodes: supports, spring supports and imposed temperatures.
A support holds some of a node’s six displacements at zero: translations
x, y, z and rotations xx, yy, zz. The predefined
supports (fixed, pinned, rollers, clamps) hold common sets of them;
GeneralBC holds any set. A thermal boundary condition imposes a
node’s temperature.
BoundaryConditionBase
Section titled “BoundaryConditionBase”BoundaryConditionBase(**kwargs)
The base of every boundary condition on nodes, mechanical or thermal.
Abstract: use a concrete condition, such as GeneralBC.
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.
registrationAny | None
The object this one is registered to (a part, a model, a step, …), or None.
uidUUID | Noneread-only
The object’s unique id, a UUID.
ClampBCXX
Section titled “ClampBCXX”ClampBCXX(**kwargs)
A support holding the three translations and the rotation about x.
Parameters
| Name | Type | Description |
|---|---|---|
| frame | Frame, optional |
The frame whose axes the held directions are along, or None for the global axes. |
Properties
Xboolread-only
bool: Whether the translation along the global x axis is held.
XXboolread-only
bool: Whether the rotation about the global x axis is held.
Yboolread-only
bool: Whether the translation along the global y axis is held.
YYboolread-only
bool: Whether the rotation about the global y axis is held.
Zboolread-only
bool: Whether the translation along the global z axis is held.
ZZboolread-only
bool: Whether the rotation about the global z axis is held.
componentsdict[str, Any]read-only
dict: {"x": bool, ..., "zz": bool}, the held directions in the frame’s axes.
frameFrame
The object’s local frame, or the global frame if it has none; set it to None to remove it.
global_componentsdict[str, bool]read-only
dict: {"X": bool, ..., "ZZ": bool}, the held directions in the global axes.
has_local_frameboolread-only
Whether the object has a local frame of its own.
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.
registrationAny | None
The object this one is registered to (a part, a model, a step, …), or None.
uidUUID | Noneread-only
The object’s unique id, a UUID.
xboolread-only
bool: Whether the translation along the frame’s x axis is held.
xxboolread-only
bool: Whether the rotation about the frame’s x axis is held.
yboolread-only
bool: Whether the translation along the frame’s y axis is held.
yyboolread-only
bool: Whether the rotation about the frame’s y axis is held.
zboolread-only
bool: Whether the translation along the frame’s z axis is held.
zzboolread-only
bool: Whether the rotation about the frame’s z axis is held.
ClampBCXXYY
Section titled “ClampBCXXYY”ClampBCXXYY(**kwargs)
A support holding the three translations and the rotations about x and y.
Parameters
| Name | Type | Description |
|---|---|---|
| frame | Frame, optional |
The frame whose axes the held directions are along, or None for the global axes. |
Properties
Xboolread-only
bool: Whether the translation along the global x axis is held.
XXboolread-only
bool: Whether the rotation about the global x axis is held.
Yboolread-only
bool: Whether the translation along the global y axis is held.
YYboolread-only
bool: Whether the rotation about the global y axis is held.
Zboolread-only
bool: Whether the translation along the global z axis is held.
ZZboolread-only
bool: Whether the rotation about the global z axis is held.
componentsdict[str, Any]read-only
dict: {"x": bool, ..., "zz": bool}, the held directions in the frame’s axes.
frameFrame
The object’s local frame, or the global frame if it has none; set it to None to remove it.
global_componentsdict[str, bool]read-only
dict: {"X": bool, ..., "ZZ": bool}, the held directions in the global axes.
has_local_frameboolread-only
Whether the object has a local frame of its own.
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.
registrationAny | None
The object this one is registered to (a part, a model, a step, …), or None.
uidUUID | Noneread-only
The object’s unique id, a UUID.
xboolread-only
bool: Whether the translation along the frame’s x axis is held.
xxboolread-only
bool: Whether the rotation about the frame’s x axis is held.
yboolread-only
bool: Whether the translation along the frame’s y axis is held.
yyboolread-only
bool: Whether the rotation about the frame’s y axis is held.
zboolread-only
bool: Whether the translation along the frame’s z axis is held.
zzboolread-only
bool: Whether the rotation about the frame’s z axis is held.
ClampBCXXZZ
Section titled “ClampBCXXZZ”ClampBCXXZZ(**kwargs)
A support holding the three translations and the rotations about x and z.
Parameters
| Name | Type | Description |
|---|---|---|
| frame | Frame, optional |
The frame whose axes the held directions are along, or None for the global axes. |
Properties
Xboolread-only
bool: Whether the translation along the global x axis is held.
XXboolread-only
bool: Whether the rotation about the global x axis is held.
Yboolread-only
bool: Whether the translation along the global y axis is held.
YYboolread-only
bool: Whether the rotation about the global y axis is held.
Zboolread-only
bool: Whether the translation along the global z axis is held.
ZZboolread-only
bool: Whether the rotation about the global z axis is held.
componentsdict[str, Any]read-only
dict: {"x": bool, ..., "zz": bool}, the held directions in the frame’s axes.
frameFrame
The object’s local frame, or the global frame if it has none; set it to None to remove it.
global_componentsdict[str, bool]read-only
dict: {"X": bool, ..., "ZZ": bool}, the held directions in the global axes.
has_local_frameboolread-only
Whether the object has a local frame of its own.
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.
registrationAny | None
The object this one is registered to (a part, a model, a step, …), or None.
uidUUID | Noneread-only
The object’s unique id, a UUID.
xboolread-only
bool: Whether the translation along the frame’s x axis is held.
xxboolread-only
bool: Whether the rotation about the frame’s x axis is held.
yboolread-only
bool: Whether the translation along the frame’s y axis is held.
yyboolread-only
bool: Whether the rotation about the frame’s y axis is held.
zboolread-only
bool: Whether the translation along the frame’s z axis is held.
zzboolread-only
bool: Whether the rotation about the frame’s z axis is held.
ClampBCYY
Section titled “ClampBCYY”ClampBCYY(**kwargs)
A support holding the three translations and the rotation about y.
Parameters
| Name | Type | Description |
|---|---|---|
| frame | Frame, optional |
The frame whose axes the held directions are along, or None for the global axes. |
Properties
Xboolread-only
bool: Whether the translation along the global x axis is held.
XXboolread-only
bool: Whether the rotation about the global x axis is held.
Yboolread-only
bool: Whether the translation along the global y axis is held.
YYboolread-only
bool: Whether the rotation about the global y axis is held.
Zboolread-only
bool: Whether the translation along the global z axis is held.
ZZboolread-only
bool: Whether the rotation about the global z axis is held.
componentsdict[str, Any]read-only
dict: {"x": bool, ..., "zz": bool}, the held directions in the frame’s axes.
frameFrame
The object’s local frame, or the global frame if it has none; set it to None to remove it.
global_componentsdict[str, bool]read-only
dict: {"X": bool, ..., "ZZ": bool}, the held directions in the global axes.
has_local_frameboolread-only
Whether the object has a local frame of its own.
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.
registrationAny | None
The object this one is registered to (a part, a model, a step, …), or None.
uidUUID | Noneread-only
The object’s unique id, a UUID.
xboolread-only
bool: Whether the translation along the frame’s x axis is held.
xxboolread-only
bool: Whether the rotation about the frame’s x axis is held.
yboolread-only
bool: Whether the translation along the frame’s y axis is held.
yyboolread-only
bool: Whether the rotation about the frame’s y axis is held.
zboolread-only
bool: Whether the translation along the frame’s z axis is held.
zzboolread-only
bool: Whether the rotation about the frame’s z axis is held.
ClampBCYYZZ
Section titled “ClampBCYYZZ”ClampBCYYZZ(**kwargs)
A support holding the three translations and the rotations about y and z.
Parameters
| Name | Type | Description |
|---|---|---|
| frame | Frame, optional |
The frame whose axes the held directions are along, or None for the global axes. |
Properties
Xboolread-only
bool: Whether the translation along the global x axis is held.
XXboolread-only
bool: Whether the rotation about the global x axis is held.
Yboolread-only
bool: Whether the translation along the global y axis is held.
YYboolread-only
bool: Whether the rotation about the global y axis is held.
Zboolread-only
bool: Whether the translation along the global z axis is held.
ZZboolread-only
bool: Whether the rotation about the global z axis is held.
componentsdict[str, Any]read-only
dict: {"x": bool, ..., "zz": bool}, the held directions in the frame’s axes.
frameFrame
The object’s local frame, or the global frame if it has none; set it to None to remove it.
global_componentsdict[str, bool]read-only
dict: {"X": bool, ..., "ZZ": bool}, the held directions in the global axes.
has_local_frameboolread-only
Whether the object has a local frame of its own.
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.
registrationAny | None
The object this one is registered to (a part, a model, a step, …), or None.
uidUUID | Noneread-only
The object’s unique id, a UUID.
xboolread-only
bool: Whether the translation along the frame’s x axis is held.
xxboolread-only
bool: Whether the rotation about the frame’s x axis is held.
yboolread-only
bool: Whether the translation along the frame’s y axis is held.
yyboolread-only
bool: Whether the rotation about the frame’s y axis is held.
zboolread-only
bool: Whether the translation along the frame’s z axis is held.
zzboolread-only
bool: Whether the rotation about the frame’s z axis is held.
ClampBCZZ
Section titled “ClampBCZZ”ClampBCZZ(**kwargs)
A support holding the three translations and the rotation about z.
Parameters
| Name | Type | Description |
|---|---|---|
| frame | Frame, optional |
The frame whose axes the held directions are along, or None for the global axes. |
Properties
Xboolread-only
bool: Whether the translation along the global x axis is held.
XXboolread-only
bool: Whether the rotation about the global x axis is held.
Yboolread-only
bool: Whether the translation along the global y axis is held.
YYboolread-only
bool: Whether the rotation about the global y axis is held.
Zboolread-only
bool: Whether the translation along the global z axis is held.
ZZboolread-only
bool: Whether the rotation about the global z axis is held.
componentsdict[str, Any]read-only
dict: {"x": bool, ..., "zz": bool}, the held directions in the frame’s axes.
frameFrame
The object’s local frame, or the global frame if it has none; set it to None to remove it.
global_componentsdict[str, bool]read-only
dict: {"X": bool, ..., "ZZ": bool}, the held directions in the global axes.
has_local_frameboolread-only
Whether the object has a local frame of its own.
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.
registrationAny | None
The object this one is registered to (a part, a model, a step, …), or None.
uidUUID | Noneread-only
The object’s unique id, a UUID.
xboolread-only
bool: Whether the translation along the frame’s x axis is held.
xxboolread-only
bool: Whether the rotation about the frame’s x axis is held.
yboolread-only
bool: Whether the translation along the frame’s y axis is held.
yyboolread-only
bool: Whether the rotation about the frame’s y axis is held.
zboolread-only
bool: Whether the translation along the frame’s z axis is held.
zzboolread-only
bool: Whether the rotation about the frame’s z axis is held.
FixedBC
Section titled “FixedBC”FixedBC(**kwargs)
A fixed support: all three translations and all three rotations held.
Parameters
| Name | Type | Description |
|---|---|---|
| frame | Frame, optional |
The frame whose axes the held directions are along, or None for the global axes. |
Properties
Xboolread-only
bool: Whether the translation along the global x axis is held.
XXboolread-only
bool: Whether the rotation about the global x axis is held.
Yboolread-only
bool: Whether the translation along the global y axis is held.
YYboolread-only
bool: Whether the rotation about the global y axis is held.
Zboolread-only
bool: Whether the translation along the global z axis is held.
ZZboolread-only
bool: Whether the rotation about the global z axis is held.
componentsdict[str, Any]read-only
dict: {"x": bool, ..., "zz": bool}, the held directions in the frame’s axes.
frameFrame
The object’s local frame, or the global frame if it has none; set it to None to remove it.
global_componentsdict[str, bool]read-only
dict: {"X": bool, ..., "ZZ": bool}, the held directions in the global axes.
has_local_frameboolread-only
Whether the object has a local frame of its own.
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.
registrationAny | None
The object this one is registered to (a part, a model, a step, …), or None.
uidUUID | Noneread-only
The object’s unique id, a UUID.
xboolread-only
bool: Whether the translation along the frame’s x axis is held.
xxboolread-only
bool: Whether the rotation about the frame’s x axis is held.
yboolread-only
bool: Whether the translation along the frame’s y axis is held.
yyboolread-only
bool: Whether the rotation about the frame’s y axis is held.
zboolread-only
bool: Whether the translation along the frame’s z axis is held.
zzboolread-only
bool: Whether the rotation about the frame’s z axis is held.
FixedBCX
Section titled “FixedBCX”FixedBCX(**kwargs)
A support holding the translation along x and the rotation about x.
Parameters
| Name | Type | Description |
|---|---|---|
| frame | Frame, optional |
The frame whose axes the held directions are along, or None for the global axes. |
Properties
Xboolread-only
bool: Whether the translation along the global x axis is held.
XXboolread-only
bool: Whether the rotation about the global x axis is held.
Yboolread-only
bool: Whether the translation along the global y axis is held.
YYboolread-only
bool: Whether the rotation about the global y axis is held.
Zboolread-only
bool: Whether the translation along the global z axis is held.
ZZboolread-only
bool: Whether the rotation about the global z axis is held.
componentsdict[str, Any]read-only
dict: {"x": bool, ..., "zz": bool}, the held directions in the frame’s axes.
frameFrame
The object’s local frame, or the global frame if it has none; set it to None to remove it.
global_componentsdict[str, bool]read-only
dict: {"X": bool, ..., "ZZ": bool}, the held directions in the global axes.
has_local_frameboolread-only
Whether the object has a local frame of its own.
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.
registrationAny | None
The object this one is registered to (a part, a model, a step, …), or None.
uidUUID | Noneread-only
The object’s unique id, a UUID.
xboolread-only
bool: Whether the translation along the frame’s x axis is held.
xxboolread-only
bool: Whether the rotation about the frame’s x axis is held.
yboolread-only
bool: Whether the translation along the frame’s y axis is held.
yyboolread-only
bool: Whether the rotation about the frame’s y axis is held.
zboolread-only
bool: Whether the translation along the frame’s z axis is held.
zzboolread-only
bool: Whether the rotation about the frame’s z axis is held.
FixedBCY
Section titled “FixedBCY”FixedBCY(**kwargs)
A support holding the translation along y and the rotation about y.
Parameters
| Name | Type | Description |
|---|---|---|
| frame | Frame, optional |
The frame whose axes the held directions are along, or None for the global axes. |
Properties
Xboolread-only
bool: Whether the translation along the global x axis is held.
XXboolread-only
bool: Whether the rotation about the global x axis is held.
Yboolread-only
bool: Whether the translation along the global y axis is held.
YYboolread-only
bool: Whether the rotation about the global y axis is held.
Zboolread-only
bool: Whether the translation along the global z axis is held.
ZZboolread-only
bool: Whether the rotation about the global z axis is held.
componentsdict[str, Any]read-only
dict: {"x": bool, ..., "zz": bool}, the held directions in the frame’s axes.
frameFrame
The object’s local frame, or the global frame if it has none; set it to None to remove it.
global_componentsdict[str, bool]read-only
dict: {"X": bool, ..., "ZZ": bool}, the held directions in the global axes.
has_local_frameboolread-only
Whether the object has a local frame of its own.
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.
registrationAny | None
The object this one is registered to (a part, a model, a step, …), or None.
uidUUID | Noneread-only
The object’s unique id, a UUID.
xboolread-only
bool: Whether the translation along the frame’s x axis is held.
xxboolread-only
bool: Whether the rotation about the frame’s x axis is held.
yboolread-only
bool: Whether the translation along the frame’s y axis is held.
yyboolread-only
bool: Whether the rotation about the frame’s y axis is held.
zboolread-only
bool: Whether the translation along the frame’s z axis is held.
zzboolread-only
bool: Whether the rotation about the frame’s z axis is held.
FixedBCZ
Section titled “FixedBCZ”FixedBCZ(**kwargs)
A support holding the translation along z and the rotation about z.
Parameters
| Name | Type | Description |
|---|---|---|
| frame | Frame, optional |
The frame whose axes the held directions are along, or None for the global axes. |
Properties
Xboolread-only
bool: Whether the translation along the global x axis is held.
XXboolread-only
bool: Whether the rotation about the global x axis is held.
Yboolread-only
bool: Whether the translation along the global y axis is held.
YYboolread-only
bool: Whether the rotation about the global y axis is held.
Zboolread-only
bool: Whether the translation along the global z axis is held.
ZZboolread-only
bool: Whether the rotation about the global z axis is held.
componentsdict[str, Any]read-only
dict: {"x": bool, ..., "zz": bool}, the held directions in the frame’s axes.
frameFrame
The object’s local frame, or the global frame if it has none; set it to None to remove it.
global_componentsdict[str, bool]read-only
dict: {"X": bool, ..., "ZZ": bool}, the held directions in the global axes.
has_local_frameboolread-only
Whether the object has a local frame of its own.
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.
registrationAny | None
The object this one is registered to (a part, a model, a step, …), or None.
uidUUID | Noneread-only
The object’s unique id, a UUID.
xboolread-only
bool: Whether the translation along the frame’s x axis is held.
xxboolread-only
bool: Whether the rotation about the frame’s x axis is held.
yboolread-only
bool: Whether the translation along the frame’s y axis is held.
yyboolread-only
bool: Whether the rotation about the frame’s y axis is held.
zboolread-only
bool: Whether the translation along the frame’s z axis is held.
zzboolread-only
bool: Whether the rotation about the frame’s z axis is held.
GeneralBC
Section titled “GeneralBC”GeneralBC(
x: bool = False,
y: bool = False,
z: bool = False,
xx: bool = False,
yy: bool = False,
zz: bool = False,
**kwargs,
)
A support holding any set of a node’s six displacements at zero, the ones set to True.
Parameters
| Name | Type | Description |
|---|---|---|
| x, y, z | bool, optional | Hold the translation along x, y or z. |
| xx, yy, zz | bool, optional | Hold the rotation about x, y or z. |
| frame | Frame, optional |
The frame whose axes the held directions are along, or None for the global axes. |
Properties
Xboolread-only
bool: Whether the translation along the global x axis is held.
XXboolread-only
bool: Whether the rotation about the global x axis is held.
Yboolread-only
bool: Whether the translation along the global y axis is held.
YYboolread-only
bool: Whether the rotation about the global y axis is held.
Zboolread-only
bool: Whether the translation along the global z axis is held.
ZZboolread-only
bool: Whether the rotation about the global z axis is held.
componentsdict[str, Any]read-only
dict: {"x": bool, ..., "zz": bool}, the held directions in the frame’s axes.
frameFrame
The object’s local frame, or the global frame if it has none; set it to None to remove it.
global_componentsdict[str, bool]read-only
dict: {"X": bool, ..., "ZZ": bool}, the held directions in the global axes.
has_local_frameboolread-only
Whether the object has a local frame of its own.
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.
registrationAny | None
The object this one is registered to (a part, a model, a step, …), or None.
uidUUID | Noneread-only
The object’s unique id, a UUID.
xboolread-only
bool: Whether the translation along the frame’s x axis is held.
xxboolread-only
bool: Whether the rotation about the frame’s x axis is held.
yboolread-only
bool: Whether the translation along the frame’s y axis is held.
yyboolread-only
bool: Whether the rotation about the frame’s y axis is held.
zboolread-only
bool: Whether the translation along the frame’s z axis is held.
zzboolread-only
bool: Whether the rotation about the frame’s z axis is held.
ImposedTemperature
Section titled “ImposedTemperature”ImposedTemperature(temperature: float, **kwargs)
A temperature imposed at nodes, for heat transfer and thermal stress analyses.
Parameters
| Name | Type | Description |
|---|---|---|
| temperature | float | The temperature, in the model’s temperature unit (as the material constants per degree). |
| **kwargs | dict, optional | Passed on, such as name. |
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.
registrationAny | None
The object this one is registered to (a part, a model, a step, …), or None.
temperaturefloat
float: The imposed temperature.
uidUUID | Noneread-only
The object’s unique id, a UUID.
MechanicalBC
Section titled “MechanicalBC”MechanicalBC(
x: bool = False,
y: bool = False,
z: bool = False,
xx: bool = False,
yy: bool = False,
zz: bool = False,
frame: Frame | None = None,
**kwargs,
)
The base of the supports: which of a node’s six displacements are held at zero.
The held directions are set in lowercase (x, y, z, xx,
yy, zz), along the axes of frame, or the global axes without
one. The uppercase ones (X to ZZ) are derived, in global axes: a
global direction is held only if every local direction with a component
along it is held. Two supports in the same frame add up with +.
Abstract: use a concrete support, such as GeneralBC.
Parameters----------frame : `Frame`, optional The frame whose axes the held directions are along, or None for the global axes.
Notes-----Apply it to nodes with the model's ``add_*_bc`` methods, or with``model.add_bcs(MechanicalBCField(nodes, bc))``. ``x``, ``y`` and ``z`` arethe translations along the frame's axes, ``xx``, ``yy`` and ``zz`` therotations about them; ``X`` to ``ZZ`` say what is held along the global axes.
In a turned frame the solver plugin holds the translations along theframe's axes (as equations); it holds a rotation only about an axis thatis a global one, and refuses the others.Properties
Xboolread-only
bool: Whether the translation along the global x axis is held.
XXboolread-only
bool: Whether the rotation about the global x axis is held.
Yboolread-only
bool: Whether the translation along the global y axis is held.
YYboolread-only
bool: Whether the rotation about the global y axis is held.
Zboolread-only
bool: Whether the translation along the global z axis is held.
ZZboolread-only
bool: Whether the rotation about the global z axis is held.
componentsdict[str, Any]read-only
dict: {"x": bool, ..., "zz": bool}, the held directions in the frame’s axes.
frameFrame
The object’s local frame, or the global frame if it has none; set it to None to remove it.
global_componentsdict[str, bool]read-only
dict: {"X": bool, ..., "ZZ": bool}, the held directions in the global axes.
has_local_frameboolread-only
Whether the object has a local frame of its own.
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.
registrationAny | None
The object this one is registered to (a part, a model, a step, …), or None.
uidUUID | Noneread-only
The object’s unique id, a UUID.
xboolread-only
bool: Whether the translation along the frame’s x axis is held.
xxboolread-only
bool: Whether the rotation about the frame’s x axis is held.
yboolread-only
bool: Whether the translation along the frame’s y axis is held.
yyboolread-only
bool: Whether the rotation about the frame’s y axis is held.
zboolread-only
bool: Whether the translation along the frame’s z axis is held.
zzboolread-only
bool: Whether the rotation about the frame’s z axis is held.
Methods
global_constraint_equations()→list[tuple[dict[str, float], float]]
The held local translations as equations in the global displacements, one per held direction.
Returns
| Name | Type | Description |
|---|---|---|
| list[tuple[dict, float]] | ({"UX": a, "UY": b, "UZ": c}, 0.0) for each held local translation, meaning a UX + b UY + c UZ = 0, with (a, b, c) its axis in global coordinates. Rotations are not included. |
PinnedBC
Section titled “PinnedBC”PinnedBC(**kwargs)
A pinned support: the three translations held, the rotations free.
Parameters
| Name | Type | Description |
|---|---|---|
| frame | Frame, optional |
The frame whose axes the held directions are along, or None for the global axes. |
Properties
Xboolread-only
bool: Whether the translation along the global x axis is held.
XXboolread-only
bool: Whether the rotation about the global x axis is held.
Yboolread-only
bool: Whether the translation along the global y axis is held.
YYboolread-only
bool: Whether the rotation about the global y axis is held.
Zboolread-only
bool: Whether the translation along the global z axis is held.
ZZboolread-only
bool: Whether the rotation about the global z axis is held.
componentsdict[str, Any]read-only
dict: {"x": bool, ..., "zz": bool}, the held directions in the frame’s axes.
frameFrame
The object’s local frame, or the global frame if it has none; set it to None to remove it.
global_componentsdict[str, bool]read-only
dict: {"X": bool, ..., "ZZ": bool}, the held directions in the global axes.
has_local_frameboolread-only
Whether the object has a local frame of its own.
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.
registrationAny | None
The object this one is registered to (a part, a model, a step, …), or None.
uidUUID | Noneread-only
The object’s unique id, a UUID.
xboolread-only
bool: Whether the translation along the frame’s x axis is held.
xxboolread-only
bool: Whether the rotation about the frame’s x axis is held.
yboolread-only
bool: Whether the translation along the frame’s y axis is held.
yyboolread-only
bool: Whether the rotation about the frame’s y axis is held.
zboolread-only
bool: Whether the translation along the frame’s z axis is held.
zzboolread-only
bool: Whether the rotation about the frame’s z axis is held.
RollerBCX
Section titled “RollerBCX”RollerBCX(**kwargs)
A roller free to slide along x: the translations along y and z held, the rotations free.
Parameters
| Name | Type | Description |
|---|---|---|
| frame | Frame, optional |
The frame whose axes the held directions are along, or None for the global axes. |
Properties
Xboolread-only
bool: Whether the translation along the global x axis is held.
XXboolread-only
bool: Whether the rotation about the global x axis is held.
Yboolread-only
bool: Whether the translation along the global y axis is held.
YYboolread-only
bool: Whether the rotation about the global y axis is held.
Zboolread-only
bool: Whether the translation along the global z axis is held.
ZZboolread-only
bool: Whether the rotation about the global z axis is held.
componentsdict[str, Any]read-only
dict: {"x": bool, ..., "zz": bool}, the held directions in the frame’s axes.
frameFrame
The object’s local frame, or the global frame if it has none; set it to None to remove it.
global_componentsdict[str, bool]read-only
dict: {"X": bool, ..., "ZZ": bool}, the held directions in the global axes.
has_local_frameboolread-only
Whether the object has a local frame of its own.
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.
registrationAny | None
The object this one is registered to (a part, a model, a step, …), or None.
uidUUID | Noneread-only
The object’s unique id, a UUID.
xboolread-only
bool: Whether the translation along the frame’s x axis is held.
xxboolread-only
bool: Whether the rotation about the frame’s x axis is held.
yboolread-only
bool: Whether the translation along the frame’s y axis is held.
yyboolread-only
bool: Whether the rotation about the frame’s y axis is held.
zboolread-only
bool: Whether the translation along the frame’s z axis is held.
zzboolread-only
bool: Whether the rotation about the frame’s z axis is held.
RollerBCXY
Section titled “RollerBCXY”RollerBCXY(**kwargs)
A roller free to slide in the x-y plane: the translation along z held, the rotations free.
Parameters
| Name | Type | Description |
|---|---|---|
| frame | Frame, optional |
The frame whose axes the held directions are along, or None for the global axes. |
Properties
Xboolread-only
bool: Whether the translation along the global x axis is held.
XXboolread-only
bool: Whether the rotation about the global x axis is held.
Yboolread-only
bool: Whether the translation along the global y axis is held.
YYboolread-only
bool: Whether the rotation about the global y axis is held.
Zboolread-only
bool: Whether the translation along the global z axis is held.
ZZboolread-only
bool: Whether the rotation about the global z axis is held.
componentsdict[str, Any]read-only
dict: {"x": bool, ..., "zz": bool}, the held directions in the frame’s axes.
frameFrame
The object’s local frame, or the global frame if it has none; set it to None to remove it.
global_componentsdict[str, bool]read-only
dict: {"X": bool, ..., "ZZ": bool}, the held directions in the global axes.
has_local_frameboolread-only
Whether the object has a local frame of its own.
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.
registrationAny | None
The object this one is registered to (a part, a model, a step, …), or None.
uidUUID | Noneread-only
The object’s unique id, a UUID.
xboolread-only
bool: Whether the translation along the frame’s x axis is held.
xxboolread-only
bool: Whether the rotation about the frame’s x axis is held.
yboolread-only
bool: Whether the translation along the frame’s y axis is held.
yyboolread-only
bool: Whether the rotation about the frame’s y axis is held.
zboolread-only
bool: Whether the translation along the frame’s z axis is held.
zzboolread-only
bool: Whether the rotation about the frame’s z axis is held.
RollerBCXZ
Section titled “RollerBCXZ”RollerBCXZ(**kwargs)
A roller free to slide in the x-z plane: the translation along y held, the rotations free.
Parameters
| Name | Type | Description |
|---|---|---|
| frame | Frame, optional |
The frame whose axes the held directions are along, or None for the global axes. |
Properties
Xboolread-only
bool: Whether the translation along the global x axis is held.
XXboolread-only
bool: Whether the rotation about the global x axis is held.
Yboolread-only
bool: Whether the translation along the global y axis is held.
YYboolread-only
bool: Whether the rotation about the global y axis is held.
Zboolread-only
bool: Whether the translation along the global z axis is held.
ZZboolread-only
bool: Whether the rotation about the global z axis is held.
componentsdict[str, Any]read-only
dict: {"x": bool, ..., "zz": bool}, the held directions in the frame’s axes.
frameFrame
The object’s local frame, or the global frame if it has none; set it to None to remove it.
global_componentsdict[str, bool]read-only
dict: {"X": bool, ..., "ZZ": bool}, the held directions in the global axes.
has_local_frameboolread-only
Whether the object has a local frame of its own.
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.
registrationAny | None
The object this one is registered to (a part, a model, a step, …), or None.
uidUUID | Noneread-only
The object’s unique id, a UUID.
xboolread-only
bool: Whether the translation along the frame’s x axis is held.
xxboolread-only
bool: Whether the rotation about the frame’s x axis is held.
yboolread-only
bool: Whether the translation along the frame’s y axis is held.
yyboolread-only
bool: Whether the rotation about the frame’s y axis is held.
zboolread-only
bool: Whether the translation along the frame’s z axis is held.
zzboolread-only
bool: Whether the rotation about the frame’s z axis is held.
RollerBCY
Section titled “RollerBCY”RollerBCY(**kwargs)
A roller free to slide along y: the translations along x and z held, the rotations free.
Parameters
| Name | Type | Description |
|---|---|---|
| frame | Frame, optional |
The frame whose axes the held directions are along, or None for the global axes. |
Properties
Xboolread-only
bool: Whether the translation along the global x axis is held.
XXboolread-only
bool: Whether the rotation about the global x axis is held.
Yboolread-only
bool: Whether the translation along the global y axis is held.
YYboolread-only
bool: Whether the rotation about the global y axis is held.
Zboolread-only
bool: Whether the translation along the global z axis is held.
ZZboolread-only
bool: Whether the rotation about the global z axis is held.
componentsdict[str, Any]read-only
dict: {"x": bool, ..., "zz": bool}, the held directions in the frame’s axes.
frameFrame
The object’s local frame, or the global frame if it has none; set it to None to remove it.
global_componentsdict[str, bool]read-only
dict: {"X": bool, ..., "ZZ": bool}, the held directions in the global axes.
has_local_frameboolread-only
Whether the object has a local frame of its own.
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.
registrationAny | None
The object this one is registered to (a part, a model, a step, …), or None.
uidUUID | Noneread-only
The object’s unique id, a UUID.
xboolread-only
bool: Whether the translation along the frame’s x axis is held.
xxboolread-only
bool: Whether the rotation about the frame’s x axis is held.
yboolread-only
bool: Whether the translation along the frame’s y axis is held.
yyboolread-only
bool: Whether the rotation about the frame’s y axis is held.
zboolread-only
bool: Whether the translation along the frame’s z axis is held.
zzboolread-only
bool: Whether the rotation about the frame’s z axis is held.
RollerBCYZ
Section titled “RollerBCYZ”RollerBCYZ(**kwargs)
A roller free to slide in the y-z plane: the translation along x held, the rotations free.
Parameters
| Name | Type | Description |
|---|---|---|
| frame | Frame, optional |
The frame whose axes the held directions are along, or None for the global axes. |
Properties
Xboolread-only
bool: Whether the translation along the global x axis is held.
XXboolread-only
bool: Whether the rotation about the global x axis is held.
Yboolread-only
bool: Whether the translation along the global y axis is held.
YYboolread-only
bool: Whether the rotation about the global y axis is held.
Zboolread-only
bool: Whether the translation along the global z axis is held.
ZZboolread-only
bool: Whether the rotation about the global z axis is held.
componentsdict[str, Any]read-only
dict: {"x": bool, ..., "zz": bool}, the held directions in the frame’s axes.
frameFrame
The object’s local frame, or the global frame if it has none; set it to None to remove it.
global_componentsdict[str, bool]read-only
dict: {"X": bool, ..., "ZZ": bool}, the held directions in the global axes.
has_local_frameboolread-only
Whether the object has a local frame of its own.
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.
registrationAny | None
The object this one is registered to (a part, a model, a step, …), or None.
uidUUID | Noneread-only
The object’s unique id, a UUID.
xboolread-only
bool: Whether the translation along the frame’s x axis is held.
xxboolread-only
bool: Whether the rotation about the frame’s x axis is held.
yboolread-only
bool: Whether the translation along the frame’s y axis is held.
yyboolread-only
bool: Whether the rotation about the frame’s y axis is held.
zboolread-only
bool: Whether the translation along the frame’s z axis is held.
zzboolread-only
bool: Whether the rotation about the frame’s z axis is held.
RollerBCZ
Section titled “RollerBCZ”RollerBCZ(**kwargs)
A roller free to slide along z: the translations along x and y held, the rotations free.
Parameters
| Name | Type | Description |
|---|---|---|
| frame | Frame, optional |
The frame whose axes the held directions are along, or None for the global axes. |
Properties
Xboolread-only
bool: Whether the translation along the global x axis is held.
XXboolread-only
bool: Whether the rotation about the global x axis is held.
Yboolread-only
bool: Whether the translation along the global y axis is held.
YYboolread-only
bool: Whether the rotation about the global y axis is held.
Zboolread-only
bool: Whether the translation along the global z axis is held.
ZZboolread-only
bool: Whether the rotation about the global z axis is held.
componentsdict[str, Any]read-only
dict: {"x": bool, ..., "zz": bool}, the held directions in the frame’s axes.
frameFrame
The object’s local frame, or the global frame if it has none; set it to None to remove it.
global_componentsdict[str, bool]read-only
dict: {"X": bool, ..., "ZZ": bool}, the held directions in the global axes.
has_local_frameboolread-only
Whether the object has a local frame of its own.
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.
registrationAny | None
The object this one is registered to (a part, a model, a step, …), or None.
uidUUID | Noneread-only
The object’s unique id, a UUID.
xboolread-only
bool: Whether the translation along the frame’s x axis is held.
xxboolread-only
bool: Whether the rotation about the frame’s x axis is held.
yboolread-only
bool: Whether the translation along the frame’s y axis is held.
yyboolread-only
bool: Whether the rotation about the frame’s y axis is held.
zboolread-only
bool: Whether the translation along the frame’s z axis is held.
zzboolread-only
bool: Whether the rotation about the frame’s z axis is held.
SpringSupport
Section titled “SpringSupport”SpringSupport(stiffness: float, direction, only: str | None = None, **kwargs)
An elastic support: at each of its nodes, a spring from a fixed point to the node.
The spring acts along direction (a global vector, normalised here).
Its elongation is the node’s displacement along direction: positive
when the node moves along it (the spring is pulled), negative when it
moves against it (pushed). only makes it one-sided:
None: it resists both ways, a linear spring;"tension": it resists only being pulled, a bolt holding a plate against a support, withdirectionpointing from the support to the plate;"compression": it resists only being pushed, a plate bearing on a support, withdirectionpointing the same way.
Parameters
| Name | Type | Description |
|---|---|---|
| stiffness | float | The spring’s stiffness at each node, force per length (for N and mm: N/mm). Each node gets this stiffness; a stiffness to be shared by several nodes is divided by the user. |
| direction | sequence of 3 floats | The direction the spring acts along, global, normalised here. |
| only | {None, “tension”, “compression”}, optional | Make the spring one-sided. |
| **kwargs | dict, optional | Passed on, such as name. |
Guidance (springs)
- One-sided springs make the step nonlinear: the solver iterates to find which act. Some solvers also need geometric nonlinearity for them (see the solver’s note). At small displacements, as at a joint, that changes the results negligibly: the effect grows with the rotation squared.
Properties
directionlistread-only
list[float]: The unit vector the spring acts along, global.
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.
onlystr | Noneread-only
str: "tension" or "compression" for a one-sided spring, or None for a linear one.
registrationAny | None
The object this one is registered to (a part, a model, a step, …), or None.
stiffnessfloatread-only
float: The spring’s stiffness at each node, force per length.
uidUUID | Noneread-only
The object’s unique id, a UUID.
ThermalBoundaryCondition
Section titled “ThermalBoundaryCondition”ThermalBoundaryCondition(**kwargs)
The base of thermal boundary conditions on nodes.
Abstract: use ImposedTemperature.
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.
registrationAny | None
The object this one is registered to (a part, a model, a step, …), 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