Struct DiodeVariables<T>

Variables for a diode.

Inherited Members

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: SpiceSharp.Components.Diodes

Assembly: SpiceSharp.dll

Syntax

public readonly struct DiodeVariables<T>

Type Parameters

Name	Description
T	The base value type.

Constructors

DiodeVariables(string, IVariableFactory<IVariable<T>>, IComponentBindingContext)

Initializes a new instance of the DiodeVariables<T> struct.

Declaration

public DiodeVariables(string name, IVariableFactory<IVariable<T>> factory, IComponentBindingContext context)

Parameters

Type	Name	Description
string	name	The name.
IVariableFactory<IVariable<T>>	factory	The factory.
IComponentBindingContext	context	The context.

Fields

Negative

The negative node.

Declaration

public readonly IVariable<T> Negative

Field Value

Type	Description
IVariable<T>

PosPrime

The internal positive node.

Declaration

public readonly IVariable<T> PosPrime

Field Value

Type	Description
IVariable<T>

Positive

The positive node.

Declaration

public readonly IVariable<T> Positive

Field Value

Type	Description
IVariable<T>

Methods

Equals(object)

Determines whether the specified object, is equal to this instance.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare with this instance.

Returns

Type	Description
bool	true if the specified object is equal to this instance; otherwise, false.

Overrides

ValueType.Equals(object)

GetHashCode()

Returns a hash code for this instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Overrides

ValueType.GetHashCode()

GetMatrixLocations(IVariableMap)

Gets the matrix locations.

Declaration

public MatrixLocation[] GetMatrixLocations(IVariableMap map)

Parameters

Type	Name	Description
IVariableMap	map	The map.

Returns

Type	Description
MatrixLocation[]	The matrix locations.

GetRhsIndicies(IVariableMap)

Gets the right hand side vector indicies.

Declaration

public int[] GetRhsIndicies(IVariableMap map)

Parameters

Type	Name	Description
IVariableMap	map	The map.

Returns

Type	Description
int[]	The right hand side vector indices.

Operators

operator ==(DiodeVariables<T>, DiodeVariables<T>)

Implements the operator ==.

Declaration

public static bool operator ==(DiodeVariables<T> left, DiodeVariables<T> right)

Parameters

Type	Name	Description
DiodeVariables<T>	left	The left.
DiodeVariables<T>	right	The right.

Returns

Type	Description
bool	The result of the operator.

operator !=(DiodeVariables<T>, DiodeVariables<T>)

Implements the operator !=.

Declaration

public static bool operator !=(DiodeVariables<T> left, DiodeVariables<T> right)

Parameters

Type	Name	Description
DiodeVariables<T>	left	The left.
DiodeVariables<T>	right	The right.

Returns

Type	Description
bool	The result of the operator.

Extension Methods

Utility.ThrowIfNull<T>(T, string)