SEC.Models.SdmComponentCurve#
SEC.Models.SdmComponentCurve.py
- class SdmColumn(params)#
Bases:
objectA class to represent an SDM column.
- params#
The parameters of the SDM column (N, T, me, mp, x0, tI, N0, poresize, timescale)
- Type:
tuple
Initializes the SDM column.
- Parameters:
params (tuple) – The column parameters (N, T, me, mp, x0, tI, N0, poresize, timescale)
- get_params()#
Returns the parameters of the SDM column.
- Returns:
The parameters of the SDM column.
- Return type:
tuple
- class SdmComponentCurve(x, column, rg, scale)#
Bases:
ComponentCurveA class to represent an SDM component curve.
- x#
The x values.
- Type:
array-like
- params#
The parameters of the SDM column (N, T, me, mp, x0, tI, N0, poresize, timescale).
- Type:
tuple
Initializes the SDM component curve.
- Parameters:
x (array-like) – The x values.
column (SdmColumn) – The SDM column object containing the parameters.
rg (float) – The radius of gyration for this component.
scale (float) – The scaling factor.
- get_y(x=None)#
Returns the y values for the given x values.
- Parameters:
x (array-like or None, optional) – The x values to get the y values for. If None, uses the object’s x values.
- Returns:
The y values corresponding to the given x values.
- Return type:
array-like
- get_xy()#
Returns the x and y values as a tuple.
- Returns:
A tuple containing the x values and the corresponding y values.
- Return type:
tuple
- get_peak_top_x()#
Returns the x value at the peak top.
- Raises:
NotImplementedError – Peak top x calculation is not implemented for SDM model.