Skip to content

Fields

Module: xfea.results.fields

AccelerationFieldResults(*args, **kwargs)

Accelerations at the nodes: x, y, z and rotational xx, yy, zz, in the global axes.

One result per node, at the end of the step unless a frame is asked.

Properties
components_namesread-only

The components of a node field: three translational, three rotational, in the global axes.

Returns

Name Type Description
list[str] ["x", "y", "z", "xx", "yy", "zz"].
field_nameread-only

The name of the results database table holding this node field.

framesstrread-only

Which solver frames to extract: "all" (default) or "last", as given to the constructor.

The setting is only stored: the results readers write every frame the solver gives, whatever it says.

keyAny | Noneread-only

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

locationsIterableread-only

The location (node or element) of each result at the end of the step.

Yields

object The location object associated with each result (typically a Node or Element).

modelModelread-only

The Model associated with this field.

namestr

The object’s name.

problemProblemread-only

The Problem owning this field.

rdbResultsDatabaseread-only

The problem’s results database, which the records are read from.

registrationAny | None

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

result_clsread-only

The result class each record is read into (DisplacementResult…).

resultslistread-only

The step’s results at its end (the last frame), one per record; get_results() reads the others.

results_funcread-only

Lookup function name used to resolve nodes from DB keys.

results_sortedlistread-only

The step’s results at its end, sorted by their key.

schemaread-only

The table this field is stored in: its name and its columns, for the results databases.

Returns

Name Type Description
dict {"table_name": str, "columns": list[ColumnSpec]}; each ColumnSpec gives a column’s name and Python type, which each database maps to its own storage type.
stepStepBase | Noneread-only

The analysis step this field is registered to (or None).

uidUUID | Noneread-only

The object’s unique id, a UUID.

vectorsread-only

The translational vector (x, y, z) of each result at the end of the step.

Yields

Vector

vectors_rotationread-only

The rotational vector (xx, yy, zz) of each result at the end of the step.

Yields

Vector

ContactForcesFieldResults(*args, **kwargs)

Contact forces: the total normal and tangential force on each contact pair’s slave surface, global axes.

The solver gives one total per contact pair, not a force per node, so each result is located on the pair’s interface (one of model.interfaces), not on a node: results and get_results() give one ContactForcesResult per contact pair, whose location (and interface) is that interface, at the end of the step unless a frame is asked. get_result_at(interface) reads one pair, and pair_forces() gives them all as plain tuples. The components are the normal force Nx, Ny, Nz (along the pair’s mean normal) and the tangential (friction) force Tx, Ty, Tz, in the global axes; x, y, z are their sum. Per-node contact pressure and slip are ContactStressFieldResults.

Guidance (contact)

  • One total per contact pair, on the slave surface: cf.get_result_at(interface) (.N, .T, .vector), or cf.pair_forces(): {interface: {"normal": (x, y, z), "tangential": (x, y, z)}}. A result’s location is the interface, never a node.
  • Per slave node, ContactStressFieldResults(): cpress (pressure), copen (opening, negative where pressed in), cslip1, cslip2, cshear1, cshear2.
Properties
components_namesread-only

The components of a pair’s force: normal N and tangential T, in the global axes.

Returns

Name Type Description
list[str] ["Nx", "Ny", "Nz", "Tx", "Ty", "Tz"].
field_nameread-only

The name of the results database table holding this node field.

framesstrread-only

Which solver frames to extract: "all" (default) or "last", as given to the constructor.

The setting is only stored: the results readers write every frame the solver gives, whatever it says.

keyAny | Noneread-only

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

locationsIterableread-only

The location (node or element) of each result at the end of the step.

Yields

object The location object associated with each result (typically a Node or Element).

modelModelread-only

The Model associated with this field.

namestr

The object’s name.

problemProblemread-only

The Problem owning this field.

rdbResultsDatabaseread-only

The problem’s results database, which the records are read from.

registrationAny | None

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

result_clsread-only

The result class each record is read into (DisplacementResult…).

resultslistread-only

The step’s results at its end (the last frame), one per record; get_results() reads the others.

results_funcread-only

Lookup function name used to resolve nodes from DB keys.

results_sortedlistread-only

The step’s results at its end, sorted by their key.

schemaread-only

The table this field is stored in: its name and its columns, for the results databases.

Returns

Name Type Description
dict {"table_name": str, "columns": list[ColumnSpec]}; each ColumnSpec gives a column’s name and Python type, which each database maps to its own storage type.
stepStepBase | Noneread-only

The analysis step this field is registered to (or None).

uidUUID | Noneread-only

The object’s unique id, a UUID.

vectorsread-only

The translational vector (x, y, z) of each result at the end of the step.

Yields

Vector

vectors_rotationread-only

The rotational vector (xx, yy, zz) of each result at the end of the step.

Yields

Vector

Methods
pair_forces(frame=None)→dict

The force on each contact pair’s slave surface, at the step’s end or at frame.

The same totals as get_results(), as plain tuples by interface.

Parameters

Name Type Description
frame int, optional The frame number to read, from 1; None for the step’s last frame.

