Show / Hide Table of Contents

Class VariableTimestepConfiguration

A configuration for an integration method that has a variable timestep.

Inheritance
object
ParameterSet
TimeParameters
VariableTimestepConfiguration
SpiceMethod
Implements
IParameterSet
ICloneable<TimeParameters>
Inherited Members
TimeParameters.UseIc
TimeParameters.InitialConditions
TimeParameters.Validate
TimeParameters.Create(IBiasingSimulationState)
TimeParameters.Clone()
TimeParameters.TransientMaxIterations
TimeParameters.StartTime
TimeParameters.StopTime
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.IntegrationMethods
Assembly: SpiceSharp.dll
Syntax
public abstract class VariableTimestepConfiguration : TimeParameters, IParameterSet, ICloneable<TimeParameters>

Properties

MaxStep

Gets or sets the maximum step. If the maximum timestep is 0.0, a maximum timestep is chosen of 1/50 the time range.

Declaration
[ParameterName("maxstep")]
[ParameterName("deltamax")]
[ParameterInfo("The maximum timestep.")]
public virtual double MaxStep { get; set; }
Property Value
Type Description
double

The maximum timestep.

Exceptions
Type Condition
ArgumentException

Thrown if the specified timestep is negative.

MaximumExpansion

Gets or sets the maximum timestep expansion factor.

Declaration
[ParameterName("expansion")]
[ParameterInfo("The maximum timestep expansion factor.")]
public virtual double MaximumExpansion { get; set; }
Property Value
Type Description
double

The maximum timestep expansion factor.

Exceptions
Type Condition
ArgumentException

Thrown if the expansion factor is less than 1.

MinStep

Gets or sets the minimum step. If the minimum timestep is 0.0, a minimum timestep is chosen of 1e-9 * MaxStep.

Declaration
[ParameterName("minstep")]
[ParameterName("deltamin")]
[ParameterInfo("The minimum timestep.")]
public virtual double MinStep { get; set; }
Property Value
Type Description
double

The minimum timestep.

Exceptions
Type Condition
ArgumentException

Thrown if the specified timestep is negative.

Implements

IParameterSet
ICloneable<T>

Extension Methods

Documentation.ParameterValues<T>(IParameterSet, bool)
Documentation.Parameters(IParameterSet)
Utility.ThrowIfNull<T>(T, string)

See Also

TimeParameters
In this article
Back to top Generated by DocFX