Simulink.Simulation.Job class
Package: Simulink
Superclasses:
Description
Execute batchsim
command with a parallel pool to create a
Simulink.Simulation.Job
object. The batchsim
command
offloads multiple simulations to run in batch using the inputs specified with an array of
Simulink.SimulationInput
objects. You can use this object to monitor the
status of a batch job, fetch outputs of a completed batch job, or cancel one or more
jobs.
The batchsim
command uses the Parallel Computing Toolbox™ license to
run the simulations on compute cluster. If a parallel pool cannot be created
batchsim
runs the simulations in serial. In the absence of Parallel Computing Toolbox™ license, batchsim
errors out.
Construction
creates a simJob
= batchsim(in
)Simulink.Simulation.Job
object, simJob
, while
running multiple simulations in batches on a compute cluster using the inputs specified in the
Simulink.SimulationInput
object,
in
.
createSimulationJob(
creates a
batchJob
)Simulink.Simulation.Job
object from a parallel.job
object,
batchJob
. Use the createSimulationJob
command to
retrieve the job object returned by the batchsim
command.
Input Arguments
Properties
Methods
Method | Purpose |
---|---|
Cancel a pending, queued, or running Simulink.Simulation.Job
object | |
Display or save Command Window text of batch job | |
Retrieve an array of Simulink.SimulationOutput objects from
all simulations in Simulink.Simulation.Job | |
List of files automatically attached to job, task, or parallel pool | |
Wait for Simulink.Simulation.Job object to change
state |
Examples
Version History
Introduced in R2018b
See Also
Functions
parsim
|batchsim
|cancel
|diary
|fetchOutputs
|listAutoAttachedFiles
|wait
|parcluster
(Parallel Computing Toolbox) |getSimulationJobs
Classes
Simulink.SimulationInput
|parallel.Cluster
(Parallel Computing Toolbox)
Topics
- Comparison Between Multiple Simulation Workflows
- Job Monitor (Parallel Computing Toolbox)
- Batch Processing (Parallel Computing Toolbox)