Batch Sweep
Use the Batch Sweep study step to find the solution to a sequence of stationary or time-dependent simulations that arise when you vary some parameters of interest.
Syntax
model.study(stdname).create(fname, "BatchSweep");
model.study(stdname).feature(fname).set(pname,value);
Description
Study step.
The following properties are available.
Table 6-90: Properties for Study Settings.
Property
Value
Default
Description
plistarr
Real matrix
 
List of parameter values. One row of values per parameter name.
pname
Vector of strings
 
Parameter names.
punit
Vector of strings
 
Parameter units.
sweeptype
filled | sparse
sparse
Sweep type.
Table 6-91: Properties for Output While Solving.
Property
Value
Default
Description
accumtable
String
new
Accumulated probe table.
accumtableall
on | off
on
Use all probes for the accumulated probe table
probes
Vector of strings
 
Probes to use when probesel=manual.
probesel
all | none | manual
all
Probes to compute.
useaccumtable
on | off
on
Use accumulated probe table.
Table 6-92: Properties for Batch Settings.
Property
Value
Default
Description
batchdatastoragemode
filesystem | database | sameascurrentmodel
filesystem
Sets the storage mode for generated batch data during a batch run.
filesystem will store the data on the file system in the configured batch directories.
database will store the data in the same database and branch as where the original model is stored.
sameascurrentmodel will store the data where the original model is stored, which can be either the file system or a database.
batchdir
String
Home directory
The directory to store files used by the batch job.
batchfile
String
batchmodel.mph
Name of batch model file.
batchmodelstoragemode
filesystem | database | sameascurrentmodel
filesystem
Sets the storage mode for generated models during a batch run.
filesystem will store the models on the file system in the configured batch directories.
database will store the models in the same database and branch as where the original model is stored.
sameascurrentmodel will store the models where the original model is stored, which can be either the file system or a database.
clearmesh
on | off
on
Clear meshes.
clearsol
on | off
on
Clear solutions.
extsolvergen
on | off
off
Generate solver sequence in external process.
paramfilename
on | index
on
Add parameter names and values or shorter indices to the filename.
savefile
on | off
off
Output model to file.
serverdir
String
 
Server directory.
specserverdir
on | off
off
Specify server directory path.
sychaccumprobetable
on | off
on
Synchronize accumulated probe table.
synchsolutions
on | off
off
Synchronize solutions.
Table 6-93: Properties for Study Extensions.
Property
Value
Default
Description
graphics
on | off
off
Use graphics.
maxalive
Integer
 
Alive time (seconds).
maxallow
Integer
1
Maximum number of simultaneous jobs.
maxrestarts
Integer
 
Maximum number of job restarts.