.. _auto_simulation_overview:

*GET SIMULATION OVERVIEW*
=========================

Returns a structured summary of an LS-DYNA simulation including metadata, model information (parts, elements, contacts), timing details, status, and issue counts. Use this as a first step to understand a simulation's overall state before diving into detailed diagnostics.

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

Tagged: ``agent_tool``, ``issues``, ``llm_tool``, ``ls-dyna``, ``metadata``, ``model_summary``, ``simulation_overview``, ``status``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Simulation Id
     - simulation_id
     - remote_lookup
     - —
     - ✓
     - Unique platform identifier of the LS-DYNA simulation to inspect; resolved via remote lookup against the simulations data type — required, no default.
   * - Output Format
     - format
     - select
     - markdown
     - 
     - Output serialization format: 'markdown' (default) renders a human-readable table layout suitable for LLM consumption, 'json' returns the raw structured data object.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Simulation Overview
     - overview
     - text
     - Structured simulation summary in the requested format, covering basic metadata (ID, name, status, solver, creation date), model counts (parts, elements, nodes, contacts, materials, rigid bodies), timing metrics (simulation time, wall-clock time, CPU time), termination status with error/warning counts, and guidance on next diagnostic steps.

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

- ai_ml.agents
- ai_ml.llm
- 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>simulation_overview</code>. Schema hash: <code>7fbc13e27b91</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>