Package org.cha0scollective.wwpg.api

Record Class ElectricalModel.Diode

java.lang.Object

java.lang.Record

org.cha0scollective.wwpg.api.ElectricalModel.Diode

All Implemented Interfaces:

ElectricalModel

Enclosing interface:

ElectricalModel

public static record ElectricalModel.Diode(double saturationCurrentAmps, double seriesResistanceOhms, double temperatureCelsius, double idealityFactor)
extends Record
implements ElectricalModel

PG-native silicon PN-junction model, with temperature compensation and series resistance. Positive node is the anode. This is not an ideal diode or a bare Shockley equation. API 1.0 does not enable optional avalanche breakdown.

Nested Class Summary

Nested classes/interfaces inherited from interface org.cha0scollective.wwpg.api.ElectricalModel

ElectricalModel.AcVoltageSource, ElectricalModel.Capacitor, ElectricalModel.ControlledCurrentSource, ElectricalModel.ControlledVoltageSource, ElectricalModel.CurrentSource, ElectricalModel.Diode, ElectricalModel.Inductor, ElectricalModel.Resistor, ElectricalModel.Switch, ElectricalModel.Transformer, ElectricalModel.VoltageSource

Constructor Summary

Constructors

Constructor	Description
Diode(double saturationCurrentAmps, double seriesResistanceOhms, double temperatureCelsius, double idealityFactor)	Creates an instance of a Diode record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
double	idealityFactor()	Returns the value of the idealityFactor record component.
double	saturationCurrentAmps()	Returns the value of the saturationCurrentAmps record component.
double	seriesResistanceOhms()	Returns the value of the seriesResistanceOhms record component.
double	temperatureCelsius()	Returns the value of the temperatureCelsius record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Documentation correction · 2026-10-12

WWPG 0.2.1 / API 1.0.0 · ElectricalModel.Diode constructor

Arguments violating these constraints throw IllegalArgumentException; required null references throw NullPointerException.

Constructor arguments

Argument	Units and accepted values
saturationCurrentAmps	saturation current in amperes, finite in [1e-30, 1e15] inclusive
seriesResistanceOhms	series resistance in ohms; finite, in [1e-12, 1e15] (inclusive)
temperatureCelsius	temperature in Celsius, finite in (-273.15, 1e15]
idealityFactor	dimensionless ideality factor; finite, in [1e-12, 1e15] (inclusive)

Verified released source · Complete validation table

The released reference is preserved; this annotation clarifies existing behavior.

Constructor Details

Diode

public Diode(double saturationCurrentAmps,
 double seriesResistanceOhms,
 double temperatureCelsius,
 double idealityFactor)

Creates an instance of a Diode record class.

Parameters:

saturationCurrentAmps - the value for the saturationCurrentAmps record component

seriesResistanceOhms - the value for the seriesResistanceOhms record component

temperatureCelsius - the value for the temperatureCelsius record component

idealityFactor - the value for the idealityFactor record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

saturationCurrentAmps

public double saturationCurrentAmps()

Returns the value of the saturationCurrentAmps record component.

Returns:

the value of the saturationCurrentAmps record component

seriesResistanceOhms

public double seriesResistanceOhms()

Returns the value of the seriesResistanceOhms record component.

Returns:

the value of the seriesResistanceOhms record component

temperatureCelsius

public double temperatureCelsius()

Returns the value of the temperatureCelsius record component.

Returns:

the value of the temperatureCelsius record component

idealityFactor

public double idealityFactor()

Returns the value of the idealityFactor record component.

Returns:

the value of the idealityFactor record component