Class ParameterSweep
A sweep of a property of an entity.
Inherited Members
Namespace: SpiceSharp.Simulations
Assembly: SpiceSharp.dll
Syntax
public class ParameterSweep : ParameterSet, ISweep, IParameterSet, ICloneable<ISweep>Constructors
ParameterSweep(string, IEnumerable<double>)
Initializes a new instance of the ParameterSweep class.
Declaration
public ParameterSweep(string name, IEnumerable<double> points)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The name of the entity. |
| IEnumerable<double> | points | The points. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | Thrown if |
ParameterSweep(string, string, IEnumerable<double>)
Initializes a new instance of the ParameterSweep class.
Declaration
public ParameterSweep(string name, string property, IEnumerable<double> points)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The name of the entity. |
| string | property | The property name. |
| IEnumerable<double> | points | The points. |
ParameterSweep(string, string, IEnumerable<double>, Action<IBehaviorContainer>)
Initializes a new instance of the ParameterSweep class.
Declaration
public ParameterSweep(string name, string property, IEnumerable<double> points, Action<IBehaviorContainer> update)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The name. |
| string | property | The property. |
| IEnumerable<double> | points | The points. |
| Action<IBehaviorContainer> | update | The method used to update the entity. |
Properties
Name
Gets the name of the sweep.
Declaration
public string Name { get; }Property Value
| Type | Description |
|---|---|
| string | The name of the sweep. |
Points
Gets or sets the points to apply.
Declaration
public IEnumerable<double> Points { get; }Property Value
| Type | Description |
|---|---|
| IEnumerable<double> | The points to apply. |
Property
Gets the property that needs to be swept.
Declaration
public string Property { get; }Property Value
| Type | Description |
|---|---|
| string | The property to be swept. |
Update
Gets the method called when the value has been updated.
Declaration
public Action<IBehaviorContainer> Update { get; }Property Value
| Type | Description |
|---|---|
| Action<IBehaviorContainer> | The update method. |
Methods
Clone()
Clones the instance.
Declaration
public ISweep Clone()Returns
| Type | Description |
|---|---|
| ISweep | The cloned instance. |
CreatePoints(IBiasingSimulation)
Creates an enumerable that can sweep properties of the simulation.
Declaration
public IEnumerator<double> CreatePoints(IBiasingSimulation simulation)Parameters
| Type | Name | Description |
|---|---|---|
| IBiasingSimulation | simulation | The simulation to create the points for. |
Returns
| Type | Description |
|---|---|
| IEnumerator<double> | The created sweep points. |