Show / Hide Table of Contents

Class FixedTrapezoidal.Instance.IntegralInstance

An IIntegral for FixedTrapezoidal.

Inheritance
object
FixedTrapezoidal.Instance.IntegralInstance
Implements
IIntegral
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: SpiceSharp.Simulations.IntegrationMethods
Assembly: SpiceSharp.dll
Syntax
protected class FixedTrapezoidal.Instance.IntegralInstance : IIntegral

Constructors

IntegralInstance(Instance, int)

Creates a new FixedTrapezoidal.Instance.IntegralInstance.

Declaration
public IntegralInstance(FixedTrapezoidal.Instance method, int index)
Parameters
Type Name Description
FixedTrapezoidal.Instance method

The integration method.

int index

The index in the vector.

Properties

Derivative

Gets or sets the current derivative.

Declaration
public double Derivative { get; set; }
Property Value
Type Description
double

The derivative.

Value

Gets the current value.

Declaration
public double Value { get; }
Property Value
Type Description
double

The value.

Methods

GetContributions(double)

Gets the Y-matrix value and Rhs-vector contributions for the derived quantity. The relationship is assumed to be linear.

Declaration
public JacobianInfo GetContributions(double coefficient)
Parameters
Type Name Description
double coefficient

The coefficient of the quantity that is integrated.

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 integrated quantity.

Declaration
public JacobianInfo GetContributions(double coefficient, double currentValue)
Parameters
Type Name Description
double coefficient

The coefficient of the quantity that is integrated.

double currentValue

The current value of the integrated state.

Returns
Type Description
JacobianInfo

The information for fijlling in the Y-matrix and Rhs-vector.

GetPreviousDerivative(int)

Gets a previous derivative. An index of 0 indicates the current derivative.

Declaration
public 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 value.

GetPreviousValue(int)

Gets a previous value. An index of 0 indicates the current value.

Declaration
public double GetPreviousValue(int index)
Parameters
Type Name Description
int index

The number of points to go back in time.

Returns
Type Description
double

The previous value.

Integrate()

Integrates the state (calculates the value from the derivative).

Declaration
public void Integrate()

Implements

IIntegral

Extension Methods

Utility.ThrowIfNull<T>(T, string)

See Also

IIntegral
In this article
Back to top Generated by DocFX