Returns

Name Type Description
dict {interface: {"normal": (x, y, z), "tangential": (x, y, z)}}, by the model’s contact interfaces; normal along the pair’s mean normal, tangential the rest (friction).
ContactStressFieldResults(*args, **kwargs)

Contact stresses at the slave nodes, along the contact’s normal and tangents: pressure, opening, slip, shear.

One result per slave node, at the end of the step unless a frame is asked: cpress (contact pressure), copen (opening along the normal, negative where pressed in), cslip1, cslip2 (slip along the two tangential directions) and cshear1, cshear2 (the shear stresses along them). The names follow the solver’s CONTACT output.

Properties
components_namesread-only

The components of a contact stress result: opening, slips, pressure and shears.

Returns

Name Type Description
list[str] ["copen", "cslip1", "cslip2", "cpress", "cshear1", "cshear2"].
field_nameread-only

The name of the results database table holding this node field.

framesstrread-only

Which solver frames to extract: "all" (default) or "last", as given to the constructor.

The setting is only stored: the results readers write every frame the solver gives, whatever it says.

keyAny | Noneread-only

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

locationsIterableread-only

The location (node or element) of each result at the end of the step.

Yields

object The location object associated with each result (typically a Node or Element).

modelModelread-only

The Model associated with this field.

namestr

The object’s name.

problemProblemread-only

The Problem owning this field.

rdbResultsDatabaseread-only

The problem’s results database, which the records are read from.

registrationAny | None

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

result_clsread-only

The result class each record is read into (DisplacementResult…).

resultslistread-only

The step’s results at its end (the last frame), one per record; get_results() reads the others.

results_funcread-only

Lookup function name used to resolve nodes from DB keys.

results_sortedlistread-only

The step’s results at its end, sorted by their key.

schemaread-only

The table this field is stored in: its name and its columns, for the results databases.

Returns

Name Type Description
dict {"table_name": str, "columns": list[ColumnSpec]}; each ColumnSpec gives a column’s name and Python type, which each database maps to its own storage type.
stepStepBase | Noneread-only

The analysis step this field is registered to (or None).

uidUUID | Noneread-only

The object’s unique id, a UUID.

vectorsread-only

The translational vector (x, y, z) of each result at the end of the step.

Yields

Vector

vectors_rotationread-only

The rotational vector (xx, yy, zz) of each result at the end of the step.

Yields

Vector

DisplacementFieldResults(*args, **kwargs)

Displacements at the nodes, in the global axes: x, y, z, and rotations xx, yy, zz (rad).

One result per node, in the model’s length unit, at the end of the step unless a frame is asked. Rotations are those of beam and shell nodes; the nodes of solid elements have none.

Guidance (results)

  • get_result_at(node), get_max_result("z") and get_min_result("z") return a result: read .x, .y, .z (and .xx… for rotations). All at the end of the step unless a frame is asked.
Properties
components_namesread-only

The components of a node field: three translational, three rotational, in the global axes.

Returns

Name Type Description
list[str] ["x", "y", "z", "xx", "yy", "zz"].
field_nameread-only

The name of the results database table holding this node field.

framesstrread-only

Which solver frames to extract: "all" (default) or "last", as given to the constructor.

The setting is only stored: the results readers write every frame the solver gives, whatever it says.

keyAny | Noneread-only

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

locationsIterableread-only

The location (node or element) of each result at the end of the step.

Yields

object The location object associated with each result (typically a Node or Element).

modelModelread-only

The Model associated with this field.

namestr

The object’s name.

problemProblemread-only

The Problem owning this field.

rdbResultsDatabaseread-only

The problem’s results database, which the records are read from.

registrationAny | None

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

result_clsread-only

The result class each record is read into (DisplacementResult…).

resultslistread-only

The step’s results at its end (the last frame), one per record; get_results() reads the others.

results_funcread-only

Lookup function name used to resolve nodes from DB keys.

results_sortedlistread-only

The step’s results at its end, sorted by their key.

schemaread-only

The table this field is stored in: its name and its columns, for the results databases.

Returns

Name Type Description
dict {"table_name": str, "columns": list[ColumnSpec]}; each ColumnSpec gives a column’s name and Python type, which each database maps to its own storage type.
stepStepBase | Noneread-only

The analysis step this field is registered to (or None).

uidUUID | Noneread-only

The object’s unique id, a UUID.

vectorsread-only

The translational vector (x, y, z) of each result at the end of the step.

Yields

Vector

vectors_rotationread-only

The rotational vector (xx, yy, zz) of each result at the end of the step.

Yields

Vector

ElementFieldResults(*args, **kwargs)

Results with records per element, found by its key (find_element_by_key).

An element may have several records, one per integration point (ip).

Abstract base class; do not instantiate directly.

Properties
components_namesread-only

The names of the components stored for each result record (["x", "y", ...]).

Subclasses must implement this.

Returns

Name Type Description
list[str]
field_namestrread-only

The name of the results database table holding this field ("u" for displacements).

Subclasses must implement this.

Returns

Name Type Description
str
framesstrread-only

