Show / Hide Table of Contents

Class Frequency.LocalSimulationState

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

Inheritance
System.Object
SubcircuitSolverState<System.Numerics.Complex, IComplexSimulationState>
LocalSolverState<System.Numerics.Complex, IComplexSimulationState>
Frequency.LocalSimulationState
Implements
IComplexSimulationState
ISolverSimulationState<System.Numerics.Complex>
ISimulationState
IVariableFactory<IVariable<System.Numerics.Complex>>
IVariableDictionary<IVariable<System.Numerics.Complex>>
System.Collections.Generic.IReadOnlyDictionary<System.String, IVariable<System.Numerics.Complex>>
System.Collections.Generic.IReadOnlyCollection<System.Collections.Generic.KeyValuePair<System.String, IVariable<System.Numerics.Complex>>>
System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.String, IVariable<System.Numerics.Complex>>>
System.Collections.IEnumerable
Inherited Members
LocalSolverState<Complex, IComplexSimulationState>.LocalSolution
LocalSolverState<Complex, IComplexSimulationState>.Initialize(IReadOnlyList<Bridge<String>>)
LocalSolverState<Complex, IComplexSimulationState>.Apply()
LocalSolverState<Complex, IComplexSimulationState>.Update()
LocalSolverState<Complex, IComplexSimulationState>.GetSharedVariable(String)
LocalSolverState<Complex, IComplexSimulationState>.CreatePrivateVariable(String, IUnit)
LocalSolverState<Complex, IComplexSimulationState>.Solver
LocalSolverState<Complex, IComplexSimulationState>.Solution
LocalSolverState<Complex, IComplexSimulationState>.Map
LocalSolverState<Complex, IComplexSimulationState>.Updated
SubcircuitSolverState<Complex, IComplexSimulationState>.Name
SubcircuitSolverState<Complex, IComplexSimulationState>.Parent
SubcircuitSolverState<Complex, IComplexSimulationState>.Add(String, IVariable<Complex>)
SubcircuitSolverState<Complex, IComplexSimulationState>.ContainsKey(String)
SubcircuitSolverState<Complex, IComplexSimulationState>.TryGetValue(String, IVariable<Complex>)
SubcircuitSolverState<Complex, IComplexSimulationState>.GetEnumerator()
SubcircuitSolverState<Complex, IComplexSimulationState>.IEnumerable.GetEnumerator()
SubcircuitSolverState<Complex, IComplexSimulationState>.Comparer
SubcircuitSolverState<Complex, IComplexSimulationState>.Item[String]
SubcircuitSolverState<Complex, IComplexSimulationState>.Keys
SubcircuitSolverState<Complex, IComplexSimulationState>.Values
SubcircuitSolverState<Complex, IComplexSimulationState>.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<Complex, IComplexSimulationState>, IComplexSimulationState, ISolverSimulationState<Complex>, ISimulationState, IVariableFactory<IVariable<Complex>>, IVariableDictionary<IVariable<Complex>>, IReadOnlyDictionary<string, IVariable<Complex>>, IReadOnlyCollection<KeyValuePair<string, IVariable<Complex>>>, IEnumerable<KeyValuePair<string, IVariable<Complex>>>, IEnumerable

Constructors

LocalSimulationState(String, IComplexSimulationState, ISparsePivotingSolver<Complex>)

Initializes a new instance of the Frequency.LocalSimulationState class.

Declaration
public LocalSimulationState(string name, IComplexSimulationState parent, ISparsePivotingSolver<Complex> solver)
Parameters
Type Name Description
System.String name

The name.

IComplexSimulationState parent

The parent.

ISparsePivotingSolver<System.Numerics.Complex> solver

The solver.

Exceptions
Type Condition
System.ArgumentNullException

Thrown if name, parent or solver is null.

Properties

IsConvergent

Gets or sets a value indicating whether the solution converges.

Declaration
public bool IsConvergent { get; set; }
Property Value
Type Description
System.Boolean

If true, the solution for this subcircuit converges.

Laplace

Gets or sets the current laplace variable.

Declaration
public Complex Laplace { get; }
Property Value
Type Description
System.Numerics.Complex

The laplace.

Methods

Apply()

Applies the local solver to the parent solver.

Declaration
public override bool Apply()
Returns
Type Description
System.Boolean

true if the application was successful; otherwise, false.

Overrides
SpiceSharp.Components.Subcircuits.LocalSolverState<System.Numerics.Complex, SpiceSharp.Simulations.IComplexSimulationState>.Apply()
Exceptions
Type Condition
NoEquivalentSubcircuitException

Thrown if no equivalent contributions could be calculated.

Implements

IComplexSimulationState
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>
IComplexSimulationState
Back to top Generated by DocFX