Package empro :: Module empro :: Module simulation :: Class SingleParameterSweep

Class SingleParameterSweep

core.Updatable --+
                 |
                SingleParameterSweep

A definition of a single parameter sweep.

Class Hierarchy for SingleParameterSweep

Instance Methods

getParameterValues(...)
No documentation available.

setParameterValues(...)
No documentation available.

None

setParameterValuesByCount(iStart, iEnd, iNumValues)
Sets the number of parameter values by specifying values.

None

setParameterValuesByIncrement(iStart, iIncrement, iNumValues)
Sets the number of parameter values by specifying an increment.

Properties
stringNone	parameterName The name of the parameter to sweep
`list`{float}None	parameterValues Returns a reference to a list of parameter values to be considered in the parameter sweep.

Method Details

Sets the number of parameter values by specifying values.

Parameters:

iStart (float) - The start value for the parameter sweep.
iEnd (float) - The end value for the parameter sweep.
iNumValues (int) - The number of iterations to generate between iStart and iEnd. If iNumValues must be at least one. If 1, only iStart is used.

Returns: None

Sets the number of parameter values by specifying an increment.

Parameters:

iStart (float) - The start value for the parameter sweep.
iIncrement (float) - The amount to increment the parameter for each iteration.
iNumValues (int) - The number of times to increment the parameter. This must be at least one.

Returns: None