ospgrillage.postprocessing.create_envelope#

create_envelope(**kwargs)#

Interface for users to create an Envelope object.

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

Parameters:

  • ds (Xarray) – Data set from get_results()

  • kwargs – Keyword arguments see below.

Keyword:

  • array: either ‘displacement’ or ‘forces’

  • value_mode: - True or False

  • query_mode: - True or False

  • extrema: either “min” or “max”

  • elements:

  • nodes

  • array

  • load_effect

Returns:

Envelope Object