_NodeResidual

class _NodeResidual(dll: SofDll)

Bases: object

This class provides methods and a data structure to:

• access keys 170/LC of the CDB file;

• store the retrieved data in a convenient format;

• provide access to the data after the CDB is closed.

The underlying data structure is a pandas.DataFrame with the following columns:

• LOAD_CASE: load combination number

• ID: node number

• UX: X component of the nodal residual displacement (translation)

• UY: Y component of the nodal residual displacement (translation)

• UZ: Z component of the nodal residual displacement (translation)

• URX: X component of the nodal residual displacement (rotation)

• URY: Y component of the nodal residual displacement (rotation)

• URZ: Z component of the nodal residual displacement (rotation)

• URB: twist residual rotation

• PX: X component of the nodal residual reaction (translation)

• PY: Y component of the nodal residual reaction (translation)

• PZ: Z component of the nodal residual reaction (translation)

• MX: X component of the nodal residual reaction (rotation)

• MY: Y component of the nodal residual reaction (rotation)

• MZ: Z component of the nodal residual reaction (rotation)

• MB: warping residual moment

The DataFrame uses a MultiIndex with levels ID and LOAD_CASE (in this specific order) to enable fast lookups via the get method. The index column is not dropped from the DataFrame.

clear(load_case: int) → None

Clear the loaded data for the given load_case number.

clear_all() → None

Clear the loaded data for all the load cases.

get(node_id: int, load_case: int, quantity: str, default: float | None = None) → float

Retrieve the requested nodal result.

Parameters:

• node_id (int) – Node number

• load_case (int) – Load case number

• quantity (str) –

  Quantity to retrieve. Must be one of:

  • UX

  • UY

  • UZ

  • URX

  • URY

  • URZ

  • URB

  • PX

  • PY

  • PZ

  • MX

  • MY

  • MZ

  • MB

• default (float or None, default None) – Value to return if the requested quantity is not found

Returns:

value – The requested value if found. If not found, returns default when it is not None.

Return type:

float

Raises:

LookupError – If the requested result is not found and default is None.

get_data(deep: bool = True) → DataFrame

Return the pandas.DataFrame containing the loaded keys 26/LC.

Parameters:

deep (bool, default True) – When deep=True, a new object will be created with a copy of the calling object’s data and indices. Modifications to the data or indices of the copy will not be reflected in the original object (refer to pandas.DataFrame.copy() documentation for details).

load(load_cases: int | list[int]) → None

Retrieve nodal results for the given load_cases. If a load case is not found, a warning is raised only if echo_level > 0.

Parameters:

load_cases (int | list[int]) – load case numbers