Class Frequency.LocalSimulationState
An IComplexSimulationState that can be used with a local solver and solution.
Inheritance
System.Object
Frequency.LocalSimulationState
Implements
ISolverSimulationState<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
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 |
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 |
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 |
|
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
System.Collections.Generic.IReadOnlyDictionary<TKey, TValue>
System.Collections.Generic.IReadOnlyCollection<T>
System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable