Interface ISimulation
Interface that describes a simulation.
Inherited Members
Namespace: SpiceSharp.Simulations
Assembly: SpiceSharp.dll
Syntax
public interface ISimulation : IStateful, IBehavioral, IParameterSetCollection, IParameterSetProperties
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. |