Show / Hide Table of Contents

Class Biasing.LocalSimulationState

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

Inheritance
System.Object
SubcircuitSolverState<System.Double, IBiasingSimulationState>
LocalSolverState<System.Double, IBiasingSimulationState>
Biasing.LocalSimulationState
Implements
IBiasingSimulationState
ISolverSimulationState<System.Double>
ISimulationState
IVariableFactory<IVariable<System.Double>>
IVariableDictionary<IVariable<System.Double>>
System.Collections.Generic.IReadOnlyDictionary<System.String, IVariable<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
LocalSolverState<Double, IBiasingSimulationState>.LocalSolution
LocalSolverState<Double, IBiasingSimulationState>.Initialize(IReadOnlyList<Bridge<String>>)
LocalSolverState<Double, IBiasingSimulationState>.Apply()
LocalSolverState<Double, IBiasingSimulationState>.Update()
LocalSolverState<Double, IBiasingSimulationState>.GetSharedVariable(String)
LocalSolverState<Double, IBiasingSimulationState>.CreatePrivateVariable(String, IUnit)
LocalSolverState<Double, IBiasingSimulationState>.Solver
LocalSolverState<Double, IBiasingSimulationState>.Solution
LocalSolverState<Double, IBiasingSimulationState>.Map
LocalSolverState<Double, IBiasingSimulationState>.Updated
SubcircuitSolverState<Double, IBiasingSimulationState>.Name
SubcircuitSolverState<Double, IBiasingSimulationState>.Parent
SubcircuitSolverState<Double, IBiasingSimulationState>.Add(String, IVariable<Double>)
SubcircuitSolverState<Double, IBiasingSimulationState>.ContainsKey(String)
SubcircuitSolverState<Double, IBiasingSimulationState>.TryGetValue(String, IVariable<Double>)
SubcircuitSolverState<Double, IBiasingSimulationState>.GetEnumerator()
SubcircuitSolverState<Double, IBiasingSimulationState>.IEnumerable.GetEnumerator()
SubcircuitSolverState<Double, IBiasingSimulationState>.Comparer
SubcircuitSolverState<Double, IBiasingSimulationState>.Item[String]
SubcircuitSolverState<Double, IBiasingSimulationState>.Keys
SubcircuitSolverState<Double, IBiasingSimulationState>.Values
SubcircuitSolverState<Double, IBiasingSimulationState>.Count
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 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<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 nodes is null.

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

IBiasingSimulationState
ISolverSimulationState<T>
ISimulationState
IVariableFactory<V>
IVariableDictionary<V>
System.Collections.Generic.IReadOnlyDictionary<TKey, TValue>
System.Collections.Generic.IReadOnlyCollection<T>
System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable

Extension Methods

Utility.ThrowIfNull<T>(T, String)

See Also

LocalSolverState<T, S>
IBiasingSimulationState
Back to top Generated by DocFX