.. _auto_curve_get_damage:

*GET AMOUNT OF DAMAGE*
======================

Analyses a stress-strain or force-displacement curve to quantify the amount of material damage. Given the input curve, it returns a user-selected damage metric such as the undamaged-to-damaged ratio, integral of the damage region, X/Y coordinates at damage onset or end, or partial integrals at 75 %, 50 %, or 25 % of the damage zone. Use this worker to extract scalar KPIs from post-necking or failure curve segments.

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

Classification: **process**.

Tagged: ``curve_damage``, ``damage``, ``damage_ratio``, ``failure_kpi``, ``integral``, ``material_damage``, ``post_necking``, ``stress_strain``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Curve
     - input_curve
     - vector
     - —
     - 
     - The input curve (e.g. force-displacement or stress-strain) whose damage region will be analysed; typically the raw or processed coupon response curve — leave empty only if the curve is piped implicitly from an upstream node.
   * - Value To Return
     - value_to_return
     - scalar
     - ratio
     - 
     - Selects which damage scalar to compute: 'ratio' (undamaged-to-damaged area ratio, default), 'integral' (full damage-zone area), 'damage_begin_x'/'damage_end_x' (X-axis coordinates of damage onset/end), 'damage_begin_y'/'damage_end_y' (Y-axis coordinates of damage onset/end), 'integral_75'/'integral_50'/'integral_25' (partial integrals using 75/50/25 % of the damage zone), or 'damage_bound_area' (bounded damage area); default is 'ratio'.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Damage
     - curve_get_damage_output_1
     - scalar
     - Scalar damage metric corresponding to the selected 'value_to_return' option (dimensionless ratio, area in curve units², or X/Y coordinate value); larger integral/ratio values indicate greater material damage.

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

- data.curve.transform
- data.statistics
- engineering.material.characterization
- engineering.material.failure

Runnable example
----------------

A runnable example is registered for this worker. Open the example workflow on the d3VIEW canvas: `/api/workflow/example?id=curve_get_damage <https://www.d3view.com/api/workflow/example?id=curve_get_damage>`_

.. raw:: html

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