COMSOL 6.2 - model.batch()

model.batch().create(<tag>,jobtype); creates a batch job tagged <tag> of type jobtype, where jobtype is Parametric, Batch, or Cluster.

model.batch().remove(<tag>) removes a batch job.

model.batch().size() returns number of batch jobs.

model.batch().tags() returns the tags of the batch jobs.

model.batch(<tag>).attach(<stag>) attaches a batch job with tag <tag> to a study with tag <stag>, which makes it visible under that study.

model.batch(<tag>).create(<jtag>,<oper>) creates a batch job sequence.

model.batch(<tag>).detach(<stag>) detaches a batch job from a study with tag <stag>.

model.batch(<tag>).remove(<ttag>) removes the task.

model.batch(<tag>).run() runs the batch job. The run method can take an additional boolean input argument createPlots, which, when set to true, generates the corresponding default plots when computing a solution.

model.batch(<tag>).set(jprop,<jvalue>) sets the property jprop to the value <jvalue>.

model.batch(<tag>).study(<stag>) assigns a batch job to a study tag <stag>.

model.batch(<tag>).study() returns the study tag of batch job with tag <tag>.

model.batch(<tag>).feature(<ttag>)).getAllowedPropertyValues(property) returns the set of allowed values for a property if the set is a finite set of strings; otherwise, it returns null.

Batch Job Properties

The Parametric job type has the following properties:


Property	Value	Default	Description
accumtable	String	new	Accumulated probe table.
accumtableall	on \| off	off	Use all probes for the accumulated probe table.
control	String	user	Controlling study.
param	String array		Name of parameter and its value (output).
pdistrib	on \| off	off	Distributed (in parallel) the parameter values.
pname	String array		Parameter name(s) to vary.
plist	String array		Parameter values.
plot	on \| off	off	Update a plot group while solving.
plotgroup	String	default	Update this plot group while solving.
pwork	int	1	Limit for the number of work groups.
pworkactive	on \| off	off	Use a limit for the number of work groups.
stopcond	String		A stop condition expression.
err	on \| off	off	Stop sweep if error.
error	String array		The logged error.
errignore	true \| false	false	Allow the sequence to continue even if an error is encountered.
useaccumtable	on \| off	off	Produce an accumulated probe table while solving.

The Optimization job type sets its property through the Optimization study node, which has the following properties:


Property	Value	Default	Description
optobj	String		Objective function to be optimized.
descr	String		Description of optimization objective function.
objectivetype	minimization \| maximization	minimization	Sets whether the objective should be minimized or maximized.
objectivesolution	auto \| first \| last \| sum \| min \| max	auto	Determines how the objective should be evaluated for studies with more than one available PDE solution, for example, time-dependent problems.
pname	String array		Names of control parameters.
initval	String array		Initial values for control parameters.
lbound	String array		Lower bounds on control parameters.
ubound	String array		Upper bounds on control parameters.
optsolver	coordsearch \| montecarlo \| neldermead \| bobyqa	neldermead	Optimization solver.
useseed	on \| off	off	Use random seed for Monte Carlo solver.
randseed	int	0	Random seed for Monte Carlo solver.
nsolvemax	int	1000	Maximum number of objective evaluations.
opttol	double	1e-2	Optimization tolerance.
useobjtable	on \| off	off	Produce a table with all objective evaluations.
objtable	String	new	Reference to table with objective evaluations.
convinfo	off \| on \| detailed	on	Detail of log messages from optimization solver.

The Batch job type has the following properties:


Property	Value	Default	Description
control	String	user	Name of controlling study.
np	integer	auto	Number of cores to use.
graphics	on \| off	off	Enable graphics.
maxallow	integer	1	Maximum allowed number of batch jobs to start simultaneously.
maxrestart	integer	0	Maximum number of restarts before a batch job is failed.
maxalive	integer	300	Maximum number of seconds before the batch job must say it is running.
starttime	now \| 0 \| 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10 \| 11 \| 12 \| 13 \| 14 \| 15 \| 16 \| 17 \| 18 \| 19 \| 20 \| 21 \| 22 \| 23	now	The time, as an hour for a 24-hour clock, when the batch job should start.
batchdir	String	Home directory	The directory to store files used by the batch job.
client	on \| off	off	Run the batch job as client.
port	integer	2036	The host port number.
host	String	localhost	Name of host.
batchfile	String	batchmodel.mph	Name of batch model file.
clear	on \| off	on	Clear the previous model file.
clearmesh	on \| off	off	Clear meshes before saving model.
clearsolution	on \| off	off	Clear solutions before saving model.
savefile	on \| off	on	Save model after run.
specbatchdir	on \| off	off	Specify different directory for batch process than used by the current process.
rundir	String	Home directory	The directory used by the batch job when specbatchdir is on.
speccomsoldir	on \| off	off	Specify different directory for the COMSOL installation than used by the current process.
comsoldir	String	COMSOL installation directory	The COMSOL installation directory used by the batch job when speccomsoldir is on.
synchsolutions	on \| off	off	Synchronize solutions after batch job finishes.
synchaccumprobetable	on \| off	off	Synchronize accumulated probe tables after batch job finishes.
probesel	all \| none \| manual	all	The probes to compute.
probes	String array		Probes to compute.
useaccumtable	on \| off	off	Use the accumulated probe table.
accumtable	String	new	Name of table to use.
accumtableall	on \| off	on	Use all probes.
client	on \| off	off	Run as client.
host	String	localhost	Name of server.
port	integer		Server port number.

