create_envelope#

create_envelope(**kwargs)#

Create an envelope object for post-processing result envelopes.

The constructor takes an xarray DataSet and kwargs for enveloping options.

Parameters:

  • ds (xarray.Dataset) – Result DataSet from get_results().

  • load_effect (str, optional) – Specific load effect component to envelope.

  • array (str, optional) – Data array to envelope — either "displacements" or "forces".

  • value_mode (bool, optional) – If True, return raw envelope values. Defaults to True.

  • query_mode (bool, optional) – If True, return the load case coordinates at the envelope extrema. Defaults to False.

  • extrema (str, optional) – Envelope direction — either "min" or "max".

  • elements (list, optional) – Specific element tags to include in the envelope.

  • nodes (list, optional) – Specific node tags to include in the envelope.

Returns:

Envelope object.