Which solver frames to extract: "all" (default) or "last", as given to the constructor.

The setting is only stored: the results readers write every frame the solver gives, whatever it says.

keyAny | Noneread-only

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

locationsIterableread-only

The location (node or element) of each result at the end of the step.

Yields

object The location object associated with each result (typically a Node or Element).

modelModelread-only

The Model associated with this field.

namestr

The object’s name.

problemProblemread-only

The Problem owning this field.

rdbResultsDatabaseread-only

The problem’s results database, which the records are read from.

registrationAny | None

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

result_clsread-only

The result class each record is read into (DisplacementResult…).

resultslistread-only

The step’s results at its end (the last frame), one per record; get_results() reads the others.

results_funcstrread-only

The name of the model’s lookup method that finds a record’s location from its key.

"find_node_by_key" for node fields, "find_element_by_key" for element fields: reading a record calls it on the part (or the model).

Subclasses must implement this.

Returns

Name Type Description
str
results_sortedlistread-only

The step’s results at its end, sorted by their key.

schemaread-only

The table this field is stored in: its name and its columns, for the results databases.

Returns

Name Type Description
dict {"table_name": str, "columns": list[ColumnSpec]}; each ColumnSpec gives a column’s name and Python type, which each database maps to its own storage type.
stepStepBase | Noneread-only

The analysis step this field is registered to (or None).

uidUUID | Noneread-only

The object’s unique id, a UUID.

ErrorFieldResults(*args, **kwargs)

The solver’s error estimate at the nodes: one value error per node, at the end of the step unless asked.

Properties
components_namesread-only

The one component of an error result: ["error"].

field_nameread-only

The name of the results database table holding this node field.

framesstrread-only

Which solver frames to extract: "all" (default) or "last", as given to the constructor.

The setting is only stored: the results readers write every frame the solver gives, whatever it says.

keyAny | Noneread-only

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

locationsIterableread-only

The location (node or element) of each result at the end of the step.

Yields

object The location object associated with each result (typically a Node or Element).

modelModelread-only

The Model associated with this field.

namestr

The object’s name.

problemProblemread-only

The Problem owning this field.

rdbResultsDatabaseread-only

The problem’s results database, which the records are read from.

registrationAny | None

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

result_clsread-only

The result class each record is read into (DisplacementResult…).

resultslistread-only

The step’s results at its end (the last frame), one per record; get_results() reads the others.

results_funcread-only

Lookup function name used to resolve nodes from DB keys.

results_sortedlistread-only

The step’s results at its end, sorted by their key.

schemaread-only

The table this field is stored in: its name and its columns, for the results databases.

Returns

Name Type Description
dict {"table_name": str, "columns": list[ColumnSpec]}; each ColumnSpec gives a column’s name and Python type, which each database maps to its own storage type.
stepStepBase | Noneread-only

The analysis step this field is registered to (or None).

uidUUID | Noneread-only

The object’s unique id, a UUID.

vectorsread-only

The translational vector (x, y, z) of each result at the end of the step.

Yields

Vector

vectors_rotationread-only

The rotational vector (xx, yy, zz) of each result at the end of the step.

Yields

Vector

FieldResultsBase(*args, frames: str = 'all', **kwargs)

One kind of result (displacements, stresses…) asked of a step, and read back after the run.

Add it to a step with step.add_field_outputs([...]); once the problem is solved, the same object reads its records (one per node, or per element integration point) from the problem’s results database. Reads are at the end of the step (its last frame) unless a frame is asked.

Parameters

Name Type Description
frames {“all”, “last”}, optional Which frames to extract (default "all"); see frames.
Properties
components_namesread-only

The names of the components stored for each result record (["x", "y", ...]).

Subclasses must implement this.

Returns

Name Type Description
list[str]
field_namestrread-only

The name of the results database table holding this field ("u" for displacements).

Subclasses must implement this.

Returns

Name Type Description
str
framesstrread-only

Which solver frames to extract: "all" (default) or "last", as given to the constructor.

The setting is only stored: the results readers write every frame the solver gives, whatever it says.

keyAny | Noneread-only

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

locationsIterableread-only

The location (node or element) of each result at the end of the step.

Yields

object The location object associated with each result (typically a Node or Element).

modelModelread-only

The Model associated with this field.

namestr

The object’s name.

problemProblemread-only

The Problem owning this field.

rdbResultsDatabaseread-only

The problem’s results database, which the records are read from.

registrationAny | None

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

result_clsread-only

The result class each record is read into (DisplacementResult…).

resultslistread-only

The step’s results at its end (the last frame), one per record; get_results() reads the others.

results_funcstrread-only

The name of the model’s lookup method that finds a record’s location from its key.

"find_node_by_key" for node fields, "find_element_by_key" for element fields: reading a record calls it on the part (or the model).

Subclasses must implement this.

Returns

Name Type Description
str
results_sortedlistread-only

The step’s results at its end, sorted by their key.

schemaread-only

The table this field is stored in: its name and its columns, for the results databases.

Returns

