.. _auto_simulation_get_parameters:

*GET PARAMETERS FROM A SIMULATION*
==================================

Extracts LS-DYNA *PARAMETER cards from a simulation's keyword file(s). With scope=main (default) reads only the main K file; with scope=all reads the main file and all include/attachment files, deduplicates by name (main-file-wins), appends a source_file column, and surfaces any duplicate parameters found. Use this worker to inventory or feed design-exploration pipelines with named LS-DYNA parameters.

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

Tagged: ``dedup``, ``doe-prep``, ``include``, ``k-file``, ``keyword``, ``ls-dyna``, ``multi-file``, ``parameter-extraction``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Simulation
     - simulation_id
     - remote_lookup
     - —
     - ✓
     - The simulation record to interrogate; must resolve to an LS-DYNA simulation with at least one keyword (K/key) file attached.
   * - Scope
     - scope
     - select
     - main
     - 
     - Controls which files are parsed: 'main' (default) reads only the primary K file for a fast, legacy-compatible extract; 'all' traverses all include/attachment files, deduplicates, and is recommended for multi-file simulations.
   * - Format
     - format
     - select
     - short
     - 
     - Field-width interpretation for *PARAMETER card parsing: 'short' (10-character fields, default), 'long' (20-character fields), or 'auto' to infer from the *KEYWORD SIZE option in the deck.
   * - Constants
     - constants
     - scalar
     - —
     - 
     - Comma-separated list of parameter names that should be treated as fixed constants — no min/max/step range will be computed for them; only applied when scope=all.
   * - Min Percentage
     - min_percentage
     - scalar
     - 50
     - 
     - Percentage (integer, default 50) subtracted from each parameter's default value to derive its lower bound; only applied when scope=all.
   * - Max Percentage
     - max_percentage
     - scalar
     - 50
     - 
     - Percentage (integer, default 50) added to each parameter's default value to derive its upper bound; only applied when scope=all.
   * - Step Percentage
     - step_percentage
     - scalar
     - 20
     - 
     - Step size expressed as a percentage of the parameter's default value (integer, default 20) used to define DOE sampling increments; only applied when scope=all.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Simulation
     - simulation
     - integer
     - Pass-through reference to the input simulation record (integer ID), useful for wiring downstream workers.
   * - Parameters
     - parameters
     - dataset
     - Dataset of extracted *PARAMETER entries with columns for name, value/default, type, and (when scope=all) source_file, min, max, and step; one row per unique parameter.
   * - Duplicate Parameter Details (scope=all only)
     - duplicates
     - dataset
     - Dataset listing every parameter name that appeared in more than one file, with the winning value (from the main file) and the conflicting values; populated only when scope=all.
   * - Files Parsed (scope=all only)
     - files_parsed
     - dataset
     - Dataset enumerating every K/include file that was opened and parsed during extraction, including file path and parameter count; populated only when scope=all.
   * - Status
     - status
     - string
     - Human-readable status string ('success', 'warning', or an error message) summarising the outcome of the extraction run.

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

- cae.postprocessing.extraction
- cae.preprocessing.deck_authoring
- design_exploration.doe

.. 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_get_parameters</code>. Schema hash: <code>05ab9289df4f</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>