pyvale 2025.4.0__py3-none-any.whl

pyvale/examples/ex2_2_thermal3d.py

@@ -0,0 +1,51 @@
+'''
+================================================================================
+Example: 3d thermocouples on a monoblock
+
+pyvale: the python validation engine
+License: MIT
+Copyright (C) 2025 The Computer Aided Validation Team
+================================================================================
+'''
+import mooseherder as mh
+import pyvale as pyv
+
+
+def main() -> None:
+    """pyvale example: thermocouples on a 3D divertor monoblock heatsink
+    ----------------------------------------------------------------------------
+    """
+    data_path = pyv.DataSet.thermal_3d_path()
+    sim_data = mh.ExodusReader(data_path).read_all_sim_data()
+    field_name = 'temperature'
+
+    # Scale to mm to make 3D visualisation scaling easier
+    sim_data.coords = sim_data.coords*1000.0 # type: ignore
+
+    n_sens = (1,4,1)
+    x_lims = (12.5,12.5)
+    y_lims = (0,31.0)
+    z_lims = (0.0,12.5)
+    sens_pos = pyv.create_sensor_pos_array(n_sens,x_lims,y_lims,z_lims)
+
+    sens_data = pyv.SensorData(positions=sens_pos)
+
+    tc_array = pyv.SensorArrayFactory() \
+        .thermocouples_basic_errs(sim_data,
+                                  sens_data,
+                                  field_name,
+                                  spat_dims=3)
+
+
+    measurements = tc_array.get_measurements()
+    print(f'\nMeasurements for sensor at top of block:\n{measurements[-1,0,:]}\n')
+
+    pv_plot = pyv.plot_point_sensors_on_sim(tc_array,field_name)
+    pv_plot.camera_position = [(59.354, 43.428, 69.946),
+                                (-2.858, 13.189, 4.523),
+                                (-0.215, 0.948, -0.233)]
+    pv_plot.show()
+
+
+if __name__ == '__main__':
+    main()

pyvale/examples/ex2_3_thermal3d.py

@@ -0,0 +1,109 @@
+"""
+================================================================================
+Example: 3d thermocouples on a monoblock
+
+pyvale: the python validation engine
+License: MIT
+Copyright (C) 2025 The Computer Aided Validation Team
+================================================================================
+"""
+from pathlib import Path
+import numpy as np
+import matplotlib.pyplot as plt
+import mooseherder as mh
+import pyvale as pyv
+
+
+def main() -> None:
+    """pyvale example: thermocouples on a 3D divertor monoblock heatsink
+    ----------------------------------------------------------------------------
+    """
+    data_path = pyv.DataSet.thermal_3d_path()
+    sim_data = mh.ExodusReader(data_path).read_all_sim_data()
+
+    # Scale to mm to make 3D visualisation scaling easier
+    sim_data.coords = sim_data.coords*1000.0 # type: ignore
+
+    use_auto_descriptor = "manual"
+    if use_auto_descriptor == "factory":
+        descriptor = pyv.SensorDescriptorFactory.temperature_descriptor()
+    elif use_auto_descriptor == "manual":
+        descriptor = pyv.SensorDescriptor()
+        descriptor.name = "Temperature"
+        descriptor.symbol = "T"
+        descriptor.units = r"^{\circ}C"
+        descriptor.tag = "TC"
+    else:
+        descriptor = pyv.SensorDescriptor()
+
+
+    field_key = "temperature"
+    t_field = pyv.FieldScalar(sim_data,
+                                 field_key=field_key,
+                                 spat_dims=3)
+
+    n_sens = (1,4,1)
+    x_lims = (12.5,12.5)
+    y_lims = (0.0,33.0)
+    z_lims = (0.0,12.0)
+    sens_pos = pyv.create_sensor_pos_array(n_sens,x_lims,y_lims,z_lims)
+
+    use_sim_time = False
+    if use_sim_time:
+        sample_times = None
+    else:
+        sample_times = np.linspace(0.0,np.max(sim_data.time),80)
+
+    sens_data = pyv.SensorData(positions=sens_pos,
+                                  sample_times=sample_times)
+
+    tc_array = pyv.SensorArrayPoint(sens_data,
+                                       t_field,
+                                       descriptor)
+
+    errors_on = {"indep_sys": True,
+                 "rand": True,
+                 "dep_sys": True}
+
+    error_chain = []
+    if errors_on["indep_sys"]:
+        error_chain.append(pyv.ErrSysOffset(offset=-5.0))
+        error_chain.append(pyv.ErrSysUniform(low=-10.0,
+                                                   high=10.0))
+
+    if errors_on["rand"]:
+        error_chain.append(pyv.ErrRandNormPercent(std_percent=5.0))
+        error_chain.append(pyv.ErrRandUnifPercent(low_percent=-5.0,
+                                                   high_percent=5.0))
+
+    if errors_on["dep_sys"]:
+        error_chain.append(pyv.ErrSysDigitisation(bits_per_unit=1/20))
+        error_chain.append(pyv.ErrSysSaturation(meas_min=0.0,meas_max=800.0))
+
+    if len(error_chain) > 0:
+        error_integrator = pyv.ErrIntegrator(
+            error_chain,
+            sens_data,
+            tc_array.get_measurement_shape(),
+        )
+        tc_array.set_error_integrator(error_integrator)
+
+    measurements = tc_array.get_measurements()
+    print(f"\nMeasurements for sensor at top of block:\n{measurements[-1,0,:]}\n")
+
+
+    (fig,_) = pyv.plot_time_traces(tc_array,field_key)
+    plt.show()
+
+    save_fig = True
+    if save_fig:
+        image_path = Path.cwd() / "example_output"
+        image_file = image_path / "monoblock_thermal_traces_syserrs.png"
+        if not image_path.is_dir():
+            image_path.mkdir()
+
+        fig.savefig(image_file, dpi=300, format="png", bbox_inches="tight")
+
+
+if __name__ == "__main__":
+    main()

