.. _auto_assembler_create_simulation_from_systemmodel:

*CREATE SIMULATION FROM SYSTEM MODEL*
=====================================

Creates a new simulation record by cloning a System Model, copying all associated files and the main input file (with optional overrides for file name and content). Optionally submits the newly created simulation to an HPC cluster immediately after creation if an HPC setting is provided.

When to use
-----------

Tagged: ``assembler``, ``clone``, ``hpc``, ``job_submission``, ``lsdyna``, ``simulation``, ``system_model``.

Inputs
------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20 20 20

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Systemmodel
     - systemmodel_id
     - remote_lookup
     - —
     - ✓
     - Remote lookup ID of the System Model to clone; all associated files and the main input file will be copied from this record.
   * - Simulation Name
     - input_sim_name
     - text
     - —
     - ✓
     - Human-readable name assigned to the newly created simulation record; required and must be unique within the project.
   * - Alternate Main Input File Name
     - alt_main_input_file_name
     - textarea
     - —
     - 
     - Optional override filename for the main input deck; if omitted, the filename defined on the System Model is used verbatim.
   * - Alternate Main Input File Content
     - alt_main_input_file_content
     - textarea
     - —
     - 
     - Optional override text content for the main input deck; if omitted, the file content from the System Model is used verbatim.
   * - Simulation Description
     - input_sim_desc
     - textarea
     - —
     - 
     - Optional free-text description attached to the new simulation record for documentation purposes.
   * - Simulation Tags
     - input_sim_tags
     - text
     - —
     - 
     - Optional comma-separated tags to classify the new simulation record, e.g. 'frontal,30ms,v2'.
   * - Template ID
     - template_id
     - remote_lookup
     - —
     - 
     - Optional remote lookup ID of a response/post-processing template to associate with the new simulation; leave null to inherit no template.
   * - Loadcase ID
     - loadcase_id
     - remote_lookup
     - —
     - 
     - Optional remote lookup ID of the load case to link to the new simulation; leave null if no specific load case is required.
   * - Solver Type
     - solver_type
     - string
     - lsdyna
     - 
     - Solver engine identifier for the simulation (default: 'lsdyna'); set to the appropriate solver string if using a non-LS-DYNA solver.
   * - Project ID
     - input_project_id
     - remote_lookup
     - —
     - 
     - Optional remote lookup ID of the project under which the new simulation will be created; leave null to place it in the default project.
   * - Responses
     - responses
     - vector
     - —
     - 
     - Optional repeating vector of response definitions (curve inputs) to attach to the simulation; leave null to inherit responses from the System Model or template.
   * - Test ID
     - physicaltest_id
     - remote_lookup
     - —
     - 
     - Optional remote lookup ID of a physical test record to correlate with the new simulation; leave null if no test correlation is needed.
   * - HPC Setting Name
     - hpcjob_setting
     - remote_lookup
     - —
     - 
     - Optional remote lookup ID of an HPC setting profile; when provided, the simulation is automatically submitted to the HPC queue immediately after creation.

Outputs
-------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20

   * - Label
     - ID
     - Type
     - Description
   * - New Simulation
     - simulation_id
     - integer
     - Integer ID of the newly created simulation record on the d3VIEW platform, usable as input to downstream solver or post-processing workers.
   * - HPC Job ID
     - hpcjob_id
     - integer
     - Integer ID of the HPC job spawned for this simulation; populated only when an HPC setting was supplied, null otherwise.

Disciplines
-----------

- cae.preprocessing.scenario
- platform.job_submission
- platform.workflow

.. raw:: html

   <hr style="margin-top:2em">
   <p style="font-size:11px;color:#888">
   Auto-generated from <code>platform</code> schema. Worker id: <code>assembler_create_simulation_from_systemmodel</code>. Schema hash: <code>944c43b5b29b</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>