Class Biasing.LocalSimulationState

An IBiasingSimulationState that can be used with a local solver and solution.

Inheritance
object
SubcircuitSolverState<double, IBiasingSimulationState>
LocalSolverState<double, IBiasingSimulationState>
Biasing.LocalSimulationState
Implements
Inherited Members
Namespace: SpiceSharp.Components.Subcircuits
Assembly: SpiceSharp.dll
Syntax
protected class Biasing.LocalSimulationState : LocalSolverState<double, IBiasingSimulationState>, IBiasingSimulationState, ISolverSimulationState<double>, ISimulationState, IVariableFactory<IVariable<double>>, IVariableDictionary<IVariable<double>>, IReadOnlyDictionary<string, IVariable<double>>, IReadOnlyCollection<KeyValuePair<string, IVariable<double>>>, IEnumerable<KeyValuePair<string, IVariable<double>>>, IEnumerable

Constructors

LocalSimulationState(string, IBiasingSimulationState, ISparsePivotingSolver<double>)

Initializes a new instance of the Biasing.LocalSimulationState class.

Declaration
public LocalSimulationState(string name, IBiasingSimulationState parent, ISparsePivotingSolver<double> solver)
Parameters
Type Name Description
string name

The name of the subcircuit instance.
IBiasingSimulationState parent

The parent simulation state.
ISparsePivotingSolver<double> solver

The solver.
Exceptions
Type Condition
ArgumentNullException

Thrown if name, parent or solver is null.

Properties

OldSolution

Gets the solution vector of the last computed iteration.

Declaration
public IVector<double> OldSolution { get; }
Property Value
Type Description
IVector<double>

The solution to the last iteration.
Remarks

This vector is needed for determining convergence.

Methods

Initialize(IReadOnlyList<Bridge<string>>)

Initializes the specified shared.

Declaration
public override void Initialize(IReadOnlyList<Bridge<string>> nodes)
Parameters
Type Name Description
IReadOnlyList<Bridge<string>> nodes

The node map.
Overrides
Exceptions
Type Condition
ArgumentNullException

Thrown if nodes is null.

Update()

Updates the state with the new solution.

Declaration
public override void Update()
Overrides

Implements

Extension Methods

See Also