Class FrequencyParameters

A configuration for a FrequencySimulation.

Inheritance
object
ParameterSet
FrequencyParameters
Implements
Inherited Members
Namespace: SpiceSharp.Simulations
Assembly: SpiceSharp.dll
Syntax
public class FrequencyParameters : ParameterSet, ICloneable<FrequencyParameters>, IImportParameterSet<bool>, IExportPropertySet<bool>, IImportParameterSet<double>, IExportPropertySet<double>, IParameterSet

Constructors

FrequencyParameters()

Initializes a new instance of the FrequencyParameters class. Automatically specifies a sweep from 1Hz to 100Hz with 10 points per decade.

Declaration
public FrequencyParameters()

FrequencyParameters(IEnumerable<double>)

Initializes a new instance of the FrequencyParameters class.

Declaration
public FrequencyParameters(IEnumerable<double> frequencySweep)
Parameters
Type Name Description
IEnumerable<double> frequencySweep

The frequency points.

Properties

AbsolutePivotThreshold

Gets or sets the absolute threshold for choosing a pivot.

Declaration
[ParameterName("pivtol")]
[ParameterInfo("The absolute threshold for validating pivots")]
[GreaterThanOrEquals(0)]
public double AbsolutePivotThreshold { get; set; }
Property Value
Type Description
double

The absolute pivot threshold.
Exceptions
Type Condition
ArgumentOutOfRangeException

Thrown if the value is negative.

Frequencies

Gets or sets the frequency points to be simulated.

Declaration
public IEnumerable<double> Frequencies { get; set; }
Property Value
Type Description
IEnumerable<double>

The frequency points.

KeepOpInfo

Gets or sets a value indicating whether the operation point should be exported.

Declaration
public bool KeepOpInfo { get; set; }
Property Value
Type Description
bool

true if operating point information should be exported; otherwise, false.

RelativePivotThreshold

Gets or sets the relative threshold for choosing a pivot.

Declaration
[ParameterName("pivrel")]
[ParameterInfo("The relative threshold for validating pivots")]
[GreaterThan(0)]
public double RelativePivotThreshold { get; set; }
Property Value
Type Description
double

The relative pivot threshold.
Exceptions
Type Condition
ArgumentOutOfRangeException

Thrown if the value is not greater than 0.

Validate

Gets or sets a value indicating whether the simulation should be validated.

Declaration
[ParameterName("frequency.validate")]
[ParameterInfo("Flag indicating whether the simulation should validate the circuit before executing")]
public bool Validate { get; set; }
Property Value
Type Description
bool

true if the simulation should be validated; otherwise, false.

Methods

Clone()

Clones the instance.

Declaration
public FrequencyParameters Clone()
Returns
Type Description
FrequencyParameters

The cloned instance.

CreateSolver()

Creates solver used to solve equations.

Declaration
public ISparsePivotingSolver<Complex> CreateSolver()
Returns
Type Description
ISparsePivotingSolver<Complex>

A solver that can be used to solve equations.

Implements

Extension Methods

See Also