Class UpdateFluxEventArgs

Event arguments used to modify flux through an Inductor.

Inheritance

object

EventArgs

UpdateFluxEventArgs

Inherited Members

EventArgs.Empty

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: SpiceSharp.Components.Inductors

Assembly: SpiceSharp.dll

Syntax

public class UpdateFluxEventArgs : EventArgs

Constructors

UpdateFluxEventArgs(double, double, IDerivative)

Initializes a new instance of the UpdateFluxEventArgs class.

Declaration

public UpdateFluxEventArgs(double inductance, double current, IDerivative flux)

Parameters

Type	Name	Description
double	inductance	The current inductance.
double	current	The current.
IDerivative	flux	Flux

Exceptions

Type	Condition
ArgumentNullException	Thrown if flux is null.

Properties

Current

Gets the original current through the inductor

Declaration

public double Current { get; }

Property Value

Type	Description
double	The original current through the inductor.

Flux

Gets the IDerivative that represents the flux through the inductor (initially set to the original flux).

Declaration

public IDerivative Flux { get; }

Property Value

Type	Description
IDerivative	The flux of the inductor.

Remarks

Change this value if you want to change the flux through the inductor.

Inductance

Gets the inductance of the inductor

Declaration

public double Inductance { get; }

Property Value

Type	Description
double	The inductance of the inductor.

OriginalFlux

Gets the original flux through the inductor

Declaration

public double OriginalFlux { get; }

Property Value

Type	Description
double	The original flux through the inductor.

Extension Methods

Utility.ThrowIfNull<T>(T, string)

See Also

EventArgs