Parameter

Module for parameter object

class Parameter(values)[source]

Bases: object

Class for representing a parameter in the reduced order model.

This class encapsulates parameter values and provides validation to ensure parameters are 1-dimensional arrays.

Parameters:

values (array_like) – The parameter values as a 1D array.

Example:

>>> import numpy as np
>>> from ezyrb import Parameter
>>> param = Parameter([1.0, 2.5, 3.0])
>>> print(param.values)
[1.  2.5 3. ]
>>> param2 = Parameter(np.array([4.5, 5.5]))
>>> print(param2.values)
[4.5 5.5]

Initialize a Parameter object.

Parameters:: values (array_like) – The parameter values. Can be a Parameter instance or an array-like object that can be converted to a 1D numpy array.

property values: Get the snapshot values.