.. _auto_simulation_get_include_file_structure:

*GET INCLUDE FILE STRUCTURE*
============================

Parses an LS-DYNA main input (keyword) file for a given simulation and computes its full *INCLUDE hierarchy. Use this worker to visualise or audit the nested include-file structure of a deck before pre-processing or solver submission.

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

Tagged: ``deck_structure``, ``include_file``, ``include_hierarchy``, ``keyword_parser``, ``lsdyna``, ``simulation``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Choose Simulation
     - simulation_id
     - remote_lookup
     - —
     - ✓
     - Integer ID of the simulation whose main LS-DYNA input file will be parsed; select from the remote simulation registry — required, no default.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Simulation
     - simulation_id
     - integer
     - Resolved integer ID of the simulation that was processed, passed downstream for chaining with other simulation-aware workers.
   * - Tree
     - tree
     - tree
     - Hierarchical tree structure representing the nested *INCLUDE file relationships discovered in the main input deck; each node is a file path relative to the deck root.

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

- cae.preprocessing.deck_authoring
- cae.preprocessing.setup

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