ParameterSweep Object

Allows to automatically perform several simulations with varying parameters.

• Methods

• Default Settings

• Example

Methods

SetSimulationType ( enum type )

Sets the simulation type to the given type.

type can have one of  the following values:

AddSequence ( name name )

Defines a new simulation sequence. In a sequence several different sets of parameters with different values can be defined. These sets are then taken by the parameter sweep to recreate the structure and automatically simulate it for each set.

DeleteSequence ( name name )

Deletes a sequence.

DeleteAllSequences

Deletes all previously defined sequences.

RenameSequence ( name oldname, name newname )

Renames a sequence.

AddParameter  ( name sequencename, name parametername, bool sweep, double from, double to, int steps )

Adds a parameter to a sequence.

DeleteParameter ( name sequencename, name parametername )

Deletes a parameter from a sequence.

GetNumberOfVaryingParameters long

Get the number of varying parameters.

GetNameOfVaryingParameter ( long index ) string

Returns the name of the specified parameter.

GetValueOfVaryingParameter ( long index ) double

Returns the value of the specified parameter.

AddSParameterWatch ( string key, int outport, int outmode, int inport, int inmode )

Defines which signal of the different simulation runs will be stored by the parameter sweep for every simulation it does. After it has finished, it will create a ”Tables” folder in the tree view, where all results are collected.

key can have one of  the following values:

This method is only active, if the time domain solver is used for the parameter sweep.

AddVolumeWatch ( solidname name )

This method adds the volume of a previously defined solid to the watch list, i.e. the volume of the selected solid is stored for every simulation of the parameter sweep. After the sweep has finished, the results are collected under a ”Tables” Folder in the tree view.

AddUserdefinedWatch

This method offers the possibility to define a userdefined  watch. Only one user defined goal can be added and its results are collected under a ”Tables” Folder in the tree view.

AddModeFrequencyWatch ( int  number )

Adds a mode number to the watch, such that the values of this mode are stored for every simulation of the parameter sweep. After the sweep has finished, the results are collected under a ”Tables” Folder in the tree view.

This method is only active, if the eigenmode solver is used for the parameter sweep.

DeleteWatch ( name name )

Deletes a previously defined watch.

Start

Starts the parameter sweep.

UseDistributedComputing ( bool switch )

Enables/disables the distributed calculation of different solver runs across the network.

Default Settings

SetSimulationType ("")

UseDistributedComputing (False)

Example

With ParameterSweep

    .SetSimulationType ("Transient")

    .AddSequence ("Sweep")

    .AddParameter ("Sweep", "l", True, 2.6, 2.8, 5)

    .AddSparameterWatch ("magLin", 2, 1, 1, 1)

    .Start

End With