.. _auto_simulation_clone:

*CLONE SIMULATION FROM EXISTING SIMULATION*
===========================================

Clones an existing simulation into a new simulation record, copying input files, LS-DYNA *INCLUDE dependencies, and optionally result files. Supports three clone modes: input files only (recommended, snapshots includes and strips *INCLUDE_PATH), main file only (legacy), or everything (inputs + results).

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

Tagged: ``clone``, ``duplicate``, ``include``, ``lsdyna``, ``simulation``, ``snapshot``, ``workflow``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Parent Simulation
     - input_sim_id
     - remote_lookup
     - —
     - ✓
     - ID of the parent simulation to clone; selected via remote lookup against the simulations registry — required, no default.
   * - New Name for the Cloned Simulation
     - new_name
     - text
     - —
     - ✓
     - Human-readable name for the newly created cloned simulation; defaults to 'Cloned_Simulation_<timestamp>' if left blank.
   * - Clone Mode
     - clone_mode
     - select
     - input_files_only
     - 
     - Controls which files are copied: 'input_files_only' (main file + snapshotted *INCLUDE files, no results — recommended default), 'main_file_only' (legacy, main file only), or 'everything' (input files + result files); defaults to 'input_files_only'.
   * - Copy Result Files (legacy)
     - with_results
     - select
     - no
     - 
     - Legacy hidden flag; 'yes' maps to clone_mode='everything', 'no' falls back to clone_mode value — leave at default 'no' unless migrating old workflows.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Parent Simulation
     - parent_simulation_id
     - integer
     - Integer ID of the original (source) simulation that was cloned, with its name as the label.
   * - Cloned Simulation
     - simulation_id
     - integer
     - Integer ID of the newly created cloned simulation; pass to downstream workers that require a simulation reference.
   * - Clone Mode Used
     - clone_mode
     - string
     - The clone mode string actually used during execution (e.g. 'input_files_only'), reflecting legacy mapping if with_results was supplied.
   * - Include Files Snapshotted
     - include_files_snapshotted
     - dataset
     - Dataset of LS-DYNA *INCLUDE files successfully resolved and copied to the clone, each row containing filename, source_path, attachment_id, and keyword; populated only in 'input_files_only' mode.
   * - Include File Warnings
     - include_warnings
     - dataset
     - Dataset of *INCLUDE entries that could not be resolved or saved (rows contain filename, keyword, searched_paths, and reason); non-empty rows indicate missing or unreadable include files.
   * - Status
     - status
     - string
     - Human-readable summary string reporting source → clone ID mapping, clone mode used, number of snapshotted includes, and any warning count.

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

- cae.preprocessing.deck_authoring
- 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>simulation_clone</code>. Schema hash: <code>50fba8458586</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>