Fields
Module: xfea.model.fields
BeamReleaseField
Section titled “BeamReleaseField”BeamReleaseField(release, elements, end, name=None, **kwargs)
One beam end release applied to the same end of a set of 1D elements.
Made by add_beams_releases_fields().
Parameters
| Name | Type | Description |
|---|---|---|
| release | BeamEndReleaseBase |
The release applied. |
| elements | ElementsGroup | list[ElementBase] |
The elements released, all 1D and in the same model. |
| end | str | "start", "end" or "both": which end of each element is released. |
| name | str, optional | Unique identifier for the field. |
Attributes
| Name | Type | Description |
|---|---|---|
| release | BeamEndReleaseBase |
The release applied. |
| elements | ElementsGroup |
The elements released. |
| end | str | Which end of each element is released. |
| part | Part |
The part the field is registered to. |
Properties
elementsElementsGroupread-only
The elements released.
elements_end_releaseread-only
(element, end, release) for each element of the field, as an iterator.
endstrread-only
"start" or "end": which end of each element is released.
keyAny | Noneread-only
The object’s key (its number) in what it is registered to; None until it is given one.
modelModelread-only
The model of the field’s part.
namestr
The object’s name.
partPartBaseread-only
The part the field is registered to; raises ValueError if none.
registrationAny | None
The object this one is registered to (a part, a model, a step, …), or None.
releaseBeamEndReleaseBaseread-only
The release applied.
uidUUID | Noneread-only
The object’s unique id, a UUID.
BoundaryConditionsFieldBase
Section titled “BoundaryConditionsFieldBase”BoundaryConditionsFieldBase(
distribution: NodesGroup | Iterable[Node] | Node,
condition: BoundaryConditionBase,
**kwargs,
)
A boundary condition (a support, a spring support) applied to a set of nodes.
Parameters
| Name | Type | Description |
|---|---|---|
| distribution | NodesGroup | list[Node] | Node |
The nodes held. |
| condition | BoundaryConditionBase |
The boundary condition applied. |
| name | str, optional | Unique identifier for the field. |
Properties
bcBoundaryConditionBaseread-only
The boundary condition applied; raises ValueError if the condition is not one.
conditionBoundaryConditionBase | InitialConditionBaseread-only
The condition applied.
distributionNodesGroup | ElementsGroupread-only
The nodes or elements the condition applies to, as a group.
keyAny | Noneread-only
The object’s key (its number) in what it is registered to; None until it is given one.
modelModelread-only
The model the field’s members are registered to; raises ValueError if none.
namestr
The object’s name.
node_bcread-only
(node, boundary condition) for each node of the field, as an iterator.
node_conditionread-only
(member, condition) for each node or element of the distribution, as an iterator.
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.
ConditionsFieldBase
Section titled “ConditionsFieldBase”ConditionsFieldBase(
distribution: NodesGroup | ElementsGroup | Iterable[Node] | Node | Iterable[ElementBase] | ElementBase,
condition: BoundaryConditionBase | InitialConditionBase,
**kwargs,
)
One condition (a boundary or an initial condition) applied to a set of nodes or elements.
Parameters
| Name | Type | Description |
|---|---|---|
| distribution | NodesGroup | ElementsGroup | list | Node | ElementBase |
Where the condition applies: nodes or elements, a single one, a list or a group. |
| condition | BoundaryConditionBase | InitialConditionBase |
The condition applied. |
| name | str, optional | Unique identifier for the field. |
Attributes
| Name | Type | Description |
|---|---|---|
| condition | BoundaryConditionBase | InitialConditionBase |
The condition applied. |
| distribution | NodesGroup | ElementsGroup |
The nodes or elements it applies to, as a group. |
| model | Model |
The model the field’s members are registered to. |
Properties
conditionBoundaryConditionBase | InitialConditionBaseread-only
The condition applied.
distributionNodesGroup | ElementsGroupread-only
The nodes or elements the condition applies to, as a group.
keyAny | Noneread-only
The object’s key (its number) in what it is registered to; None until it is given one.
modelModelread-only
The model the field’s members are registered to; raises ValueError if none.
namestr
The object’s name.
node_conditionread-only
(member, condition) for each node or element of the distribution, as an iterator.
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.
ConnectorField
Section titled “ConnectorField”ConnectorField(connector: ConnectorBase, **kwargs)
A connector between two parts’ nodes, as the model holds it.
Made by model.add_connector; the nodes are the connector’s own.
Parameters
| Name | Type | Description |
|---|---|---|
| connector | ConnectorBase |
The connector held. |
| name | str, optional | Unique identifier for the field. |
Properties
connectorConnectorBaseread-only
The connector held.
keyAny | Noneread-only
The object’s key (its number) in what it is registered to; None until it is given one.
modelModelread-only
The model the field is registered to; raises ValueError if none.
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.
ConstraintField
Section titled “ConstraintField”ConstraintField(constraint: ConstraintBase, **kwargs)
A constraint, such as a rigid coupling, as the model holds it.
Made by model.add_constraint and model.add_rigid_coupling; the
nodes are the constraint’s own.
Parameters
| Name | Type | Description |
|---|---|---|
| constraint | ConstraintBase |
The constraint held. |
| name | str, optional | Unique identifier for the field. |
Properties
constraintConstraintBaseread-only
The constraint held.
keyAny | Noneread-only
The object’s key (its number) in what it is registered to; None until it is given one.
modelModelread-only
The model the field is registered to; raises ValueError if none.
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.
InitialConditionFieldBase
Section titled “InitialConditionFieldBase”InitialConditionFieldBase(distribution, conditions, **kwargs)
An initial condition (a temperature, a stress) applied to a set of nodes or elements.
Parameters
| Name | Type | Description |
|---|---|---|
| distribution | NodesGroup | ElementsGroup | list |
The nodes or elements it applies to. |
| conditions | InitialConditionBase |
The initial condition applied. |
| name | str, optional | Unique identifier for the field. |
Properties
conditionBoundaryConditionBase | InitialConditionBaseread-only
The condition applied.
distributionNodesGroup | ElementsGroupread-only
The nodes or elements the condition applies to, as a group.
keyAny | Noneread-only
The object’s key (its number) in what it is registered to; None until it is given one.
modelModelread-only
The model the field’s members are registered to; raises ValueError if none.
namestr
The object’s name.
node_conditionread-only
(member, condition) for each node or element of the distribution, as an iterator.
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.
InitialStressField
Section titled “InitialStressField”InitialStressField(elements, condition, **kwargs)
An initial stress in a set of elements.
Parameters
| Name | Type | Description |
|---|---|---|
| elements | ElementsGroup | list[ElementBase] | ElementBase |
The elements stressed. |
| condition | InitialStress |
The initial stress. |
| name | str, optional | Unique identifier for the field. |
Properties
conditionBoundaryConditionBase | InitialConditionBaseread-only
The condition applied.
distributionNodesGroup | ElementsGroupread-only
The nodes or elements the condition applies to, as a group.
keyAny | Noneread-only
The object’s key (its number) in what it is registered to; None until it is given one.
modelModelread-only
The model the field’s members are registered to; raises ValueError if none.
namestr
The object’s name.
node_conditionread-only
(member, condition) for each node or element of the distribution, as an iterator.
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.
InitialTemperatureField
Section titled “InitialTemperatureField”InitialTemperatureField(nodes, condition, **kwargs)
An initial temperature at a set of nodes.
Parameters
| Name | Type | Description |
|---|---|---|
| nodes | NodesGroup | list[Node] | Node |
The nodes at that temperature. |
| condition | InitialTemperature |
The initial temperature. |
| name | str, optional | Unique identifier for the field. |
Properties
conditionBoundaryConditionBase | InitialConditionBaseread-only
The condition applied.
distributionNodesGroup | ElementsGroupread-only
The nodes or elements the condition applies to, as a group.
keyAny | Noneread-only
The object’s key (its number) in what it is registered to; None until it is given one.
modelModelread-only
The model the field’s members are registered to; raises ValueError if none.
namestr
The object’s name.
node_conditionread-only
(member, condition) for each node or element of the distribution, as an iterator.
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.
MechanicalBCField
Section titled “MechanicalBCField”MechanicalBCField(
distribution: NodesGroup | Iterable[Node] | Node,
condition: BoundaryConditionBase,
**kwargs,
)
A mechanical boundary condition (fixed directions, spring supports) on a set of nodes.
Made by the model’s add_*_bc and add_spring_supports methods.
Parameters
| Name | Type | Description |
|---|---|---|
| distribution | NodesGroup | list[Node] | Node |
The nodes held. |
| condition | BoundaryConditionBase |
The boundary condition applied. |
| name | str, optional | Unique identifier for the field. |
Properties
bcBoundaryConditionBaseread-only
The boundary condition applied; raises ValueError if the condition is not one.
conditionBoundaryConditionBase | InitialConditionBaseread-only
The condition applied.
distributionNodesGroup | ElementsGroupread-only
The nodes or elements the condition applies to, as a group.
keyAny | Noneread-only
The object’s key (its number) in what it is registered to; None until it is given one.
modelModelread-only
The model the field’s members are registered to; raises ValueError if none.
namestr
The object’s name.
node_bcread-only
(node, boundary condition) for each node of the field, as an iterator.
node_conditionread-only
(member, condition) for each node or element of the distribution, as an iterator.
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