Apply formatting to stress-strain plots

Author: robbievanleeuwen

docs/examples/moment_curvature.ipynb

@@ -33,7 +33,7 @@
     "    SteelBar,\n",
     "    add_bar_rectangular_array,\n",
     ")\n",
-    "from concreteproperties.post import si_kn_m\n",
+    "from concreteproperties.post import si_kn_m, si_n_mm\n",
     "from concreteproperties.results import MomentCurvatureResults"
    ]
   },
@@ -141,7 +141,9 @@
    "outputs": [],
    "source": [
     "for conc in conc_material_list:\n",
-    "    conc.stress_strain_profile.plot_stress_strain(title=conc.name)"
+    "    conc.stress_strain_profile.plot_stress_strain(\n",
+    "        title=conc.name, eng=True, units=si_n_mm\n",
+    "    )"
    ]
   },
   {
@@ -151,7 +153,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "steel.stress_strain_profile.plot_stress_strain(title=steel.name)"
+    "steel.stress_strain_profile.plot_stress_strain(\n",
+    "    title=steel.name, eng=True, units=si_n_mm\n",
+    ")"
    ]
   },
   {

docs/examples/prestressed_section.ipynb

@@ -141,8 +141,10 @@
    "outputs": [],
    "source": [
     "# combine both stress-strain profiles on the same plot\n",
-    "ax = concrete_service.stress_strain_profile.plot_stress_strain(render=False)\n",
-    "concrete_service.ultimate_stress_strain_profile.plot_stress_strain(ax=ax)\n",
+    "ax = concrete_service.stress_strain_profile.plot_stress_strain(\n",
+    "    units=si_n_mm, render=False\n",
+    ")\n",
+    "concrete_service.ultimate_stress_strain_profile.plot_stress_strain(units=si_n_mm, ax=ax)\n",
     "ax.lines[0].set_label(\"Service\")\n",
     "ax.lines[1].set_label(\"Ultimate\")\n",
     "ax.legend(loc=\"center left\", bbox_to_anchor=(1, 0.5))\n",
@@ -158,8 +160,10 @@
    "outputs": [],
    "source": [
     "# combine both stress-strain profiles on the same plot\n",
-    "ax = strand_service.stress_strain_profile.plot_stress_strain(render=False)\n",
-    "strand_ultimate.stress_strain_profile.plot_stress_strain(ax=ax)\n",
+    "ax = strand_service.stress_strain_profile.plot_stress_strain(\n",
+    "    eng=True, units=si_kn_m, render=False\n",
+    ")\n",
+    "strand_ultimate.stress_strain_profile.plot_stress_strain(eng=True, units=si_kn_m, ax=ax)\n",
     "ax.lines[0].set_label(\"Service\")\n",
     "ax.lines[1].set_label(\"Ultimate\")\n",
     "ax.legend(loc=\"center left\", bbox_to_anchor=(1, 0.5))\n",

src/concreteproperties/stress_strain_profile.py

@@ -8,12 +8,17 @@
 
 import matplotlib.pyplot as plt
 import numpy as np
+from matplotlib.ticker import FuncFormatter
 from rich.console import Console
 from rich.table import Table
 from scipy.interpolate import interp1d
 from scipy.optimize import brentq
 
-from concreteproperties.post import plotting_context
+from concreteproperties.post import (
+    UnitDisplay,
+    plotting_context,
+    string_formatter_plots,
+)
 
 if TYPE_CHECKING:
     import matplotlib.axes
@@ -214,27 +219,55 @@ def plot_stress_strain(
         self,
         title: str = "Stress-Strain Profile",
         fmt: str = "o-",
+        eng: bool = False,
+        prec: int = 2,
+        units: UnitDisplay | None = None,
         **kwargs,
     ) -> matplotlib.axes.Axes:
         """Plots the stress-strain profile.
 
         Args:
             title: Plot title. Defaults to ``"Stress-Strain Profile"``.
             fmt: Plot format string. Defaults to ``"o-"``.
+            eng: If set to ``True``, formats the plot ticks with engineering notation.
+                If set to ``False``, uses the default ``matplotlib`` ticker formatting.
+                Defaults to ``False``.
+            prec: If ``eng=True``, sets the desired precision of the ticker formatting
+                (i.e. one plus this value is the desired number of digits). Defaults to
+                ``2``.
+            units: Unit system to display. Defaults to ``None``.
             kwargs: Passed to :func:`~concreteproperties.post.plotting_context`
 
         Returns:
             Matplotlib axes object
         """
+        # assign default unit if no units applied
+        if units is None:
+            units = UnitDisplay("", "", "")
+            stress_unit = "-"
+        else:
+            stress_unit = units.stress_unit[1:]
+
         # create plot and setup the plot
         with plotting_context(title=title, **kwargs) as (_, ax):
             if ax is None:
                 msg = "Plot failed."
                 raise RuntimeError(msg)
 
-            ax.plot(self.strains, self.stresses, fmt)
-            plt.xlabel("Strain")
-            plt.ylabel("Stress")
+            # scale stresses
+            stresses = np.array(self.stresses) * units.stress_scale
+
+            ax.plot(self.strains, stresses, fmt)
+
+            if eng:
+                tick_formatter = FuncFormatter(
+                    lambda x, _: string_formatter_plots(value=x, prec=prec)
+                )
+                ax.xaxis.set_major_formatter(tick_formatter)
+                ax.yaxis.set_major_formatter(tick_formatter)
+
+            plt.xlabel("Strain [-]")
+            plt.ylabel(f"Stress [{stress_unit}]")
             plt.grid(True)
 
         return ax