Class ConvergenceAid

A template for aiding convergence.

Inheritance

object

ConvergenceAid

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: SpiceSharp.Simulations

Assembly: SpiceSharp.dll

Syntax

public class ConvergenceAid

Remarks

The convergence aid will try to bring the solution of a variable as close as possible to the specified value. If this value is close to the final solution, then convergence can be achieved much faster.

Constructors

ConvergenceAid(IVariable, IBiasingSimulationState, double)

Initializes a new instance of the ConvergenceAid class.

Declaration

public ConvergenceAid(IVariable variable, IBiasingSimulationState state, double value)

Parameters

Type	Name	Description
IVariable	variable	The variable.
IBiasingSimulationState	state	The biasing simulation state.
double	value	The value.

Exceptions

Type	Condition
ArgumentNullException	Thrown if variable or state is null.
SpiceSharpException	Thrown if the variable for the convergence aid was not found.

Properties

Value

Gets the value for the convergence aid.

Declaration

public double Value { get; }

Property Value

Type	Description
double

Variable

Gets the variable.

Declaration

public IVariable Variable { get; }

Property Value

Type	Description
IVariable	The variable.

Methods

Aid()

Aids the convergence.

Declaration

public virtual void Aid()

Extension Methods

Utility.ThrowIfNull<T>(T, string)