Show / Hide Table of Contents

Class Gear.Instance

An IIntegrationMethod that implements the Gear integration method.

Inheritance
object
SpiceMethod.SpiceInstance
Gear.Instance
Implements
IBreakpointMethod
IIntegrationMethod
ISimulationState
Inherited Members
SpiceMethod.SpiceInstance.Delta
SpiceMethod.SpiceInstance.State
SpiceMethod.SpiceInstance.States
SpiceMethod.SpiceInstance.RegisteredStates
SpiceMethod.SpiceInstance.TruncatableStates
SpiceMethod.SpiceInstance.Breakpoints
SpiceMethod.SpiceInstance.Break
SpiceMethod.SpiceInstance.MaxOrder
SpiceMethod.SpiceInstance.Order
SpiceMethod.SpiceInstance.BaseTime
SpiceMethod.SpiceInstance.Time
SpiceMethod.SpiceInstance.Slope
SpiceMethod.SpiceInstance.Prediction
SpiceMethod.SpiceInstance.Parameters
SpiceMethod.SpiceInstance.GetPreviousSolution(int)
SpiceMethod.SpiceInstance.GetPreviousTimestep(int)
SpiceMethod.SpiceInstance.RegisterState(IIntegrationState)
SpiceMethod.SpiceInstance.Prepare()
SpiceMethod.SpiceInstance.Probe()
SpiceMethod.SpiceInstance.Accept()
SpiceMethod.SpiceInstance.Reject()
SpiceMethod.SpiceInstance.Evaluate(double)
SpiceMethod.SpiceInstance.Truncate(double)
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 Gear.Instance : SpiceMethod.SpiceInstance, IBreakpointMethod, IIntegrationMethod, ISimulationState

Constructors

Instance(Gear, IBiasingSimulationState)

Initializes a new instance of the Gear.Instance class.

Declaration
public Instance(Gear parameters, IBiasingSimulationState state)
Parameters
Type Name Description
Gear parameters

The parameters.

IBiasingSimulationState state

The biasing simulation state.

Fields

Coefficients

The integration coefficients.

Declaration
protected readonly DenseVector<double> Coefficients
Field Value
Type Description
DenseVector<double>

PredictionCoefficients

The prediction coefficients.

Declaration
protected readonly DenseVector<double> PredictionCoefficients
Field Value
Type Description
DenseVector<double>

Solver

The solver used to calculate the coefficients.

Declaration
protected readonly DenseRealSolver Solver
Field Value
Type Description
DenseRealSolver

Methods

ComputeCoefficients()

Computes the integration coefficients.

Declaration
protected override void ComputeCoefficients()
Overrides
SpiceMethod.SpiceInstance.ComputeCoefficients()

CreateDerivative(bool)

Creates a derivative.

Declaration
public override IDerivative CreateDerivative(bool track)
Parameters
Type Name Description
bool track

If set to true, the integration method will use this state to limit truncation errors.

Returns
Type Description
IDerivative

The derivative.

Overrides
SpiceMethod.SpiceInstance.CreateDerivative(bool)

CreateIntegral(bool)

Creates an integrator.

Declaration
public override IIntegral CreateIntegral(bool track = true)
Parameters
Type Name Description
bool track

If set to true, the integration method will use this state to limit truncation errors.

Returns
Type Description
IIntegral

The integrator.

Overrides
SpiceMethod.SpiceInstance.CreateIntegral(bool)

Initialize()

Initializes the integration method using the allocated biasing state. At this point, all entities should have received the chance to allocate and register integration states.

Declaration
public override void Initialize()
Overrides
SpiceMethod.SpiceInstance.Initialize()

Predict()

Predicts a solution for truncation.

Declaration
protected override void Predict()
Overrides
SpiceMethod.SpiceInstance.Predict()

Implements

IBreakpointMethod
IIntegrationMethod
ISimulationState

Extension Methods

Utility.ThrowIfNull<T>(T, string)

See Also

SpiceMethod.SpiceInstance
IIntegrationMethod
In this article
Back to top Generated by DocFX