.. _auto_lsdyna_binout_extract_matrix:

*LSDYNA BINOUT EXTRACT MATRIX*
==============================

Reads a single LS-DYNA binout branch (matsum, secforc, rwforc/wall*, swforc, abstat, sbtout, ...) in one pass and returns the dense {ids x times} matrix for the requested components. Replaces N-per-id round trips through the bulk extractor with a single C-side walk. Supports magnitude (sqrt(x^2+y^2+z^2)) computed in C when -mag is set. Drives the BINOUT Explorer Wall Force Visualizer and is reusable from any analyzer that needs per-id curves matricized.

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

Tagged: ``abstat``, ``binout``, ``bulk``, ``extract``, ``lsdyna``, ``matrix``, ``matsum``, ``rwforc``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Simulation
     - simulation_id
     - remote_lookup
     - —
     - 
     - Reference to the LS-DYNA simulation whose binout will be read.
   * - Branch
     - branch
     - string
     - matsum
     - 
     - Binout branch path. Examples: matsum, secforc, swforc, rwforc/wall001, abstat, sbtout.
   * - Components
     - components
     - string
     - —
     - 
     - Comma-separated component list (e.g. internal_energy or x_force,y_force,z_force). Empty = auto-discover all numeric components for the branch.
   * - IDs
     - ids
     - string
     - —
     - 
     - Comma-separated id whitelist. Empty = all ids in the branch's metadata.
   * - Magnitude
     - magnitude
     - string
     - no
     - 
     - When yes, compute sqrt(x_force^2 + y_force^2 + z_force^2) in C and return as 'magnitude' instead of the raw vector components.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Branch
     - branch
     - string
     - Echoed branch path.
   * - Components
     - components
     - dataset
     - Component names whose values are interleaved in the matrix.
   * - IDs
     - ids
     - dataset
     - Row order of the matrix.
   * - Times
     - times
     - dataset
     - Column order of the matrix.
   * - Matrix (rows=ids, cols=steps)
     - matrix
     - dataset
     - Dense float matrix, ids x times. When multiple components are returned, rows are interleaved per id.
   * - Matrix Summary
     - matrix_summary
     - dataset
     - Per-branch summary: min, max, peak_id, peak_step.
   * - Summary
     - summary
     - string
     - One-line human-readable summary.

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

- cae.postprocessing.extraction
- cae.postprocessing.response

.. raw:: html

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