.. _auto_nastran_punch_extractor:

*NASTRAN PUNCH EXTRACTOR*
=========================

Parses a Nastran punch (.pch) file — supplied directly or retrieved from a platform simulation — and extracts either a tabular summary or a time-history response vector for a specified subcase, entity, and component. Use this worker whenever Nastran frequency-response or modal results stored in PCH format need to be ingested into a d3VIEW workflow.

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

Tagged: ``extraction``, ``frequency_response``, ``modal``, ``nastran``, ``pch``, ``punch``, ``simulation``, ``subcase``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Punch File
     - punch_file
     - file
     - —
     - 
     - The Nastran .pch punch file to parse; provide this directly when the file is available locally — leave null if supplying a simulation_id instead.
   * - Simulation
     - simulation_id
     - remote_lookup
     - —
     - 
     - Platform simulation record whose associated punch file should be used; leave unset when a direct punch_file upload is provided.
   * - Extraction Type
     - extraction_type
     - select
     - summary
     - ✓
     - Controls what is extracted: 'summary' returns a full tabular overview of all results, while 'time_history' extracts a single response vector for the specified subcase/entity/component — required, defaults to 'summary'.
   * - Response Name
     - response_name
     - scalar
     - —
     - 
     - Label to assign to the extracted response when saving; only relevant when save_response is 'yes', otherwise leave null.
   * - Subcase ID
     - subcase_id
     - scalar
     - —
     - 
     - Nastran subcase ID to target (integer string); leave null to extract across all subcases or when using the 'summary' extraction type.
   * - Entity ID
     - entity_id
     - scalar
     - —
     - 
     - Grid-point or element ID whose result is to be extracted; required for 'time_history' mode, leave null for 'summary'.
   * - Entity Component
     - entity_component
     - scalar
     - —
     - 
     - Translational DOF component to extract — one of X-MAG Trans, Y-MAG Trans, or Z-MAG Trans; only applicable in 'time_history' mode.
   * - Save Response
     - save_response
     - select
     - no
     - ✓
     - Whether to persist the extracted time-history vector as a platform response object ('yes') or return it transiently ('no') — required, defaults to 'no'.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Simulation
     - sim_id
     - integer
     - Integer ID of the platform simulation record associated with the extracted punch file; populated when extraction is linked to a simulation.
   * - Summary
     - summary
     - dataset
     - Tabular dataset containing all result entries parsed from the punch file (subcases, entity IDs, components, values); populated when extraction_type is 'summary'.
   * - Saved Response
     - time_history
     - vector
     - Response vector (frequency vs. magnitude) for the selected subcase/entity/component; populated when extraction_type is 'time_history' and save_response is 'yes'.

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

- cae.postprocessing.extraction
- engineering.nvh
- engineering.structures

.. raw:: html

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