pyvale 2025.4.0__py3-none-any.whl → 2025.5.1__py3-none-any.whl

pyvale/{core/sensorarraypoint.py → sensorarraypoint.py}

@@ -1,17 +1,16 @@
-"""
-================================================================================
-pyvale: the python validation engine
-License: MIT
-Copyright (C) 2025 The Computer Aided Validation Team
-================================================================================
-"""
+# ==============================================================================
+# pyvale: the python validation engine
+# License: MIT
+# Copyright (C) 2025 The Computer Aided Validation Team
+# ==============================================================================
+
 import numpy as np
-from pyvale.core.field import IField
-from pyvale.core.sensorarray import ISensorArray
-from pyvale.core.errorintegrator import ErrIntegrator
-from pyvale.core.sensordescriptor import SensorDescriptor
-from pyvale.core.sensordata import SensorData
-from pyvale.core.fieldsampler import sample_field_with_sensor_data
+from pyvale.field import IField
+from pyvale.sensorarray import ISensorArray
+from pyvale.errorintegrator import ErrIntegrator
+from pyvale.sensordescriptor import SensorDescriptor
+from pyvale.sensordata import SensorData
+from pyvale.fieldsampler import sample_field_with_sensor_data
 
 
 class SensorArrayPoint(ISensorArray):
@@ -53,16 +52,15 @@ class SensorArrayPoint(ISensorArray):
     simulated physical fields quickly using finite element shape functions.
     """
 
-    __slots__ = ("field","descriptor","sensor_data","_truth","_measurements",
-                 "error_integrator")
+    __slots__ = ("_field","_descriptor","_sensor_data","_truth","_measurements",
+                 "_error_integrator")
 
     def __init__(self,
                  sensor_data: SensorData,
                  field: IField,
                  descriptor: SensorDescriptor | None = None,
                  ) -> None:
-        """Initialiser for the `SensorArrayPoint` class.
-
+        """
         Parameters
         ----------
         sensor_data : SensorData
@@ -76,13 +74,13 @@ class SensorArrayPoint(ISensorArray):
             Contains descriptive information about the sensor array for display
             and visualisations, by default None.
         """
-        self.sensor_data = sensor_data
-        self.field = field
-        self.error_integrator = None
+        self._sensor_data = sensor_data
+        self._field = field
+        self._error_integrator = None
 
-        self.descriptor = SensorDescriptor()
+        self._descriptor = SensorDescriptor()
         if descriptor is not None:
-            self.descriptor = descriptor
+            self._descriptor = descriptor
 
         self._truth = None
         self._measurements = None
@@ -97,10 +95,10 @@ class SensorArrayPoint(ISensorArray):
         np.ndarray
             Sample times with shape: (num_time_steps,)
         """
-        if self.sensor_data.sample_times is None:
-            return self.field.get_time_steps()
+        if self._sensor_data.sample_times is None:
+            return self._field.get_time_steps()
 
-        return self.sensor_data.sample_times
+        return self._sensor_data.sample_times
 
     def get_measurement_shape(self) -> tuple[int,int,int]:
         """Gets the shape of the sensor measurement array. shape=(num_sensors,
@@ -113,8 +111,8 @@ class SensorArrayPoint(ISensorArray):
             num_field_components,num_time_steps)
         """
 
-        return (self.sensor_data.positions.shape[0],
-                len(self.field.get_all_components()),
+        return (self._sensor_data.positions.shape[0],
+                len(self._field.get_all_components()),
                 self.get_sample_times().shape[0])
 
     def get_field(self) -> IField:
@@ -126,7 +124,7 @@ class SensorArrayPoint(ISensorArray):
         IField
             Reference to an `IField` interface.
         """
-        return self.field
+        return self._field
 
 
     def calc_truth_values(self) -> np.ndarray:
@@ -140,8 +138,8 @@ class SensorArrayPoint(ISensorArray):
             Array of ground truth sensor values. shape=(num_sensors,
             num_field_components,num_time_steps).
         """
-        self._truth = sample_field_with_sensor_data(self.field,
-                                                    self.sensor_data)
+        self._truth = sample_field_with_sensor_data(self._field,
+                                                    self._sensor_data)
 
         return self._truth
 
@@ -171,7 +169,7 @@ class SensorArrayPoint(ISensorArray):
         err_int : ErrIntegrator
             Error integration object with a chain of user defined sensor errors.
         """