Name Type Description
dict {"table_name": str, "columns": list[ColumnSpec]}; each ColumnSpec gives a column’s name and Python type, which each database maps to its own storage type.
stepStepBase | Noneread-only

The analysis step this field is registered to (or None).

uidUUID | Noneread-only

The object’s unique id, a UUID.

Methods
component_scalar(component)

The value of one component (or invariant) of each result, at the end of the step.

Parameters

Name Type Description
component str A component or invariant name ("z", "von_mises_stress"…).

Yields

float | None The value for each result; None where the result has no such attribute.

filter_by_component(component, threshold=None)

The results, at the end of the step, whose component is at least a threshold.

Parameters

Name Type Description
component str Component name to filter by.
threshold float, optional If provided, only results with component >= threshold are yielded.

Yields

object Instances of result_cls matching the filter.

frames_in_step()→list

The frames (increments) the step’s results hold, in order: one per increment of a nonlinear step.

Returns

Name Type Description
list[int] The frame numbers, from 1; empty if nothing was written.
get_limits_component(component, time=None, increment=None, frame=None)

The results with the smallest and the largest value of a stored component, at the end of the step.

Parameters

Name Type Description
component str A stored component, one of components_names.
time, increment, frame optional The time, increment or frame to read, as in get_max_result().

Returns

Name Type Description
list [min_result, max_result].
get_max_result(component, time=None, increment=None, frame=None)

The result with the largest (most positive) value of a stored component, at the end of the step.

Parameters

Name Type Description
component str A stored component, one of components_names ("z", "s11"…).
time float, optional The step time to read, as stored by the reader.
increment int, optional The same as frame; used when frame is not given.
frame int, optional The frame number to read, from 1.

Returns

Name Type Description
object The result_cls holding the maximum.

Guidance (results)

  • get_max_result and get_min_result compare signed values of a stored component: a downward deflection is get_min_result("z"). Not for magnitude or von_mises_stress (not stored: an arbitrary result comes back); use max(r.von_mises_stress for r in stress.results).
get_min_result(component, time=None, increment=None, frame=None)

The result with the smallest (most negative) value of a stored component, at the end of the step.

Parameters

Name Type Description
component str A stored component, one of components_names ("z", "s11"…).
time float, optional The step time to read, as stored by the reader.
increment int, optional The same as frame; used when frame is not given.
frame int, optional The frame number to read, from 1.

Returns

Name Type Description
object The result_cls holding the minimum.
get_result_at(location, time=None, increment=None, frame=None)

The result at one node or element: at the end of the step, unless time, increment or frame says.

Parameters

Name Type Description
location Node or element A node for a node field, an element for an element field.
time float, optional The step time to read, as stored by the reader.
increment int, optional The same as frame; used when frame is not given.
frame int, optional The frame number to read, from 1.

Returns

Name Type Description
object The location’s result_cls; for an element field, its first integration point’s.
get_results(time=None, increment=None, frame=None)→list

The step’s results at its end (the last frame), or at the given time, increment or frame.

Parameters

Name Type Description
time float or list[float], optional The step time(s) to read, as stored by the reader.
increment int or list[int], optional The same as frame; used when frame is not given.
frame int or list[int], optional The frame number(s) to read, from 1; frames_in_step() for the whole history.

Returns

Name Type Description
list One result_cls per record (and per frame when several are asked).
ModalShape(step, results=None, mode=None, *args, **kwargs)

A mode shape of a modal or buckling step, read like a displacement field.

Each record is a DisplacementResult at a node: the eigenvector’s x, y, z, xx, yy, zz there, in the global axes, scaled as the solver normalised it (not a displacement in length units).

Parameters

Name Type Description
step StepBase The step the modal results belong to.
results list, optional Results already read; if given, the database is not queried.
mode int, optional The mode number to read from the database; None reads every mode’s rows.
Properties
components_namesread-only

The components of a node field: three translational, three rotational, in the global axes.

Returns

Name Type Description
list[str] ["x", "y", "z", "xx", "yy", "zz"].
field_nameread-only

The name of the results database table holding this node field.

framesstrread-only

Which solver frames to extract: "all" (default) or "last", as given to the constructor.

The setting is only stored: the results readers write every frame the solver gives, whatever it says.

keyAny | Noneread-only

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

locationsIterableread-only

The location (node or element) of each result at the end of the step.

Yields

object The location object associated with each result (typically a Node or Element).

moderead-only

Mode number for this modal shape (or None).

modelModelread-only

The Model associated with this field.

namestr

The object’s name.

problemProblemread-only

The Problem owning this field.

rdbResultsDatabaseread-only

The problem’s results database, which the records are read from.

registrationAny | None

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

result_clsread-only

The result class each record is read into (DisplacementResult…).

resultsread-only

The mode shape’s results, one per node: those given, or read from the database.

results_funcread-only

Lookup function name used to resolve nodes from DB keys.

results_sortedlistread-only

The step’s results at its end, sorted by their key.

schemaread-only

The table this field is stored in: its name and its columns, for the results databases.

Returns

