Show / Hide Table of Contents

Interface ISimulation

Interface that describes a simulation.

Inherited Members
IStateful.GetState<S>()
IStateful.TryGetState<S>(out S)
IStateful.UsesState<S>()
IStateful.States
IBehavioral.Behaviors
IBehavioral.EntityBehaviors
IBehavioral.UsesBehaviors<B>()
IBehavioral.UsesBehavior(Type)
IParameterSetCollection.GetParameterSet<P>()
IParameterSetCollection.TryGetParameterSet<P>(out P)
IParameterSetCollection.ParameterSets
IParameterSet.SetParameter<P>(string, P)
IParameterSet.TrySetParameter<P>(string, P)
IParameterSet.GetProperty<P>(string)
IParameterSet.TryGetProperty<P>(string, out P)
IParameterSet.CreateParameterSetter<P>(string)
IParameterSet.CreatePropertyGetter<P>(string)
Namespace: SpiceSharp.Simulations
Assembly: SpiceSharp.dll
Syntax
public interface ISimulation : IStateful, IBehavioral, IParameterSetCollection, IParameterSet

Properties

CurrentRun

Gets the index of the current simulation run.

Declaration
int CurrentRun { get; }
Property Value
Type Description
int

Name

Gets the name of the ISimulation.

Declaration
string Name { get; }
Property Value
Type Description
string

The name.

Repeat

If set, the simulation is repeated. The property is automatically reset at the start of an execution.

Declaration
bool Repeat { get; set; }
Property Value
Type Description
bool

Status

Gets the current status of the ISimulation.

Declaration
SimulationStatus Status { get; }
Property Value
Type Description
SimulationStatus

The current status.

Methods

Rerun(int)

Reruns the ISimulation with the previous behaviors. Only one enumerable can run at any given time.

Declaration
IEnumerable<int> Rerun(int mask = 65535)
Parameters
Type Name Description
int mask

A bit mask for simulation export identifiers.

Returns
Type Description
IEnumerable<int>

An enumerable that yields a type identifier every time new simulation data is available.

Run(IEntityCollection, int)

Runs the ISimulation on the specified IEntityCollection. Only one enumerable can run at any given time.

Declaration
IEnumerable<int> Run(IEntityCollection entities, int mask = 65535)
Parameters
Type Name Description
IEntityCollection entities

The entities.

int mask

A bit mask for simulation export identifiers.

Returns
Type Description
IEnumerable<int>

An enumerable that yields a type identifier every time new simulation data is available.

Extension Methods

Documentation.ParameterValues<T>(IParameterSet, bool)
Documentation.Parameters(IParameterSet)
Documentation.ParameterValues<T>(IParameterSetCollection, bool)
Documentation.Parameters(IParameterSetCollection)
SimulationHelper.GetComplexCurrent(ISimulation, Reference)
SimulationHelper.GetComplexProperty(ISimulation, Reference, string)
SimulationHelper.GetComplexVoltage(ISimulation, Reference)
SimulationHelper.GetComplexVoltage(ISimulation, Reference, Reference)
SimulationHelper.GetCurrent(ISimulation, Reference)
SimulationHelper.GetProperty(ISimulation, Reference, string)
SimulationHelper.GetVoltage(ISimulation, Reference)
SimulationHelper.GetVoltage(ISimulation, Reference, Reference)
SimulationHelper.RunToEnd(ISimulation, IEntityCollection, IDictionary<int, Action>)
SimulationHelper.TryGetComplexCurrent(ISimulation, Reference, out Complex)
SimulationHelper.TryGetComplexProperty(ISimulation, Reference, string, out Complex)
SimulationHelper.TryGetComplexVoltage(ISimulation, Reference, Reference, out Complex)
SimulationHelper.TryGetComplexVoltage(ISimulation, Reference, out Complex)
SimulationHelper.TryGetCurrent(ISimulation, Reference, out double)
SimulationHelper.TryGetProperty(ISimulation, Reference, string, out double)
SimulationHelper.TryGetVoltage(ISimulation, Reference, Reference, out double)
SimulationHelper.TryGetVoltage(ISimulation, Reference, out double)
Utility.ThrowIfNull<T>(T, string)

See Also

IStateful
IBehavioral
IParameterSetCollection
In this article
Back to top Generated by DocFX