pyvale/examples/ex3_1_displacement2d.py

@@ -0,0 +1,47 @@
+'''
+================================================================================
+example: displacement sensors on a 2d plate
+
+pyvale: the python validation engine
+License: MIT
+Copyright (C) 2025 The Computer Aided Validation Team
+================================================================================
+'''
+import matplotlib.pyplot as plt
+import mooseherder as mh
+import pyvale as pyv
+
+def main() -> None:
+    """pyvale example: displacement sensors on a 2D plate with a hole
+    ----------------------------------------------------------------------------
+    """
+    data_path = pyv.DataSet.mechanical_2d_path()
+    sim_data = mh.ExodusReader(data_path).read_all_sim_data()
+    # Scale to mm to make 3D visualisation scaling easier
+    sim_data.coords = sim_data.coords*1000.0 # type: ignore
+
+    n_sens = (2,3,1)
+    x_lims = (0.0,100.0)
+    y_lims = (0.0,150.0)
+    z_lims = (0.0,0.0)
+    sens_pos = pyv.create_sensor_pos_array(n_sens,x_lims,y_lims,z_lims)
+
+    sens_data = pyv.SensorData(positions=sens_pos)
+
+    disp_sens_array = pyv.SensorArrayFactory \
+                            .disp_sensors_basic_errs(sim_data,
+                                                     sens_data,
+                                                     "displacement",
+                                                     spat_dims=2)
+
+    plot_field = 'disp_x'
+    pv_plot = pyv.plot_point_sensors_on_sim(disp_sens_array,plot_field)
+    pv_plot.show(cpos="xy")
+
+    pyv.plot_time_traces(disp_sens_array,'disp_x')
+    pyv.plot_time_traces(disp_sens_array,'disp_y')
+    plt.show()
+
+
+if __name__ == "__main__":
+    main()

pyvale/examples/ex3_2_displacement2d.py

