Class TimeParameters

A configuration for a ITimeSimulation with all the necessary parameters to do a transient analysis.

Inheritance

object

ParameterSet

TimeParameters

FixedEuler

FixedTrapezoidal

VariableTimestepConfiguration

Implements

IParameterSet

ICloneable<TimeParameters>

Inherited Members

ParameterSet.SetParameter<P>(string, P)

ParameterSet.TrySetParameter<P>(string, P)

ParameterSet.GetProperty<P>(string)

ParameterSet.TryGetProperty<P>(string, out P)

ParameterSet.CreateParameterSetter<P>(string)

ParameterSet.CreatePropertyGetter<P>(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: SpiceSharp.Simulations

Assembly: SpiceSharp.dll

Syntax

public abstract class TimeParameters : ParameterSet, IParameterSet, ICloneable<TimeParameters>

Constructors

TimeParameters()

Initializes a new instance of the TimeParameters class.

Declaration

protected TimeParameters()

TimeParameters(Dictionary<string, double>)

Initializes a new instance of the TimeParameters class.

Declaration

protected TimeParameters(Dictionary<string, double> ic)

Parameters

Type	Name	Description
Dictionary<string, double>	ic	The initial conditions.

Properties

InitialConditions

Gets the initial conditions.

Declaration

public Dictionary<string, double> InitialConditions { get; }

Property Value

Type	Description
Dictionary<string, double>	The initial conditions.

StartTime

Gets or sets the start time.

Declaration

[ParameterName("tstart")]
[ParameterName("t0")]
[ParameterInfo("The initial timepoint to start exporting data.")]
[GreaterThanOrEquals(0)]
public double StartTime { get; set; }

Property Value

Type	Description
double	The start time.

Exceptions

Type	Condition
ArgumentException	Thrown if the timepoint is negative.

StopTime

Gets or sets the stop time.

Declaration

[ParameterName("tstop")]
[ParameterInfo("The final timepoint.")]
[GreaterThanOrEquals(0)]
public double StopTime { get; set; }

Property Value

Type	Description
double	The stop time.

Exceptions

Type	Condition
ArgumentException	Thrown if the timepoint is negative.

TransientMaxIterations

Gets or sets the transient maximum iterations.

Declaration

[ParameterName("itl4")]
[ParameterInfo("The maximum number of transient timepoint iterations.")]
[GreaterThan(0)]
public int TransientMaxIterations { get; set; }

Property Value

Type	Description
int	The transient maximum iterations.

UseIc

Gets or sets a value indicating whether initial conditions should be set by the entities.

Declaration

[ParameterName("uic")]
[ParameterInfo("A flag indicating that entities should set their own initial conditions.")]
public bool UseIc { get; set; }

Property Value

Type	Description
bool	true if initial conditions; otherwise, false.

Validate

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

Declaration

[ParameterName("time.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 virtual TimeParameters Clone()

Returns

Type	Description
TimeParameters	The cloned instance.

Create(IBiasingSimulationState)

Creates an instance of the integration method.

Declaration

public abstract IIntegrationMethod Create(IBiasingSimulationState state)

Parameters

Type	Name	Description
IBiasingSimulationState	state	The biasing simulation state that will be used as a base.

Returns

Type	Description
IIntegrationMethod	The integration method.

Implements

IParameterSet

ICloneable<T>

Extension Methods

Documentation.ParameterValues<T>(IParameterSet, bool)

Documentation.Parameters(IParameterSet)

Utility.ThrowIfNull<T>(T, string)

See Also

ParameterSet