Name Type Description
dict {"table_name": str, "columns": list[ColumnSpec]}; each ColumnSpec gives a column’s name and Python type, which each database maps to its own storage type.
stepStepBase | Noneread-only

The analysis step this field is registered to (or None).

uidUUID | Noneread-only

The object’s unique id, a UUID.

vectorsread-only

The translational vector (x, y, z) of each result at the end of the step.

Yields

Vector

vectors_rotationread-only

The rotational vector (xx, yy, zz) of each result at the end of the step.

Yields

Vector

NodeFieldResults(*args, **kwargs)

Results with one record per node, found by its key (find_node_by_key).

Unless a subclass says otherwise, the components are x, y, z (translational) and xx, yy, zz (rotational), in the global axes.

Properties
components_namesread-only

The components of a node field: three translational, three rotational, in the global axes.

Returns

Name Type Description
list[str] ["x", "y", "z", "xx", "yy", "zz"].
field_nameread-only

The name of the results database table holding this node field.

framesstrread-only

Which solver frames to extract: "all" (default) or "last", as given to the constructor.

The setting is only stored: the results readers write every frame the solver gives, whatever it says.

keyAny | Noneread-only

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

locationsIterableread-only

The location (node or element) of each result at the end of the step.

Yields

object The location object associated with each result (typically a Node or Element).

modelModelread-only

The Model associated with this field.

namestr

The object’s name.

problemProblemread-only

The Problem owning this field.

rdbResultsDatabaseread-only

The problem’s results database, which the records are read from.

registrationAny | None

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

result_clsread-only

The result class each record is read into (DisplacementResult…).

resultslistread-only

The step’s results at its end (the last frame), one per record; get_results() reads the others.

results_funcread-only

Lookup function name used to resolve nodes from DB keys.

results_sortedlistread-only

The step’s results at its end, sorted by their key.

schemaread-only

The table this field is stored in: its name and its columns, for the results databases.

Returns

Name Type Description
dict {"table_name": str, "columns": list[ColumnSpec]}; each ColumnSpec gives a column’s name and Python type, which each database maps to its own storage type.
stepStepBase | Noneread-only

The analysis step this field is registered to (or None).

uidUUID | Noneread-only

The object’s unique id, a UUID.

vectorsread-only

The translational vector (x, y, z) of each result at the end of the step.

Yields

Vector

vectors_rotationread-only

The rotational vector (xx, yy, zz) of each result at the end of the step.

Yields

Vector

Methods
components_vectors(components)

The translational vectors with the components not listed set to zero.

Parameters

Name Type Description
components list[str] | set[str] | tuple[str, …] Subset of {"x", "y", "z"} to keep.

Yields

Vector

components_vectors_rotation(components)

The rotational vectors with the components not listed set to zero.

Parameters

Name Type Description
components list[str] | set[str] | tuple[str, …] Subset of {"x", "y", "z"} to keep.

Yields

Vector

compute_resultant(sub_set=None)

The resultant of the nodes’ translational vectors (reactions, say), its moment and its point.

The resultant is the sum of the vectors; its point is the nodes’ centroid weighted by the vectors’ lengths; the moment is that of the vectors about that point. Rotational components are not included.

Parameters

Name Type Description
sub_set list[Node], optional The nodes to include; None for all the results at the end of the step.

Returns

Name Type Description
tuple (resultant_vector, moment_vector, resultant_location) where * resultant_vector : Vector * moment_vector : Vector * resultant_location : Point
ReactionFieldResults(*args, **kwargs)

Reactions at the nodes the supports hold, in the global axes: forces x, y, z, moments xx, yy, zz.

One result per supported node: the force (and moment) the support gives the structure, without the loads applied at that node. At the end of the step unless a frame is asked.

Properties
components_namesread-only

The components of a node field: three translational, three rotational, in the global axes.

Returns

Name Type Description
list[str] ["x", "y", "z", "xx", "yy", "zz"].
field_nameread-only

The name of the results database table holding this node field.

framesstrread-only

Which solver frames to extract: "all" (default) or "last", as given to the constructor.

The setting is only stored: the results readers write every frame the solver gives, whatever it says.

keyAny | Noneread-only

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

locationsIterableread-only

The location (node or element) of each result at the end of the step.

Yields

object The location object associated with each result (typically a Node or Element).

modelModelread-only

The Model associated with this field.

namestr

The object’s name.

problemProblemread-only

The Problem owning this field.

rdbResultsDatabaseread-only

The problem’s results database, which the records are read from.

registrationAny | None

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

result_clsread-only

The result class each record is read into (DisplacementResult…).

resultslistread-only

The step’s results at its end (the last frame), one per record; get_results() reads the others.

results_funcread-only

Lookup function name used to resolve nodes from DB keys.

results_sortedlistread-only

The step’s results at its end, sorted by their key.

schemaread-only

The table this field is stored in: its name and its columns, for the results databases.

Returns

Name Type Description
dict {"table_name": str, "columns": list[ColumnSpec]}; each ColumnSpec gives a column’s name and Python type, which each database maps to its own storage type.
stepStepBase | Noneread-only

The analysis step this field is registered to (or None).