-        self.error_integrator = err_int
+        self._error_integrator = err_int
 
     def get_sensor_data_perturbed(self) -> SensorData | None:
         """Gets the final sensor array parameters after all errors in the error
@@ -184,10 +182,10 @@ class SensorArrayPoint(ISensorArray):
             The accumulated sensor array parameters as a SensorData object.
             Returns None if no error integrator has been specified.
         """
-        if self.error_integrator is None:
+        if self._error_integrator is None:
             return None
 
-        return self.error_integrator.get_sens_data_accumulated()
+        return self._error_integrator.get_sens_data_accumulated()
 
     def get_errors_systematic(self) -> np.ndarray | None:
         """Gets the systematic error array from the previously calculated sensor
@@ -200,10 +198,10 @@ class SensorArrayPoint(ISensorArray):
             ,num_field_components,num_time_steps). Returns None if no error
             integrator has been set.
         """
-        if self.error_integrator is None:
+        if self._error_integrator is None:
             return None
 
-        return self.error_integrator.get_errs_systematic()
+        return self._error_integrator.get_errs_systematic()
 
     def get_errors_random(self) -> np.ndarray | None:
         """Gets the random error array from the previously calculated sensor
@@ -216,10 +214,10 @@ class SensorArrayPoint(ISensorArray):
             ,num_field_components,num_time_steps). Returns None if no error
             integrator has been set.
         """
-        if self.error_integrator is None:
+        if self._error_integrator is None:
             return None
 
-        return self.error_integrator.get_errs_random()
+        return self._error_integrator.get_errs_random()
 
     def get_errors_total(self) -> np.ndarray | None:
         """Gets the total error array from the previously calculated sensor
@@ -232,10 +230,10 @@ class SensorArrayPoint(ISensorArray):
             ,num_field_components,num_time_steps). Returns None if no error
             integrator has been set.
         """
-        if self.error_integrator is None:
+        if self._error_integrator is None:
             return None
 
-        return self.error_integrator.get_errs_total()
+        return self._error_integrator.get_errs_total()
 
     def calc_measurements(self) -> np.ndarray:
         """Calculates a set of sensor measurements using the specified sensor
@@ -254,11 +252,11 @@ class SensorArrayPoint(ISensorArray):
             systematic errors if an error integrator is specified. shape=(
             num_sensors,num_field_components,num_time_steps).
         """
-        if self.error_integrator is None:
+        if self._error_integrator is None:
             self._measurements = self.get_truth()
         else:
             self._measurements = self.get_truth() + \
-                self.error_integrator.calc_errors_from_chain(self.get_truth())
+                self._error_integrator.calc_errors_from_chain(self.get_truth())
 
         return self._measurements
 

pyvale/{core/sensordata.py → sensordata.py}

@@ -1,14 +1,13 @@
-"""
-================================================================================
-pyvale: the python validation engine
-License: MIT
-Copyright (C) 2025 The Computer Aided Validation Team
-================================================================================
-"""
+# ==============================================================================
+# pyvale: the python validation engine
+# License: MIT
+# Copyright (C) 2025 The Computer Aided Validation Team
+# ==============================================================================
+
 from dataclasses import dataclass
 import numpy as np
 from scipy.spatial.transform import Rotation
-from pyvale.core.integratortype import EIntSpatialType
+from pyvale.integratortype import EIntSpatialType
 
 
 @dataclass(slots=True)

pyvale/sensordescriptor.py

