Class Biasing.LocalSimulationState
An IBiasingSimulationState that can be used with a local solver and solution.
Inheritance
System.Object
Biasing.LocalSimulationState
Implements
ISolverSimulationState<System.Double>
System.Collections.Generic.IReadOnlyCollection<System.Collections.Generic.KeyValuePair<System.String, IVariable<System.Double>>>
System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.String, IVariable<System.Double>>>
System.Collections.IEnumerable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: SpiceSharp.Components.Subcircuits.Simple
Assembly: SpiceSharp.dll
Syntax
protected class 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 |
|---|---|---|
| System.String | name | The name of the subcircuit instance. |
| IBiasingSimulationState | parent | The parent simulation state. |
| ISparsePivotingSolver<System.Double> | solver | The solver. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentNullException | Thrown if |
Properties
OldSolution
Gets the solution vector of the last computed iteration.
Declaration
public IVector<double> OldSolution { get; }
Property Value
| Type | Description |
|---|---|
| IVector<System.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 |
|---|---|---|
| System.Collections.Generic.IReadOnlyList<Bridge<System.String>> | nodes | The node map. |
Overrides
SpiceSharp.Components.Subcircuits.LocalSolverState<System.Double, SpiceSharp.Simulations.IBiasingSimulationState>.Initialize(System.Collections.Generic.IReadOnlyList<SpiceSharp.Components.Subcircuits.Bridge<System.String>>)
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentNullException | Thrown if |
Update()
Updates the state with the new solution.
Declaration
public override void Update()
Overrides
SpiceSharp.Components.Subcircuits.LocalSolverState<System.Double, SpiceSharp.Simulations.IBiasingSimulationState>.Update()
Implements
System.Collections.Generic.IReadOnlyDictionary<TKey, TValue>
System.Collections.Generic.IReadOnlyCollection<T>
System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable