run_simulation
Start a Kratos simulation as a background job and return its job_id, with optional wait, analysis type/class, MPI ranks, and OMP threads.
Instructions
Start a Kratos simulation as a background job and return its job_id. The analysis class is taken from the 'analysis_stage' key in the parameters, or inferred from solver_type; override with analysis_type (structural/fluid/thermal/potential_flow) or analysis_class ('module.path:ClassName'). If wait_seconds > 0, poll up to that long and return the final status if the job finishes in time. Track progress with job_status/job_logs.
mpi_ranks launches the case under an MPI launcher (mpiexec/mpirun, or KRATOS_MPI_LAUNCHER) with that many ranks; the case must set problem_data.parallel_type to "MPI" and the build must have MPI support, otherwise the call fails before any job is created. Rank 0 logs to the job log; other ranks to job_logs(rank=N). omp_threads sets OMP_NUM_THREADS/MKL_NUM_THREADS. Not supported for multi-stage cases, checkpoints or studies.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| isolate | No | ||
| case_dir | Yes | ||
| mpi_ranks | No | ||
| omp_threads | No | ||
| wait_seconds | No | ||
| analysis_type | No | ||
| analysis_class | No | ||
| external_inputs | No | ||
| parameters_file | No | ProjectParameters.json |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||