The Cluster job type has the following properties:


Property	Value	Default	Description
batch	String		Tag of batch job to run.
clustertype	general \| whpc2008 \| wccs2003 \| sge \| slurm \| none	general	The type of cluster job.
control	String	user	Name of controlling study.
corespernode	integer	0	Minimum number of cores per node on whpc2008.
exclusive	on \| off	on	Demand exclusive right to nodes on whpc2008 and SLURM.
filetransfercmd	none \| scp \| user	none	Command to transfer files.
filetransferfromusercmd	String		Command to transfer files from remote location.
filetransfertousercmd	String		Command to transfer files to remote location.
hostfile	String		Path to hostfile.
memorypernode	integer	0	Minimum amount of memory per node on whpc2008 and SLURM.
mpd	on \| off	off	If an mpd is running on the computer or not.
mpiargs	String		Additional MPI arguments.
mpibootstrap	String		Name of bootstrap server.
mpirsh	String		Path to rsh or ssh.
nn	integer	1	Number of processes to start.
nodegran	node \| socket\| core	node	Node granularity on whpc2008.
nodegroup	String		Name of Named selection of Compute nodes in whpc2008.
perhost	integer	1	Number of processes / host.
postcmd	String		DOS/Linux command to execute after the batch job finished.
precmd	String		DOS/Linux command to execute prior to the batch job.
priority	Highest \| AboveNormal \| Normal \| BelowNormal \| Lowest	Normal	Priority of job on wccs2003 and whpc2008.
remote	on \| off	off	Run on remote server.
remotecmd	none \| ssh \| user	none	Command to use when invoking a command on a remote server.
remotehosts	String		List of remote hostnames.
remoteos	native \| windows \| linux	native	OS used on remote hosts.
remoteusercmd	String		Command to run on remote server.
reqnodes	String array		Requested nodes on wccs2003, whpc2008, and SLURM.
runtime	DD:HH:MM \| Infinite	Infinite	Maximum time to run before stopping on wccs2003, whpc2008, and SLURM.
schedargs	String		Additional scheduler arguments.
scheduler	String	localhost	Name of the scheduler on wccs2003, whpc2008, and SLURM.
scpargs	String		Additional SCP arguments.
scpcmd	scp \| putty \| user	scp	SCP command.
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.
sgegran	host \| slot \| manual	host	Node granularity on SGE.
sgenn	integer	1	Number of slots in SGE.
sgepriority	integer	0	Priority of job on SGE and SLURM.
sgequeue	String		Name of SGE and SLURM queue.
sshargs	String		Additional SSH arguments.
sshcmd	ssh \| putty \| user	ssh	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.
sshusercmd	String		User-defined SSH command.
user	String		Username on wccs2003, whpc2008, and SLURM.

Tasks

model.batch(<tag>).create(<ttag>,tasktype); creates a task of type tasktype tagged <ttag>. Find options for tasktype in Table 2-5 below.

Table 2-5: Batch Task Type Options.
task type	Description
Geomseq	A geometry sequence to build.
Meshseq	A meshing sequence to build.
Solutionseq	A solver sequence to compute.
Jobseq	A job sequence to run.
Postseq	A post sequence to run.
Evalnumericalseq	A numerical results seq (derived value) to run (replaced Numericalseq).
Numericalseq	A numerical results seq to run (deprecated).
Exportseq	An export sequence to run.
Save	Saves the state of the model at this point in the job sequence.
Class	Runs the main function of a compiled class with the system property cs.currentmodel set to the name of the model calling the class.
Data	Created by batch jobs to store external process information.

Task Type Properties

model.batch(<tag>).feature(<ttag>).set(ttprop,<tpvalue>) sets the task type property ttprop to the value <tpvalue>.

Task type properties can have the values listed in Table 2-6.

Table 2-6: Task Type Property values.
Property	Value	Default	Description
clear	on \| off	on	Clear the currently stored data.
filename	String		Name of file to store or open.
openfile	String array	none	Name of file that was saved.
param	String array		Name of parameter and its value.
files	String array		Name of files for each parameter.
input	String array		Input to class file.
seq	String	all	Name of sequence to run.
num	String array		Name of numerical result feature that generated value.
paramvalue	String array		Computed numerical result.
store	on \| off	off	Copy solution.
psol	String	none	Tag of solver sequence where solutions are stored.

The Data Task Type

The Data task type contains child nodes with process information of type Process; see Table 2-7.

Table 2-7: Data Child nodes.
tasktype	Description
Process	Contains information about running processes.

model.batch(<tag>).feature(<ttag>).feature(<ptag>).set(ptype,<pvalue>) sets the property ptype to the value <pvalue>. ptype can have the values listed in Table 2-8

Table 2-8: ptype Property Values.
Property	Value	Default	Description
cmd	String		The command that started the external process.
filename	String		Name of file where model is stored.
operation	update \| progress \| cancel \| stop \| clear \| rerun	update	Name of operation to perform on the process.
status	String		Current status of the process.