Cluster Computing
Use the Cluster Computing study step when you want to submit COMSOL Multiphysics batch jobs to a job scheduler that in turn runs the batch job on a second computer or cluster.
The functionality described in this section requires a Floating Network License (FNL).
Syntax
model.study(stdname).create(fname, "ClusterComputing");
model.study(stdname).feature(fname).set(pname,value);
Description
Study step.
The following properties are available.
Table 6-108: Properties for Cluster Computing 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.
batchlic
on | off
 
Use batch license.
clustertype
general | whpc2008 | sge | slurm | pbs | lsf | none
 
The type of cluster job.
extsolvergen
on | off
off
Generate solver sequence in external process.
hostfile
String
 
Path to host file.
mpiargs
String
 
Additional MPI arguments.
mpibootstrap
String
 
Name of bootstrap server.
mpipath
String
 
Installation directory for MPI.
nn
Integer
1
Number of nodes.
rundir
String
 
The directory to store files used by the batch job.
schedargs
String
 
Additional scheduler arguments
scheduler
String
 
The scheduler for the batch job, if clustertype is whpc2008, slurm, or pbs, or lsf.
serverdir
String
 
Server directory.
sgequeue
String
 
The name for the cluster queue, if clustertype is sge, slurm, pbs, or lsf.
specbatchdir
on | off
 
Specify different directory for batch process than used by the current process.
specserverdir
on | off
off
Specify server directory path.
user
String
 
User account for submitting the job if clustertype is whpc2008, slurm, pbs, or lsf.
Table 6-109: Property for Cluster Settings.
Property
Value
Default
Description
pdistrib
on | off
off
Distribute parametric sweep.
Table 6-110: Properties for Remote and Cloud Access.
Property
Value
Default
Description
filecmd
String
 
File for commands when remotecmd is file.
filetransfercmd
none | scp | file | user
none
Command transfer file.
filetransferfrom
String
 
List of files to transfer from the other computer after the batch jobs have finished.
filetransferfromusercmd
String
 
Command to transfer files from remote location.
filetransferto
String
 
List of files to transfer to the other computer before running the batch job.
filetransfertousercmd
String
 
Command to transfer files to remote location.
remote
on | off
 
Run on remote server.
remotecmd
none | ssh | file | mpi | user
 
Command to use when invoking a command on a remote server.
remotehosts
String
 
List of remote hostnames.
remoteos
native | windows | linux
 
Command transfer file.
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-111: 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.