uidUUID | Noneread-only

The object’s unique id, a UUID.

vectorsread-only

The translational vector (x, y, z) of each result at the end of the step.

Yields

Vector

vectors_rotationread-only

The rotational vector (xx, yy, zz) of each result at the end of the step.

Yields

Vector

SectionForcesFieldResults(*args, **kwargs)

Beam section forces and moments at both ends of each beam element, in the element’s local axes.

One SectionForcesResult per element, at the end of the step unless a frame is asked: Fx_1… Mz_1 at its first node, Fx_2… Mz_2 at its last. Local x runs from the first node to the last, y is the beam’s orientation, z = x × y. Fx is the axial force (positive in tension), Fy, Fz the shears, Mx the torsion, My, Mz the bending moments. Both ends use the same convention, the forces on the cross-section as on a moment diagram.

Properties
components_namesread-only

The twelve components: Fx_1, Fy_1, Fz_1, Mx_1, My_1, Mz_1 and the same at end 2.

field_nameread-only

The name of the results database table for section forces ("sf").

framesstrread-only

Which solver frames to extract: "all" (default) or "last", as given to the constructor.

The setting is only stored: the results readers write every frame the solver gives, whatever it says.

keyAny | Noneread-only

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

locationsIterableread-only

The location (node or element) of each result at the end of the step.

Yields

object The location object associated with each result (typically a Node or Element).

modelModelread-only

The Model associated with this field.

namestr

The object’s name.

problemProblemread-only

The Problem owning this field.

rdbResultsDatabaseread-only

The problem’s results database, which the records are read from.

registrationAny | None

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

result_clsread-only

The result class for section forces, SectionForcesResult.

resultslistread-only

The step’s results at its end (the last frame), one per record; get_results() reads the others.

results_funcread-only

Lookup function name used to resolve elements from DB keys.

results_sortedlistread-only

The step’s results at its end, sorted by their key.

schemaread-only

The table this field is stored in: its name and its columns, for the results databases.

Returns

Name Type Description
dict {"table_name": str, "columns": list[ColumnSpec]}; each ColumnSpec gives a column’s name and Python type, which each database maps to its own storage type.
stepStepBase | Noneread-only

The analysis step this field is registered to (or None).

uidUUID | Noneread-only

The object’s unique id, a UUID.

Methods
export_to_csv(file_path)

Write the rows of export_to_dict() (every frame’s) to a CSV file.

Parameters

Name Type Description
file_path str | pathlib.Path The CSV file to write; nothing is written (a warning is logged) when there are no rows.
export_to_dict()

The step’s section forces as plain rows, every frame’s.

Returns

Name Type Description
list[dict] One dict per stored row: step, part, key (the element) and the twelve components; empty if nothing was written.
get_element_forces(element)

The section forces of one beam element at the end of the step (get_result_at()).

Parameters

Name Type Description
element BeamElement The element to read.

Returns

Name Type Description
class:xfea.results.results.SectionForcesResult
get_elements_forces(elements)

The section forces of several beam elements at the end of the step, one after the other.

Parameters

Name Type Description
elements list[BeamElement] The elements to read.

Yields

SectionForcesResult

StrainFieldResults(*args, **kwargs)

Strains at each element’s integration points: e11, e22, e33, e12, e13, e23, global axes.

One StrainResult per integration point (ip), at the end of the step unless a frame is asked; 1, 2, 3 are the global x, y, z.

Properties
components_namesread-only

The six stored strain components, in the global axes (1, 2, 3 for x, y, z).

field_nameread-only

The name of the results database table for strains ("strain").

framesstrread-only

Which solver frames to extract: "all" (default) or "last", as given to the constructor.

The setting is only stored: the results readers write every frame the solver gives, whatever it says.

invariants_namesread-only

The stress invariants’ names, as for stresses: strain results do not compute them.

Returns

Name Type Description
list[str] ["von_mises_stress", "principal_stress_min", "principal_stress_mid", "principal_stress_max"].
keyAny | Noneread-only

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

locationsIterableread-only

The location (node or element) of each result at the end of the step.

Yields

object The location object associated with each result (typically a Node or Element).

modelModelread-only

The Model associated with this field.

namestr

The object’s name.

problemProblemread-only

The Problem owning this field.

rdbResultsDatabaseread-only

The problem’s results database, which the records are read from.

registrationAny | None

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

result_clsread-only

The result class each record is read into (DisplacementResult…).

resultslistread-only

The step’s results at its end (the last frame), one per record; get_results() reads the others.

results_funcread-only

Lookup function name used to resolve elements from DB keys.

results_sortedlistread-only

The step’s results at its end, sorted by their key.

schemaread-only

The table this field is stored in: its name and its columns, for the results databases.

Returns

Name Type Description
dict {"table_name": str, "columns": list[ColumnSpec]}; each ColumnSpec gives a column’s name and Python type, which each database maps to its own storage type.
stepStepBase | Noneread-only

The analysis step this field is registered to (or None).

uidUUID | Noneread-only

The object’s unique id, a UUID.