@@ -0,0 +1,79 @@
+'''
+================================================================================
+example: displacement sensors on a 2d plate
+
+pyvale: the python validation engine
+License: MIT
+Copyright (C) 2025 The Computer Aided Validation Team
+================================================================================
+'''
+from pathlib import Path
+import numpy as np
+import matplotlib.pyplot as plt
+import mooseherder as mh
+import pyvale as pyv
+
+def main() -> None:
+    """pyvale example: displacement sensors on a 2D plate with a hole
+    ----------------------------------------------------------------------------
+    """
+    data_path = pyv.DataSet.mechanical_2d_path()
+    sim_data = mh.ExodusReader(data_path).read_all_sim_data()
+    # Scale to mm to make 3D visualisation scaling easier
+    sim_data.coords = sim_data.coords*1000.0 # type: ignore
+
+    descriptor = pyv.SensorDescriptor()
+    descriptor.name = 'Disp.'
+    descriptor.symbol = r'u'
+    descriptor.units = r'm'
+    descriptor.tag = 'DS'
+    descriptor.components = ('x','y','z')
+
+    spat_dims = 2
+    field_key = 'disp'
+    components = ('disp_x','disp_y')
+    disp_field = pyv.FieldVector(sim_data,field_key,components,spat_dims)
+
+    n_sens = (2,3,1)
+    x_lims = (0.0,100.0)
+    y_lims = (0.0,150.0)
+    z_lims = (0.0,0.0)
+    sens_pos = pyv.create_sensor_pos_array(n_sens,x_lims,y_lims,z_lims)
+
+    use_sim_time = False
+    if use_sim_time:
+        sample_times = None
+    else:
+        sample_times = np.linspace(0.0,np.max(sim_data.time),50)
+
+    sens_data = pyv.SensorData(positions=sens_pos,
+                                  sample_times=sample_times)
+
+    disp_sens_array = pyv.SensorArrayPoint(sens_data,
+                                              disp_field,
+                                              descriptor)
+
+    error_chain = []
+    error_chain.append(pyv.ErrSysUniform(low=-0.01e-3,high=0.01e-3))
+    error_chain.append(pyv.ErrRandNormal(std=0.01e-3))
+    error_int = pyv.ErrIntegrator(error_chain,
+                                       sens_data,
+                                       disp_sens_array.get_measurement_shape())
+    disp_sens_array.set_error_integrator(error_int)
+
+
+    plot_field = 'disp_x'
+    if plot_field == 'disp_x':
+        pv_plot = pyv.plot_point_sensors_on_sim(disp_sens_array,'disp_x')
+        pv_plot.show(cpos="xy")
+    elif plot_field == 'disp_y':
+        pv_plot = pyv.plot_point_sensors_on_sim(disp_sens_array,'disp_y')
+        pv_plot.show(cpos="xy")
+
+    pyv.plot_time_traces(disp_sens_array,'disp_x')
+    pyv.plot_time_traces(disp_sens_array,'disp_y')
+    plt.show()
+
+
+if __name__ == "__main__":
+    main()

pyvale/examples/ex3_3_displacement2d.py

