.. _auto_simulation_add_include_file:

*ADD AN INCLUDE FILE FOR THE SIMULATION*
========================================

Attaches an include file to an existing simulation deck, applying optional node/element ID offsets and mass, time, and length scale factors along with an optional coordinate transformation. Use this worker when assembling a multi-include LS-DYNA or similar CAE simulation model from separate sub-deck files.

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

Tagged: ``deck_assembly``, ``include_file``, ``ls-dyna``, ``offset``, ``scale_factor``, ``simulation``, ``transformation``.

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
     - —
     - ✓
     - The target simulation to attach the include file to; select from available simulations via the remote lookup (required).
   * - Include File
     - include_file
     - file
     - —
     - ✓
     - The include sub-deck file (e.g., a .k or .inc LS-DYNA keyword file) to be added to the simulation (required).
   * - Offset Number
     - offset_number
     - scalar
     - 0
     - 
     - Integer ID offset applied to all entity IDs (nodes, elements, parts, etc.) within the include file; defaults to 0 (no offset).
   * - Mass Scale Factor
     - mass_scale_factor
     - scalar
     - 1
     - 
     - Multiplicative scale factor applied to all mass quantities in the include file; defaults to 1.0 (no scaling).
   * - Time Scale Factor
     - time_scale_factor
     - scalar
     - 1
     - 
     - Multiplicative scale factor applied to all time quantities in the include file; defaults to 1.0 (no scaling).
   * - Length Scale Factor
     - length_scale_factor
     - scalar
     - 1
     - 
     - Multiplicative scale factor applied to all length/coordinate quantities in the include file; defaults to 1.0 (no scaling).
   * - Transformation ID
     - transformation_id
     - scalar
     - 0
     - 
     - Integer ID referencing a pre-defined DEFINE_TRANSFORMATION card to reposition/rotate the include mesh; defaults to 0 (none).
   * - Transformation Text
     - transformation_text
     - text
     - —
     - 
     - Inline transformation definition text (e.g., DEFINE_TRANSFORMATION keywords) applied to the include file when no pre-existing transformation ID is used; leave blank if transformation_id is set.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Simulation Id
     - simulation_id
     - integer
     - The integer ID of the simulation to which the include file was successfully attached, enabling downstream workers to reference the updated simulation.

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

- cae.preprocessing.deck_authoring
- cae.preprocessing.scenario

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