Methods
average_stress_at_nodes(nodes, component='von_mises_stress')

Not implemented: raises NotImplementedError. For nodal stresses, StressFieldResults.results_at_nodes.

Parameters

Name Type Description
nodes list Nodes where averaged values should be computed.
component str, optional Stress component/invariant to average.
get_component_value(component, **kwargs)

The value of one strain component for each result at the end of the step.

Parameters

Name Type Description
component str One of components_names.
**kwargs Unused; kept for API compatibility.

Yields

float | None

get_invariant_value(invariant, **kwargs)

The value of one invariant for each result at the end of the step (None: strain results have none).

Parameters

Name Type Description
invariant str One of invariants_names.
**kwargs Unused; kept for API compatibility.

Yields

float | None

global_stresses(plane='mid')

The stored strain components of each result at the end of the step (despite the name, strains).

Parameters

Name Type Description
plane str, optional Unused.

Returns

Name Type Description
list[dict] One dict per result: "element" and the six components, as stored (global axes).
StressFieldResults(*args, **kwargs)

Stresses at each integration point of each element, in the global axes: s11… s23 (1, 2, 3 for x, y, z). Each result also gives von_mises_stress and the principal stresses.

One StressResult per integration point (ip), at the end of the step unless a frame is asked: s11, s22, s33, s12, s13, s23. get_results(location=...) gives one result per element ("centroid") or per node ("nodal"), averaged.

Guidance (results)

  • A large gap between the mean and the peak stress is a concentration or a singularity: stress at a sharp corner depends on the mesh; refine twice and compare.
  • Von Mises is for ductile metals; principal stresses for brittle materials.
Properties
components_namesread-only

The six stored stress components, in the global axes (1, 2, 3 for x, y, z).

Returns

Name Type Description
list[str] ["s11", "s22", "s33", "s12", "s13", "s23"].
field_nameread-only

The name of the results database table for stresses ("s").

framesstrread-only

Which solver frames to extract: "all" (default) or "last", as given to the constructor.

The setting is only stored: the results readers write every frame the solver gives, whatever it says.

grouped_resultsread-only

The results at the end of the step, grouped by their element’s dimension (1, 2 or 3).

Returns

Name Type Description
dict[int, list] Mapping from element.ndim to a list of results.
invariants_namesread-only

The invariants each stress result computes from its tensor (not stored in the database).

Returns

Name Type Description
list[str] ["von_mises_stress", "principal_stress_min", "principal_stress_mid", "principal_stress_max"].
keyAny | Noneread-only

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

locationsIterableread-only

The location (node or element) of each result at the end of the step.

Yields

object The location object associated with each result (typically a Node or Element).

modelModelread-only

The Model associated with this field.

namestr

The object’s name.

problemProblemread-only

The Problem owning this field.

rdbResultsDatabaseread-only

The problem’s results database, which the records are read from.

registrationAny | None

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

result_clsread-only

The result class each record is read into (DisplacementResult…).

resultslistread-only

The step’s results at its end (the last frame), one per record; get_results() reads the others.

results_at_centroidslistread-only

One result per element, the mean over its integration points, at the end of the step: get_results(location="centroid").

results_at_nodeslistread-only

One result per node, averaged from the elements around it, at the end of the step: get_results(location="nodal").

results_funcread-only

Lookup function name used to resolve elements from DB keys.

results_sortedlistread-only

The step’s results at its end, sorted by their key.

schemaread-only

The table this field is stored in: its name and its columns, for the results databases.

Returns

Name Type Description
dict {"table_name": str, "columns": list[ColumnSpec]}; each ColumnSpec gives a column’s name and Python type, which each database maps to its own storage type.
stepStepBase | Noneread-only

The analysis step this field is registered to (or None).

uidUUID | Noneread-only

The object’s unique id, a UUID.

Methods
get_results(time=None, increment=None, frame=None, location='ip')→list

The stresses at the integration points, element centres or nodes, at the end of the step unless asked.

Averages are of the stress components; the invariants (von Mises, principal) are then computed from the averaged tensor.

Parameters

Name Type Description
time, increment, frame optional The time, increment or frame to read, as in get_results().
location {“ip”, “centroid”, “nodal”}, optional "ip" (default): one result per integration point, as stored; "centroid": one per element, the mean over its integration points (ip=0); "nodal": one per node, the mean of the centroid values of the elements around it.

Returns

Name Type Description
list[ class:~xfea.results.results.StressResult]
TemperatureFieldResults(*args, **kwargs)

Temperatures at the nodes: one value T per node, in the model’s temperature unit.

Properties
components_namesread-only

The one component of a temperature result.

Returns

Name Type Description
list[str] ["T"].
field_nameread-only

The name of the results database table holding this node field.

framesstrread-only

Which solver frames to extract: "all" (default) or "last", as given to the constructor.

The setting is only stored: the results readers write every frame the solver gives, whatever it says.

keyAny | Noneread-only

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

locationsIterableread-only

The location (node or element) of each result at the end of the step.

Yields

object The location object associated with each result (typically a Node or Element).

modelModelread-only

