Show / Hide Table of Contents

Class Convergence.IterationSimulationState

An IIterationSimulationState that allows concurrent access.

Inheritance
System.Object
Convergence.IterationSimulationState
Implements
IIterationSimulationState
ISimulationState
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.ParallelComponents
Assembly: SpiceSharp.dll
Syntax
protected class IterationSimulationState : IIterationSimulationState, ISimulationState

Constructors

IterationSimulationState(IIterationSimulationState)

Initializes a new instance of the Convergence.IterationSimulationState class.

Declaration
public IterationSimulationState(IIterationSimulationState parent)
Parameters
Type Name Description
IIterationSimulationState parent

The parent.

Exceptions
Type Condition
System.ArgumentNullException

Thrown if parent is null.

Explicit Interface Implementations

IIterationSimulationState.Gmin

Gets or sets the a conductance that is shunted with PN junctions to aid convergence.

Declaration
double IIterationSimulationState.Gmin { get; }
Returns
Type Description
System.Double

The minimum conductance for PN junctions.

IIterationSimulationState.IsConvergent

Is the current iteration convergent? This parameter is used to communicate convergence.

Declaration
bool IIterationSimulationState.IsConvergent { get; set; }
Returns
Type Description
System.Boolean

true if this the iteration is convergent; otherwise, false.

IIterationSimulationState.Mode

Gets the iteration mode.

Declaration
IterationModes IIterationSimulationState.Mode { get; }
Returns
Type Description
IterationModes

The mode.

IIterationSimulationState.SourceFactor

The current source factor. This parameter is changed when doing source stepping for aiding convergence.

Declaration
double IIterationSimulationState.SourceFactor { get; }
Returns
Type Description
System.Double
Remarks

In source stepping, all sources are considered to be at 0 which has typically only one single solution (all nodes and currents are 0V and 0A). By increasing the source factor in small steps, it is possible to progressively reach a solution without having non-convergence.

Implements

IIterationSimulationState
ISimulationState

Extension Methods

Utility.ThrowIfNull<T>(T, String)

See Also

IIterationSimulationState
Back to top Generated by DocFX