Groups
Module: xfea.problem.groups
DisplacementsGroup
Section titled “DisplacementsGroup”DisplacementsGroup(
members: Iterable[ForwardRef(GeneralDisplacement)] | ForwardRef(GeneralDisplacement),
**kwargs,
)
Base class for groups of displacements.
Properties
displacementsset[ForwardRef(GeneralDisplacement)]read-only
No docstring available.
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.
LoadsFieldGroup
Section titled “LoadsFieldGroup”LoadsFieldGroup(
members: Iterable[DisplacementField | ForceField] | DisplacementField | ForceField,
**kwargs,
)
Base class for groups of loads that can be applied to a field.
Properties
fieldsIterable[DisplacementField | ForceField]read-only
No docstring available.
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.
LoadsGroup
Section titled “LoadsGroup”LoadsGroup(members: Iterable[ForwardRef(LoadBase)] | ForwardRef(LoadBase), **kwargs)
Base class for groups of loads.
Abstract base class; do not instantiate directly.
Properties
keyAny | Noneread-only
The object’s key (its number) in what it is registered to; None until it is given one.
loadsset[ForwardRef(LoadBase)]read-only
No docstring available.
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.
Module: xfea.problem.combinations
LoadFieldsCombination
Section titled “LoadFieldsCombination”LoadFieldsCombination(
case_factor_dict: Mapping[str, float | Mapping[str, float]],
**kwargs: Any,
)
A load combination: a factor for each load case, applied to a step’s load fields.
Each field’s load_case picks its factor; a factor can depend on the
field’s combination_rank (leading or accompanying action). Add it to
a step with step.add_combination(combo): the step is then solved for
the factored fields. Ready-made Eurocode (EN 1990) and ASCE 7
combinations are the class methods, e.g. ec_uls_persistent().
Parameters
| Name | Type | Description |
|---|---|---|
| case_factor_dict | dict[str, float | dict[str, float]] | The factor of each load case, by its name: a number for all its fields, or a mapping {"primary": ..., "secondary": ..., "tertiary": ..., "default": ...} to choose by the field’s combination_rank. |
| name | str, optional | The combination’s name (e.g. "EC-ULS-PERS"). |
Guidance (loads)
- With a combination on a step, only the fields of the load cases it names are applied:
give every load field a
load_case. Prescribed displacements without a named case are applied unscaled.
Properties
case_factor_dictdict[str, float | Mapping[str, float]]
The factor of each load case, a number or a per-role mapping; setting it checks and converts the factors to floats.
keyAny | Noneread-only
The object’s key (its number) in what it is registered to; None until it is given one.
load_casesIterator[str]read-only
The names of the combination’s load cases, as an iterator.
load_factorsIterator[float | Mapping[str, float]]read-only
The combination’s factors, a number or a per-role mapping each, as an iterator in the order of load_cases.
modelForwardRef(Model) | Noneread-only
The model of the combination’s problem; None if it is not added to a step.
namestr
The object’s name.
problemForwardRef(Problem) | Noneread-only
The problem of the combination’s step; None if it is not added to a step.
registrationAny | None
The object this one is registered to (a part, a model, a step, …), or None.
stepForwardRef(StepBase) | Noneread-only
The step the combination is added to; None if it is not added to one.
uidUUID | Noneread-only
The object’s unique id, a UUID.
Methods
combine_fields(fields)→LoadsFieldGroup
combine_fields(fields: Iterable[Any] | LoadsFieldGroup) -> LoadsFieldGroup
The given fields factored by this combination; fields of load cases it does not name are left out.
A field’s factor is its load case’s: a number, or from a per-role
mapping by its combination_rank (1 "primary", 2
"secondary", 3 "tertiary"). A mapping without that role
falls back to "default", then "secondary", "primary",
"tertiary"; without any of them the factor is 0. Fields with a
factor of 0 are left out. A DisplacementField
whose load case the combination does not name is kept unscaled.
Parameters
| Name | Type | Description |
|---|---|---|
| fields | list | LoadsFieldGroup |
The load fields to combine. |
Returns
| Name | Type | Description |
|---|---|---|
class:xfea.problem.LoadsFieldGroup |
The factored fields: new fields where the factor is not 1, the given ones where it is. |
combine_for_step(step)→LoadsFieldGroup
combine_for_step(step: StepBase) -> LoadsFieldGroup
A step’s fields factored by this combination, as combine_fields() does.
Parameters
| Name | Type | Description |
|---|---|---|
| step | StepBase |
The step whose fields are combined. |
Returns
| Name | Type | Description |
|---|---|---|
class:xfea.problem.LoadsFieldGroup |
The factored fields. |
StepsCombination
Section titled “StepsCombination”StepsCombination(**kwargs: Any)
A combination of the results of several steps: a placeholder, not implemented yet.
It is meant for post-processing, results of several steps summed or enveloped (load scenarios, staged construction). It cannot be created yet: instantiating it raises TypeError.
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.
Module: xfea.problem.amplitudes
Amplitude
Section titled “Amplitude”Amplitude(multipliers, times, **kwargs)
Amplitude object for creating a time-varying function that defines how the magnitude of a load, boundary condition, or predifined field changes throughout a step or the analysis.
Parameters
| Name | Type | Description |
|---|---|---|
| multipliers | list[float] | Multipliers list of values. |
| times | list[float] | Corresponding time to the multipliers. |
Attributes
| Name | Type | Description |
|---|---|---|
| q | float | Heat flux value of the load. |
| amplitude | Amplitude |
Amplitude associated to the load, optionnal. |
Properties
keyAny | Noneread-only
The object’s key (its number) in what it is registered to; None until it is given one.
multipliersread-only
No docstring available.
multipliers_timesread-only
Return a list of tuples with the values and the assigned time.
namestr
The object’s name.
registrationAny | None
The object this one is registered to (a part, a model, a step, …), or None.
timesread-only
No docstring available.
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