Class Transient
A base class for time-domain analysis.
Implements
Inherited Members
Namespace: SpiceSharp.Simulations
Assembly: SpiceSharp.dll
Syntax
public class Transient : BiasingSimulation, IStateful<TemperatureSimulationState>, IStateful<IIterationSimulationState>, IBehavioral<IBiasingUpdateBehavior>, IParameterized<BiasingParameters>, ITimeSimulation, IBiasingSimulation, ISimulation<IVariable<double>>, ITemperatureSimulation, IEventfulSimulation, ISimulation, IParameterSetCollection, IParameterSet, IStateful<ITemperatureSimulationState>, IBehavioral<ITemperatureBehavior>, IBehavioral<IBiasingBehavior>, IBehavioral<IConvergenceBehavior>, IStateful<IBiasingSimulationState>, IBehavioral<ITimeBehavior>, IStateful<IIntegrationMethod>, IStateful<ITimeSimulationState>, IStateful, IBehavioral<IAcceptBehavior>, IBehavioral<ITruncatingBehavior>, IBehavioral, IParameterized<TimeParameters>
Constructors
Transient(string)
Initializes a new instance of the Transient class.
Declaration
public Transient(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | The name of the simulation. |
See Also
Transient(string, TimeParameters)
Initializes a new instance of the Transient class.
Declaration
public Transient(string name, TimeParameters parameters)
Parameters
Type | Name | Description |
---|---|---|
string | name | The name of the simulation. |
TimeParameters | parameters | The time parameters. |
See Also
Transient(string, double, double)
Initializes a new instance of the Transient class.
Declaration
public Transient(string name, double step, double final)
Parameters
Type | Name | Description |
---|---|---|
string | name | The name of the simulation. |
double | step | The step size. |
double | final | The final time. |
See Also
Transient(string, double, double, double)
Initializes a new instance of the Transient class.
Declaration
public Transient(string name, double step, double final, double maxStep)
Parameters
Type | Name | Description |
---|---|---|
string | name | The name of the simulation. |
double | step | The step size. |
double | final | The final time. |
double | maxStep | The maximum step. |
See Also
Properties
Statistics
Gets the statistics.
Declaration
public TimeSimulationStatistics Statistics { get; }
Property Value
Type | Description |
---|---|
TimeSimulationStatistics | The statistics. |
See Also
TimeParameters
Gets the time parameters.
Declaration
public TimeParameters TimeParameters { get; }
Property Value
Type | Description |
---|---|
TimeParameters | The time parameters. |
See Also
Methods
Accept()
Accepts the current simulation state as a valid timepoint.
Declaration
protected void Accept()
See Also
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 |
See Also
CreateStates()
Creates all the simulation states for the simulation.
Declaration
protected override void CreateStates()
Overrides
See Also
Execute()
Executes the simulation.
Declaration
protected override void Execute()
Overrides
Exceptions
Type | Condition |
---|---|
SpiceSharpException | Thrown if the simulation can't continue. |
See Also
InitializeStates()
Initializes all transient behaviors to assume that the current solution is the DC solution.
Declaration
protected virtual void InitializeStates()
See Also
LoadInitialConditions(object, LoadStateEventArgs)
Applies initial conditions.
Declaration
protected void LoadInitialConditions(object sender, LoadStateEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
object | sender | Sender |
LoadStateEventArgs | e | Arguments |
See Also
Probe()
Probe for a new time point.
Declaration
protected void Probe()
See Also
TimeIterate(int)
Iterates to a solution for time simulations.
Declaration
protected bool TimeIterate(int maxIterations)
Parameters
Type | Name | Description |
---|---|---|
int | maxIterations | The maximum number of iterations. |
Returns
Type | Description |
---|---|
bool |
|
See Also
Validate(IEntityCollection)
Validates the input.
Declaration
protected override void Validate(IEntityCollection entities)
Parameters
Type | Name | Description |
---|---|---|
IEntityCollection | entities | The entities. |
Overrides
Exceptions
Type | Condition |
---|---|
ArgumentNullException | Thrown if |
ValidationFailedException | Thrown if the validation failed. |