The Model associated with this field.

namestr

The object’s name.

problemProblemread-only

The Problem owning this field.

rdbResultsDatabaseread-only

The problem’s results database, which the records are read from.

registrationAny | None

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

result_clsread-only

The result class each record is read into (DisplacementResult…).

resultslistread-only

The step’s results at its end (the last frame), one per record; get_results() reads the others.

results_funcread-only

Lookup function name used to resolve nodes from DB keys.

results_sortedlistread-only

The step’s results at its end, sorted by their key.

schemaread-only

The table this field is stored in: its name and its columns, for the results databases.

Returns

Name Type Description
dict {"table_name": str, "columns": list[ColumnSpec]}; each ColumnSpec gives a column’s name and Python type, which each database maps to its own storage type.
stepStepBase | Noneread-only

The analysis step this field is registered to (or None).

uidUUID | Noneread-only

The object’s unique id, a UUID.

vectorsread-only

The translational vector (x, y, z) of each result at the end of the step.

Yields

Vector

vectors_rotationread-only

The rotational vector (xx, yy, zz) of each result at the end of the step.

Yields

Vector

VelocityFieldResults(*args, **kwargs)

Velocities at the nodes: x, y, z and rotational xx, yy, zz, in the global axes.

One result per node, at the end of the step unless a frame is asked.

Properties
components_namesread-only

The components of a node field: three translational, three rotational, in the global axes.

Returns

Name Type Description
list[str] ["x", "y", "z", "xx", "yy", "zz"].
field_nameread-only

The name of the results database table holding this node field.

framesstrread-only

Which solver frames to extract: "all" (default) or "last", as given to the constructor.

The setting is only stored: the results readers write every frame the solver gives, whatever it says.

keyAny | Noneread-only

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

locationsIterableread-only

The location (node or element) of each result at the end of the step.

Yields

object The location object associated with each result (typically a Node or Element).

modelModelread-only

The Model associated with this field.

namestr

The object’s name.

problemProblemread-only

The Problem owning this field.

rdbResultsDatabaseread-only

The problem’s results database, which the records are read from.

registrationAny | None

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

result_clsread-only

The result class each record is read into (DisplacementResult…).

resultslistread-only

The step’s results at its end (the last frame), one per record; get_results() reads the others.

results_funcread-only

Lookup function name used to resolve nodes from DB keys.

results_sortedlistread-only

The step’s results at its end, sorted by their key.

schemaread-only

The table this field is stored in: its name and its columns, for the results databases.

Returns

Name Type Description
dict {"table_name": str, "columns": list[ColumnSpec]}; each ColumnSpec gives a column’s name and Python type, which each database maps to its own storage type.
stepStepBase | Noneread-only

The analysis step this field is registered to (or None).

uidUUID | Noneread-only

The object’s unique id, a UUID.

vectorsread-only

The translational vector (x, y, z) of each result at the end of the step.

Yields

Vector

vectors_rotationread-only

The rotational vector (xx, yy, zz) of each result at the end of the step.

Yields

Vector

Module: xfea.results.perturbations

The modes of a modal or buckling step, read from the results database.

PerturbationSummaryBase(step, **kwargs)

The modes of one perturbation step (modal or buckling), read from the problem’s results database.

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.

namestr

The object’s name.

problemread-only

The problem of the step.

rdbread-only

The problem’s results database.

registrationAny | None

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

stepread-only

The step the summary reads.

uidUUID | Noneread-only

The object’s unique id, a UUID.

BucklingSummary(step, modes=None, **kwargs)

The modes of a buckling step: the load factor and shape of each.

Parameters

Name Type Description
step BucklingAnalysis The buckling step to read.
modes int or list[int], optional The modes to read: n for modes 1 to n, or their numbers; None for every mode stored.
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.

problemread-only

The problem of the step.

rdbread-only

The problem’s results database.

registrationAny | None

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

resultsread-only

One result per mode asked (modes), in order.

stepread-only

The step the summary reads.

uidUUID | Noneread-only

The object’s unique id, a UUID.

Methods
available_modes()

The mode numbers the step’s buckling factors are stored for, in order (empty without results).

mode_result(mode)

One mode as a BucklingResult (read once, then kept).

Parameters

Name Type Description
mode int The mode number, from 1.
ModalSummary(step, modes=None, **kwargs)

The modes of a modal step: eigenvalue, frequency, shape and modal masses of each.

Parameters

Name Type Description
step ModalAnalysis The modal step to read.
modes int or list[int], optional The modes to read: n for modes 1 to n, or their numbers; None for every mode stored.
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.

problemread-only

The problem of the step.

rdbread-only

The problem’s results database.

registrationAny | None

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

resultsread-only

One result per mode asked (modes), in order.

stepread-only

The step the summary reads.

uidUUID | Noneread-only

The object’s unique id, a UUID.

Methods
available_modes()

The mode numbers the step’s eigenvalues are stored for, in order (empty without results).

mode_result(mode)

One mode as a ModalResult (read once, then kept).

Parameters

Name Type Description
mode int The mode number, from 1.

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