@@ -0,0 +1,213 @@
+
+# ==============================================================================
+# pyvale: the python validation engine
+# License: MIT
+# Copyright (C) 2025 The Computer Aided Validation Team
+# ==============================================================================
+
+"""
+This module is used to create sensor descriptors which are strings used to label
+plots and visualisations for virtual sensor simulations.
+"""
+
+from dataclasses import dataclass
+import numpy as np
+
+
+@dataclass(slots=True)
+class SensorDescriptor:
+    """Dataclass for storing string descriptors for sensor array vis2ualisation.
+    Used for labelling matplotlib and pyvista plots with the sensor name,
+    physical units and other descriptors.
+    """
+
+    name: str = "Measured Value"
+    """String describing the field that the sensor measures e.g. temperature
+    , strain etc. Defaults to 'Measured Value'.
+    """
+
+    units: str = r"-"
+    """String describing the sensor measurement units. Defaults to '-'. Latex
+    symbols can be used with a raw string.
+    """
+
+    time_units: str = r"s"
+    """String describing time units. Defaults to 's'.
+    """
+
+    symbol: str = r"m"
+    """Symbol for describing the field the sensor measures. For example 'T' for
+    temperature of r'\epsilon' for strain. Latex symbols can be used with a raw
+    string.
+    """
+
+    tag: str = "S"
+    """String shorthand tag used to label sensors on pyvista plots. Defaults to
+    'S'.
+    """
+
+    components: tuple[str,...] | None = None
+    """Tuple of strings describing the field components. Defaults to None which
+    is used for scalar fields. For vector fields use ('x','y','z') for 3D and
+    for tensor fields use ('xx','yy','zz','xy','yz','xz').
+    """
+
+
+    def create_label(self, comp_ind: int | None = None) -> str:
+        """Creates an axis label for a matplotlib plot based on the sensor
+        descriptor string. The axis label takes the form: 'name, symbol [units]'
+        This version creates a label with line breaks which is useful for
+        vertical colourbars.
+
+        Parameters
+        ----------
+        comp_ind : int | None, optional
+            Index of the field component to create a label for, by default None.
+            If None the first field component is used.
+
+        Returns
+        -------
+        str
+            Axis label for field component in the form: 'name, symbol [units]'.
+        """
+        label = ""
+        if self.name != "":
+            label = label + rf"{self.name} "
+
+
+        symbol = rf"${self.symbol}$ "
+        if comp_ind is not None and self.components is not None:
+            symbol = rf"${self.symbol}_{{{self.components[comp_ind]}}}$ "
+        if symbol != "":
+            label = label + symbol
+
+        if self.units != "":
+            label = label + "\n" + rf"[${self.units}$]"
+
+        return label
+
+    def create_label_flat(self, comp_ind: int | None = None) -> str:
+        """Creates an axis label for a matplotlib plot based on the sensor
+        descriptor string. The axis label takes the form: 'name, symbol [units]'
+        This version creates a label with no line breaks which is useful for
+        axis labels on plots.
+
+        Parameters
+        ----------
+        comp_ind : int | None, optional
+            Index of the field component to create a label for, by default None.
+            If None the first field component is used.
+
+        Returns
+        -------
+        str
+            Axis label for field component in the form: 'name, symbol [units]'.
+        """
+        label = ""
+        if self.name != "":
+            label = label + rf"{self.name} "
+
+
+        symbol = rf"${self.symbol}$ "
+        if comp_ind is not None and self.components is not None:
+            symbol = rf"${self.symbol}_{{{self.components[comp_ind]}}}$ "
+        if symbol != "":
+            label = label + symbol
+
+        if self.units != "":
+            label = label + " " + rf"[${self.units}$]"
+
+        return label
+
+    def create_sensor_tags(self,n_sensors: int) -> list[str]:
+        """Creates a list of numbered sensor tags for labelling sensor locations
+        or for graph legends. Tags are shorthand names for sensors such as TC
+        for thermocouples or SG for strain gauges.
+
+        Parameters
+        ----------
+        n_sensors : int
+            The number of sensors to create tags for.
+
+        Returns
+        -------
+        list[str]
+            A list of sensor tags
+        """
+        z_width = int(np.log10(n_sensors))+1
+
+        sensor_names = list()
+        for ss in range(n_sensors):
+            num_str = f"{ss+1}".zfill(z_width)
+            sensor_names.append(f"{self.tag}{num_str}")
+
+        return sensor_names
+
+
+class SensorDescriptorFactory:
+    """A factory for building common sensor descriptors for scalar, vector and
+    tensor fields. Builds descriptors for thermcouples, displacement sensors
+    and strain sensors.
+    """
+
+    @staticmethod
+    def temperature_descriptor() -> SensorDescriptor:
+        """Creates a generic temperature sensor descriptor. Assumes the sensor
+        is measuring a temperature in degrees C.
+
+        Returns
+        -------
+        SensorDescriptor
+            The default temperature sensor descriptor.
+        """
+        descriptor = SensorDescriptor(name="Temp.",
+                                      symbol="T",
+                                      units=r"^{\circ}C",
+                                      tag="TC")
+        return descriptor
+
+    @staticmethod
+    def displacement_descriptor() -> SensorDescriptor:
+        """Creates a generic displacement sensor descriptor. Assumes units of mm
+        and vector components of x,y,z.
+
+        Returns
+        -------
+        SensorDescriptor
+            The default displacement sensor descriptor.
+        """
+        descriptor = SensorDescriptor(name="Disp.",
+                                      symbol="u",
+                                      units=r"mm",
+                                      tag="DS",
+                                      components=("x","y","z"))
+        return descriptor
+
+    @staticmethod
+    def strain_descriptor(spat_dims: int = 3) -> SensorDescriptor:
+        """Creates a generic strain sensor descriptor. Assumes strain is
+        unitless and that the components are xx,yy,xy for 2D and xx,yy,zz,xy,yz,
+        xz for 3D.
+
+        Parameters
+        ----------
+        spat_dims : int, optional
+            Number of spatial dimensions used for setting the components of the
+            tensor strain field, by default 3.
+
+        Returns
+        -------
+        SensorDescriptor
+            The default strain sensor descriptor.
+        """
+        descriptor = SensorDescriptor(name="Strain",
+                                      symbol=r"\varepsilon",
+                                      units=r"-",
+                                      tag="SG")
+
+        if spat_dims == 2:
+            descriptor.components = ("xx","yy","xy")
+        else:
+            descriptor.components = ("xx","yy","zz","xy","yz","xz")
+
+        return descriptor