@@ -0,0 +1,104 @@
+'''
+================================================================================
+Example: displacement sensors on a 2d plate
+
+pyvale: the python validation engine
+License: MIT
+Copyright (C) 2025 The Computer Aided Validation Team
+================================================================================
+'''
+from pathlib import Path
+import numpy as np
+import matplotlib.pyplot as plt
+from scipy.spatial.transform import Rotation
+import mooseherder as mh
+import pyvale as pyv
+
+def main() -> None:
+    """pyvale example: displacement sensors on a 2D plate with a hole
+    ----------------------------------------------------------------------------
+    - Demonstrates sensor rotation for vector fields
+    """
+    data_path = pyv.DataSet.mechanical_2d_path()
+    sim_data = mh.ExodusReader(data_path).read_all_sim_data()
+    # Scale to mm to make 3D visualisation scaling easier
+    sim_data.coords = sim_data.coords*1000.0 # type: ignore
+
+    descriptor = pyv.SensorDescriptorFactory.displacement_descriptor()
+
+    spat_dims = 2
+    field_key = 'disp'
+    components = ('disp_x','disp_y')
+    disp_field = pyv.FieldVector(sim_data,field_key,components,spat_dims)
+
+    n_sens = (2,2,1)
+    x_lims = (0.0,100.0)
+    y_lims = (0.0,150.0)
+    z_lims = (0.0,0.0)
+    sensor_positions = pyv.create_sensor_pos_array(n_sens,x_lims,y_lims,z_lims)
+
+    use_sim_time = False
+    if use_sim_time:
+        sample_times = None
+    else:
+        sample_times = np.linspace(0.0,np.max(sim_data.time),50)
+
+    sens_data_norot = pyv.SensorData(positions=sensor_positions,
+                                        sample_times=sample_times)
+
+    disp_sens_norot = pyv.SensorArrayPoint(sens_data_norot,
+                                              disp_field,
+                                              descriptor)
+
+    meas_norot = disp_sens_norot.get_measurements()
+
+    sens_angles = sensor_positions.shape[0] * \
+        (Rotation.from_euler("zyx", [45, 0, 0], degrees=True),)
+
+    sens_data_rot = pyv.SensorData(positions=sensor_positions,
+                                      sample_times=sample_times,
+                                      angles=sens_angles)
+
+    disp_sens_rot = pyv.SensorArrayPoint(sens_data_rot,
+                                            disp_field,
+                                            descriptor)
+
+
+    angle_offset = np.zeros_like(sensor_positions)
+    angle_offset[:,0] = 1.0 # only rotate about z in 2D
+    angle_error_data = pyv.ErrFieldData(ang_offset_zyx=angle_offset)
+
+    sys_err_rot = pyv.ErrSysField(disp_field,angle_error_data)
+
+    sys_err_int = pyv.ErrIntegrator([sys_err_rot],
+                                         sens_data_rot,
+                                         disp_sens_rot.get_measurement_shape())
+    disp_sens_rot.set_error_integrator(sys_err_int)
+
+    meas_rot = disp_sens_rot.get_measurements()
+
+
+    print(80*'-')
+    sens_num = 4
+    print('The last 5 time steps (measurements) of sensor {sens_num}:')
+    pyv.print_measurements(disp_sens_rot,
+                              (sens_num-1,sens_num),
+                              (0,1),
+                              (meas_rot.shape[2]-5,meas_rot.shape[2]))
+    print(80*'-')
+
+    plot_field = 'disp_x'
+    if plot_field == 'disp_x':
+        pv_plot = pyv.plot_point_sensors_on_sim(disp_sens_rot,'disp_x')
+        pv_plot.show(cpos="xy")
+    elif plot_field == 'disp_y':
+        pv_plot = pyv.plot_point_sensors_on_sim(disp_sens_rot,'disp_y')
+        pv_plot.show(cpos="xy")
+
+    pyv.plot_time_traces(disp_sens_norot,plot_field)
+    pyv.plot_time_traces(disp_sens_rot,plot_field)
+    plt.show()
+
+
+if __name__ == "__main__":
+    main()

pyvale/examples/ex3_4_displacement2d.py

