Interface IDerivative
Describes a state with a value that can also calculate the derivative with respect to time.
Namespace: SpiceSharp.Simulations
Assembly: SpiceSharp.dll
Syntax
public interface IDerivativeProperties
Derivative
Gets the current derivative.
Declaration
double Derivative { get; }Property Value
| Type | Description |
|---|---|
| double | The derivative. |
Value
Gets or sets the current value.
Declaration
double Value { get; set; }Property Value
| Type | Description |
|---|---|
| double | The value. |
Methods
Derive()
Integrates the state (calculates the derivative from the value).
Declaration
void Derive()GetContributions(double)
Gets the Y-matrix value and Rhs-vector contributions for the derived quantity. The relationship is assumed to be linear.
Declaration
JacobianInfo GetContributions(double coefficient)Parameters
| Type | Name | Description |
|---|---|---|
| double | coefficient | The coefficient of the quantity that is derived. |
Returns
| Type | Description |
|---|---|
| JacobianInfo | The information for filling in the Y-matrix and Rhs-vector. |
GetContributions(double, double)
Gets the Y-matrix value and Rhs-vector contributions for the derived quantity.
Declaration
JacobianInfo GetContributions(double coefficient, double currentValue)Parameters
| Type | Name | Description |
|---|---|---|
| double | coefficient | The coefficient of the quantity that is derived. |
| double | currentValue | The current value of the derived state. |
Returns
| Type | Description |
|---|---|
| JacobianInfo | The information for filling in the Y-matrix and Rhs-vector. |
GetPreviousDerivative(int)
Gets a previous derivative. An index of 0 indicates the current value.
Declaration
double GetPreviousDerivative(int index)Parameters
| Type | Name | Description |
|---|---|---|
| int | index | The number of points to go back in time. |
Returns
| Type | Description |
|---|---|
| double | The previous derivative. |
GetPreviousValue(int)
Gets a previous value. An index of 0 indicates the current value.
Declaration
double GetPreviousValue(int index)Parameters
| Type | Name | Description |
|---|---|---|
| int | index | The index. |
Returns
| Type | Description |
|---|---|
| double | The previous value. |