pyvale/{core/sensortools.py → sensortools.py}

@@ -1,13 +1,12 @@
-"""
-================================================================================
-pyvale: the python validation engine
-License: MIT
-Copyright (C) 2025 The Computer Aided Validation Team
-================================================================================
-"""
+# ==============================================================================
+# pyvale: the python validation engine
+# License: MIT
+# Copyright (C) 2025 The Computer Aided Validation Team
+# ==============================================================================
+
 import numpy as np
 import mooseherder as mh
-from pyvale.core.sensorarray import ISensorArray
+from pyvale.sensorarray import ISensorArray
 
 
 def create_sensor_pos_array(num_sensors: tuple[int,int,int],
@@ -116,7 +115,7 @@ def print_measurements(sens_array: ISensorArray,
         print_toterrs = tot_errs[sensors[0]:sensors[1],
                                         components[0]:components[1],
                                         time_steps[0]:time_steps[1]]
-        print(f"total errors = \n    {print_syserrs}")
+        print(f"total errors = \n    {print_toterrs}")
 
     print()
 

pyvale/simcases/case00_HEX20.i

@@ -5,7 +5,7 @@
 #-------------------------------------------------------------------------
 #_* MOOSEHERDER VARIABLES - START
 
-endTime = 50
+endTime = 20
 timeStep = 1
 
 # Geometric Properties
@@ -14,9 +14,9 @@ lengY = 10e-3   # m
 lengZ = 10e-3   # m
 
 # Mesh Properties
-nElemX = 1
-nElemY = 1
-nElemZ = 1
+nElemX = 2
+nElemY = 2
+nElemZ = 2
 eType = HEX20 # TET10, TET11, HEX20, HEX27
 
 # Thermal BCs
@@ -89,7 +89,7 @@ ThermExp = 17.8e-6 # 1/degC
         add_variables = true
         material_output_family = MONOMIAL   # MONOMIAL, LAGRANGE
         material_output_order = FIRST       # CONSTANT, FIRST, SECOND,
-        generate_output = 'stress_xx stress_yy stress_zz stress_xy stress_yz stress_xz strain_xx strain_yy strain_zz strain_xy strain_yz strain_xz'
+        generate_output = 'strain_xx strain_yy strain_zz strain_xy strain_yz strain_xz'
     []
 []
 

pyvale/simcases/case00_HEX27.i

@@ -5,7 +5,7 @@
 #-------------------------------------------------------------------------
 #_* MOOSEHERDER VARIABLES - START
 
-endTime = 50
+endTime = 20
 timeStep = 1
 
 # Geometric Properties
@@ -14,9 +14,9 @@ lengY = 10e-3   # m
 lengZ = 10e-3   # m
 
 # Mesh Properties
-nElemX = 1
-nElemY = 1
-nElemZ = 1
+nElemX = 2
+nElemY = 2
+nElemZ = 2
 eType = HEX27 # TET10, TET11, HEX20, HEX27
 
 # Thermal BCs
@@ -89,7 +89,7 @@ ThermExp = 17.8e-6 # 1/degC
         add_variables = true
         material_output_family = MONOMIAL   # MONOMIAL, LAGRANGE
         material_output_order = FIRST       # CONSTANT, FIRST, SECOND,
-        generate_output = 'stress_xx stress_yy stress_zz stress_xy stress_yz stress_xz strain_xx strain_yy strain_zz strain_xy strain_yz strain_xz'
+        generate_output = 'strain_xx strain_yy strain_zz strain_xy strain_yz strain_xz'
     []
 []