Cluster Sweep

Use the Cluster Sweep study step when you want to study to solve several models in parallel where each model has a different set of parameters.

Syntax

model.study(stdname).create(fname, "ClusterSweep");

model.study(stdname).feature(fname).set(pname,value);

Description

Study step.

The following properties are available.

Table 6-87: 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-88: 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 an accumulated probe table.

Table 6-89: Properties for Batch Settings

Property	Value	Default	Description
batchdir	String		Batch directory.
batchfile	String	batchmodel.mph	Name of batch model file.
batchlic	on | off		Use batch license.
clearmesh	on | off	on	Clear meshes.
clearsol	on | off	on	Clear solutions.
clustertype	general | whpc2008 | wccs2003 | sge | slurm | none		The type of cluster job.
hostfile	String		Path to host file.
mpd	on | off		If an mpd is running on the computer or not.
mpibootstrap	String		Name of bootstrap server.
mpirsh	String		Path to rsh or ssh.
paramfilename	on | index	on	Add parameter names and values or shorter indices to the filename.
rundir	String		The directory to store files used by the batch job.
savefile	on | off	off	Output model to file.
serverdir	String		Server directory.
specbatchdir	on | off		Specify different directory for batch process than used by the current process.
specserverdir	on | off	off	Specify server directory path.
synchaccumprobetable	on | off	on	Synchronize accumulated probe table.
synchsolutions	on | off	off	Synchronize solutions.

Table 6-90: Properties for Remote and Cloud Access

Property	Value	Default	Description
filetransfercmd	none | scp | user	none	Command transfer file.
filetransferfromusercmd	String		Command to transfer files from remote location.
filetransfertousercmd	String		Command to transfer files to remote location.
remote	on | off		Run on remote server.
remotecmd	none | ssh | user		Command to use when invoking a command on a remote server.
remotehosts	String		List of remote hostnames.
remoteos	native | windows | linux		OS used on remote hosts.
remoteusercmd	String		Command to use when invoking a command on a remote server.
scpkey	String		SCP key file.
scppath	String		Directory where SCP resides.
scpuser	String		Username used by SCP.
scpusercmd	String		Command for copying files to remote location.
sshcmd	ssh | putty | user		SSH command.
sshkey	String		SSH key file.
sshpath	String		Directory where SSH resides.
sshporthost	String		Port host.
sshports	String		Ports that should be forwarded by SSH.
sshuser	String		Username used by SSH.

Table 6-91: 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.