@@ -0,0 +1,105 @@
+"""
+================================================================================
+Example: displacement sensors on a 2d plate
+
+pyvale: the python validation engine
+License: MIT
+Copyright (C) 2025 The Computer Aided Validation Team
+================================================================================
+"""
+import numpy as np
+import matplotlib.pyplot as plt
+from scipy.spatial.transform import Rotation
+import mooseherder as mh
+import pyvale as pyv
+
+def main() -> None:
+    """pyvale example: displacement sensors on a 2D plate with a hole
+    ----------------------------------------------------------------------------
+    """
+    data_path = pyv.DataSet.mechanical_2d_path()
+    sim_data = mh.ExodusReader(data_path).read_all_sim_data()
+    # Scale to mm to make 3D visualisation scaling easier
+    sim_data.coords = sim_data.coords*1000.0 # type: ignore
+
+    descriptor = pyv.SensorDescriptorFactory.displacement_descriptor()
+
+    spat_dims = 2
+    field_key = "disp"
+    components = ("disp_x","disp_y")
+    disp_field = pyv.FieldVector(sim_data,field_key,components,spat_dims)
+
+    #---------------------------------------------------------------------------
+    n_sens = (2,2,1)
+    x_lims = (0.0,100.0)
+    y_lims = (0.0,150.0)
+    z_lims = (0.0,0.0)
+    sensor_positions = pyv.create_sensor_pos_array(n_sens,
+                                                      x_lims,
+                                                      y_lims,
+                                                      z_lims)
+
+    use_sim_time = False
+    if use_sim_time:
+        sample_times = None
+    else:
+        sample_times = np.linspace(0.0,np.max(sim_data.time),50)
+
+    sensor_angles = sensor_positions.shape[0] * \
+        (Rotation.from_euler("zyx", [0, 0, 0], degrees=True),)
+
+    sensor_data = pyv.SensorData(positions=sensor_positions,
+                                  sample_times=sample_times,
+                                  angles=sensor_angles,
+                                  spatial_averager=pyv.EIntSpatialType.QUAD4PT,
+                                  spatial_dims=np.array([5.0,5.0,0.0]))
+
+    #---------------------------------------------------------------------------
+    disp_sensors = pyv.SensorArrayPoint(sensor_data,
+                                           disp_field,
+                                           descriptor)
+
+    pos_offset = -10.0*np.ones_like(sensor_positions)
+    pos_offset[:,2] = 0 # in 2d we only have offset in x and y so zero z
+
+    angle_offset = np.zeros_like(sensor_positions)
+    angle_offset[:,0] = 5.0 # only rotate about z in 2D
+
+    time_offset = 1.0*np.ones_like(disp_sensors.get_sample_times())
+
+    field_error_data = pyv.ErrFieldData(pos_offset_xyz=pos_offset,
+                                           ang_offset_zyx=angle_offset,
+                                           time_offset=time_offset)
+
+    error_chain = []
+    error_chain.append(pyv.ErrSysField(disp_field,field_error_data))
+    error_integrator = pyv.ErrIntegrator(error_chain,
+                                            sensor_data,
+                                            disp_sensors.get_measurement_shape())
+
+    disp_sensors.set_error_integrator(error_integrator)
+
+    measurements = disp_sensors.calc_measurements()
+
+    #---------------------------------------------------------------------------
+    print(80*"-")
+    sens_num = 4
+    print("The last 5 time steps (measurements) of sensor {sens_num}:")
+    pyv.print_measurements(disp_sensors,
+                              (sens_num-1,sens_num),
+                              (0,1),
+                              (measurements.shape[2]-5,measurements.shape[2]))
+    print(80*"-")
+
+    #---------------------------------------------------------------------------
+    plot_field = "disp_x"
+
+    pv_plot = pyv.plot_point_sensors_on_sim(disp_sensors,plot_field)
+    pv_plot.show(cpos="xy")
+
+    pyv.plot_time_traces(disp_sensors,plot_field)
+    plt.show()
+
+
+if __name__ == "__main__":
+    main()

pyvale/examples/ex4_1_strain2d.py

@@ -0,0 +1,57 @@
+'''
+================================================================================
+Example: strain gauges on a 2d plate
+
+pyvale: the python validation engine
+License: MIT
+Copyright (C) 2025 The Computer Aided Validation Team
+================================================================================
+'''
+from pathlib import Path
+import numpy as np
+import matplotlib.pyplot as plt
+import mooseherder as mh
+import pyvale as pyv
+
+def main() -> None:
+    """pyvale example: strain sensors on a 2D plate with a hole
+    ----------------------------------------------------------------------------
+    """
+    data_path = pyv.DataSet.mechanical_2d_path()
+    sim_data = mh.ExodusReader(data_path).read_all_sim_data()
+    # Scale to mm to make 3D visualisation scaling easier
+    sim_data.coords = sim_data.coords*1000.0 # type: ignore
+
+    n_sens = (2,3,1)
+    x_lims = (0.0,100.0)
+    y_lims = (0.0,150.0)
+    z_lims = (0.0,0.0)
+    sens_pos = pyv.create_sensor_pos_array(n_sens,x_lims,y_lims,z_lims)
+
+    use_sim_time = False
+    if use_sim_time:
+        sample_times = None
+    else:
+        sample_times = np.linspace(0.0,np.max(sim_data.time),50)
+
+    sens_data = pyv.SensorData(positions=sens_pos,
+                                  sample_times=sample_times)
+
+    straingauge_array = pyv.SensorArrayFactory \
+                            .strain_gauges_basic_errs(sim_data,
+                                                      sens_data,
+                                                      "strain",
+                                                      spat_dims=2)
+
+    plot_field = 'strain_yy'
+    pv_plot = pyv.plot_point_sensors_on_sim(straingauge_array,plot_field)
+    pv_plot.show(cpos="xy")
+
+    pyv.plot_time_traces(straingauge_array,'strain_xx')
+    pyv.plot_time_traces(straingauge_array,'strain_yy')
+    pyv.plot_time_traces(straingauge_array,'strain_xy')
+    plt.show()
+
+
+if __name__ == "__main__":
+    main()

