.. _auto_binout_user_extractor:

*BINOUT USER EXTRACTOR*
=======================

Extracts user-specified time-history channels from LS-DYNA binout files associated with one or more simulations and returns the result as a named vector response. Accepts a comma-separated list of components and optional ID/label pairs to target specific entities (nodes, parts, beams, shells, solids). Optionally auto-saves the extracted response back to the simulation record.

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

Tagged: ``binout``, ``binout2xml``, ``dyna_binout``, ``extraction``, ``ls-dyna``, ``response``, ``simlyzer``, ``time-history``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Response Name
     - response_name
     - text
     - —
     - ✓
     - User-defined label assigned to the extracted response; this name is used to identify the vector in the output and, when auto-save is enabled, in the saved response record.
   * - Simulation
     - simulation_id
     - remote_lookup
     - —
     - ✓
     - Reference to one or more simulations (remote lookup); the binout files are resolved from the source directory of the selected simulation(s).
   * - Specify File
     - binout_file
     - textarea
     - —
     - ✓
     - Path or filename of the binout file to read, relative to the simulation source directory (e.g. 'binout0000'); must match an entry in the binout source map.
   * - Specify Components
     - binout_components
     - textarea
     - —
     - ✓
     - Comma-separated list of binout channel components to extract (e.g. 'nodout,x_displacement'); at least one component is required.
   * - Specify Ids
     - binout_ids
     - textarea
     - —
     - 
     - Optional comma- (or space-) separated list of entity IDs to filter the extraction; use 'id:label' colon syntax to assign a legend name to each ID (e.g. '1001:Pillar,1002:Rocker').
   * - Auto Save
     - auto_save
     - select
     - no
     - 
     - When set to 'yes', the extracted response is persisted to the simulation record in the platform database; defaults to 'no'.
   * - Force Reextract
     - force_extract
     - select
     - no
     - 
     - When set to 'yes', forces re-extraction even if a cached result already exists for this response; defaults to 'no'.
   * - Binout ID Format
     - binout_id_format
     - select
     - comma
     - 
     - Delimiter format used to parse the binout_ids field; choose 'comma' (default) or 'space' for simple lists, or an LS-DYNA set keyword ('*SET_NODE_LIST', '*SET_PART_LIST', etc.) to return the unique set of matched entity IDs in that keyword format.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Binout Output
     - binout_output
     - vector
     - Extracted time-history data as a named vector (time vs. value array) corresponding to the requested response_name, components, and IDs.
   * - Logs
     - binout_logs
     - dataset
     - Dataset containing diagnostic and extraction log messages produced by the Simlyzer/BinoutExtractor pipeline.
   * - Responses
     - responses
     - dataset
     - Dataset of response records associated with the simulation after extraction, reflecting any saved or previously existing responses.
   * - Status
     - status
     - text
     - Plain-text status message summarising success (including file, components, and IDs extracted) or describing the failure reason with available alternatives.

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

- cae.postprocessing.extraction

.. raw:: html

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