Class Noise

A class that implements a noise analysis.

Inheritance
object
ParameterSet
ParameterSetCollection
Simulation
BiasingSimulation
FrequencySimulation
Noise
Implements
Inherited Members
Namespace: SpiceSharp.Simulations
Assembly: SpiceSharp.dll
Syntax
public class Noise : FrequencySimulation, IStateful<TemperatureSimulationState>, IStateful<IIterationSimulationState>, IBehavioral<IBiasingUpdateBehavior>, IParameterized<BiasingParameters>, IBehavioral<IFrequencyUpdateBehavior>, IParameterized<FrequencyParameters>, INoiseSimulation, IFrequencySimulation, IBiasingSimulation, ISimulation<IVariable<double>>, ITemperatureSimulation, IStateful<ITemperatureSimulationState>, IBehavioral<ITemperatureBehavior>, IBehavioral<IBiasingBehavior>, IBehavioral<IConvergenceBehavior>, IStateful<IBiasingSimulationState>, ISimulation<IVariable<Complex>>, ISimulation, IParameterSetCollection, IParameterSet, IBehavioral<IFrequencyBehavior>, IStateful<IComplexSimulationState>, IBehavioral<INoiseBehavior>, IBehavioral, IStateful<INoiseSimulationState>, IStateful, IParameterized<NoiseParameters>

Constructors

Noise(string)

Initializes a new instance of the Noise class.

Declaration
public Noise(string name)
Parameters
Type Name Description
string name

The name of the simulation.
Exceptions
Type Condition
ArgumentNullException

Thrown if name is null.

Noise(string, string, string, IEnumerable<double>)

Initializes a new instance of the Noise class.

Declaration
public Noise(string name, string input, string output, IEnumerable<double> frequencySweep)
Parameters
Type Name Description
string name

The name of the simulation.
string input

The name of the input source.
string output

The output node name.
IEnumerable<double> frequencySweep

The frequency points.
Exceptions
Type Condition
ArgumentNullException

Thrown if name is null.

Noise(string, string, string, string, IEnumerable<double>)

Initializes a new instance of the Noise class.

Declaration
public Noise(string name, string input, string output, string reference, IEnumerable<double> frequencySweep)
Parameters
Type Name Description
string name

The name of the simulation.
string input

The name of the input source.
string output

The output node name.
string reference

The reference output node name.
IEnumerable<double> frequencySweep

The frequency points.
Exceptions
Type Condition
ArgumentNullException

Thrown if name is null.

Fields

ExportNoise

The constant returned when exporting noise.

Declaration
public const int ExportNoise = 4
Field Value
Type Description
int

ExportOperatingPoint

The constant returned when exporting the operating point.

Declaration
public const int ExportOperatingPoint = 1
Field Value
Type Description
int

ExportSmallSignal

The constant returned when exporting the small signal solution.

Declaration
public const int ExportSmallSignal = 2
Field Value
Type Description
int

Properties

Frequency

Gets the current frequency point.

Declaration
public double Frequency { get; }
Property Value
Type Description
double

NoiseParameters

Gets the noise parameters.

Declaration
public NoiseParameters NoiseParameters { get; }
Property Value
Type Description
NoiseParameters

The noise parameters.

Methods

CreateBehaviors(IEntityCollection)

Creates all behaviors for the simulation.

Declaration
protected override void CreateBehaviors(IEntityCollection entities)
Parameters
Type Name Description
IEntityCollection entities

The entities.
Overrides
Exceptions
Type Condition
ArgumentNullException

Thrown if entities is null.

CreateStates()

Creates all the simulation states for the simulation.

Declaration
protected override void CreateStates()
Overrides

Execute(int)

Executes the simulation.

Declaration
protected override IEnumerable<int> Execute(int mask = 65535)
Parameters
Type Name Description
int mask

A bit mask for simulation export identifiers.
Returns
Type Description
IEnumerable<int>
Overrides
Exceptions
Type Condition
SpiceSharpException

Thrown if the simulation can't continue.

Implements

Extension Methods

See Also