pyvale/examples/ex4_2_strain2d.py

@@ -0,0 +1,79 @@
+'''
+================================================================================
+Example: strain gauges on a 2d plate
+
+pyvale: the python validation engine
+License: MIT
+Copyright (C) 2025 The Computer Aided Validation Team
+================================================================================
+'''
+import numpy as np
+import matplotlib.pyplot as plt
+import mooseherder as mh
+import pyvale as pyv
+
+def main() -> None:
+    """pyvale example: strain sensors on a 2D plate with a hole
+    ----------------------------------------------------------------------------
+    """
+    data_path = pyv.DataSet.mechanical_2d_path()
+    sim_data = mh.ExodusReader(data_path).read_all_sim_data()
+    # Scale to mm to make 3D visualisation scaling easier
+    sim_data.coords = sim_data.coords*1000.0 # type: ignore
+
+    descriptor = pyv.SensorDescriptor()
+    descriptor.name = 'Strain'
+    descriptor.symbol = r'\varepsilon'
+    descriptor.units = r'-'
+    descriptor.tag = 'SG'
+    descriptor.components = ('xx','yy','xy')
+
+    spat_dims = 2
+    field_key = 'strain'
+    norm_components = ('strain_xx','strain_yy')
+    dev_components = ('strain_xy',)
+    strain_field = pyv.FieldTensor(sim_data,
+                                    field_key,
+                                    norm_components,
+                                    dev_components,
+                                    spat_dims)
+
+    n_sens = (2,3,1)
+    x_lims = (0.0,100.0)
+    y_lims = (0.0,150.0)
+    z_lims = (0.0,0.0)
+    sens_pos = pyv.create_sensor_pos_array(n_sens,x_lims,y_lims,z_lims)
+
+    use_sim_time = False
+    if use_sim_time:
+        sample_times = None
+    else:
+        sample_times = np.linspace(0.0,np.max(sim_data.time),50)
+
+    sens_data = pyv.SensorData(positions=sens_pos,
+                                  sample_times=sample_times)
+
+    straingauge_array = pyv.SensorArrayPoint(sens_data,
+                                                strain_field,
+                                                descriptor)
+
+    error_chain = []
+    error_chain.append(pyv.ErrSysUniform(low=-0.1e-3,high=0.1e-3))
+    error_chain.append(pyv.ErrRandNormal(std=0.1e-3))
+    error_int = pyv.ErrIntegrator(error_chain,
+                                       sens_data,
+                                       straingauge_array.get_measurement_shape())
+    straingauge_array.set_error_integrator(error_int)
+
+    plot_field = 'strain_yy'
+    pv_plot = pyv.plot_point_sensors_on_sim(straingauge_array,plot_field)
+    pv_plot.show(cpos="xy")
+
+    pyv.plot_time_traces(straingauge_array,'strain_xx')
+    pyv.plot_time_traces(straingauge_array,'strain_yy')
+    pyv.plot_time_traces(straingauge_array,'strain_xy')
+    plt.show()
+
+
+if __name__ == "__main__":
+    main()