pyvale 2025.5.3__cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl

pyvale/sensortools.py

@@ -0,0 +1,142 @@
+# ==============================================================================
+# 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.sensorarray import ISensorArray
+
+
+def create_sensor_pos_array(num_sensors: tuple[int,int,int],
+                           x_lims: tuple[float, float],
+                           y_lims: tuple[float, float],
+                           z_lims: tuple[float, float]) -> np.ndarray:
+    """Function or creating a uniform grid of sensors inside the specified
+    bounds and returning the positions in format that can be used to build a
+    `SensorData` object.
+
+    To create a line of sensors along the X axis set the number of sensors to 1
+    for all the Y and Z axes and then set the upper and lower limits of the Y
+    and Z axis to be the same value.
+
+    To create a plane of sensors in the X-Y plane set the number of sensors in
+    Z to 1 and set the upper and lower coordinates of the Z limit to the desired
+    Z location of the plane. Then set the number of sensors in X and Y as
+    desired along with the associated limits.
+
+    Parameters
+    ----------
+    n_sens : tuple[int,int,int]
+        Number of sensors to create in the X, Y and Z directions.
+    x_lims : tuple[float, float]
+        Limits of the X axis sensor locations.
+    y_lims : tuple[float, float]
+        Limits of the Y axis sensor locations.
+    z_lims : tuple[float, float]
+        Limits of the Z axis sensor locations.
+
+    Returns
+    -------
+    np.ndarray
+        Array of sensor positions with shape=(num_sensors,3) where num_sensors
+        is the product of integers in the num_sensors tuple. The columns are the
+        X, Y and Z locations of the sensors.
+    """
+    sens_pos_x = np.linspace(x_lims[0],x_lims[1],num_sensors[0]+2)[1:-1]
+    sens_pos_y = np.linspace(y_lims[0],y_lims[1],num_sensors[1]+2)[1:-1]
+    sens_pos_z = np.linspace(z_lims[0],z_lims[1],num_sensors[2]+2)[1:-1]
+
+    (sens_grid_x,sens_grid_y,sens_grid_z) = np.meshgrid(
+        sens_pos_x,sens_pos_y,sens_pos_z)
+
+    sens_pos_x = sens_grid_x.flatten()
+    sens_pos_y = sens_grid_y.flatten()
+    sens_pos_z = sens_grid_z.flatten()
+
+    sens_pos = np.vstack((sens_pos_x,sens_pos_y,sens_pos_z)).T
+    return sens_pos
+
+
+def print_measurements(sens_array: ISensorArray,
+                       sensors: tuple[int,int],
+                       components: tuple[int,int],
+                       time_steps: tuple[int,int])  -> None:
+    """Diagnostic function to print sensor measurements to the console. Also
+    prints the ground truth, the random and the systematic errors for the
+    specified sensor array. The sensors, components and time steps are specified
+    as slices of the measurement array.
+
+    Parameters
+    ----------
+    sens_array : ISensorArray
+        Sensor array to print measurement for.
+    sensors : tuple[int,int]
+        Range of sensors to print from the measurement array using the slice
+        specified by this tuple.
+    components : tuple[int,int]
+        Range of field components to print based on slicing the measurement
+        array with this tuple.
+    time_steps : tuple[int,int]
+        Range of time steps to print based on slicing the measurement array with
+        this tuple.
+    """
+    measurement =  sens_array.get_measurements()
+    truth = sens_array.get_truth()
+    rand_errs = sens_array.get_errors_random()
+    sys_errs = sens_array.get_errors_systematic()
+    tot_errs = sens_array.get_errors_total()
+
+    print(f"\nmeasurement.shape = \n    {measurement.shape}")
+    print_meas = measurement[sensors[0]:sensors[1],
+                             components[0]:components[1],
+                             time_steps[0]:time_steps[1]]
+    print(f"measurement = \n    {print_meas}")
+
+    print_truth = truth[sensors[0]:sensors[1],
+                        components[0]:components[1],
+                        time_steps[0]:time_steps[1]]
+    print(f"truth = \n    {print_truth}")
+
+    if rand_errs is not None:
+        print_randerrs = rand_errs[sensors[0]:sensors[1],
+                                    components[0]:components[1],
+                                    time_steps[0]:time_steps[1]]
+        print(f"random errors = \n    {print_randerrs}")
+
+    if sys_errs is not None:
+        print_syserrs = sys_errs[sensors[0]:sensors[1],
+                                        components[0]:components[1],
+                                        time_steps[0]:time_steps[1]]
+        print(f"systematic errors = \n    {print_syserrs}")
+
+    if tot_errs is not None:
+        print_toterrs = tot_errs[sensors[0]:sensors[1],
+                                        components[0]:components[1],
+                                        time_steps[0]:time_steps[1]]
+        print(f"total errors = \n    {print_toterrs}")
+
+    print()
+
+
+def print_dimensions(sim_data: mh.SimData) -> None:
+    """Diagnostic function for quickly finding the coordinate limits for from a
+    given simulation.
+
+    Parameters
+    ----------
+    sim_data : mh.SimData
+        Simulation data objects containing the nodal coordinates.
+    """
+    print(80*"-")
+    print("SimData Dimensions:")
+    print(f"x [min,max] = [{np.min(sim_data.coords[:,0])}," + \
+          f"{np.max(sim_data.coords[:,0])}]")
+    print(f"y [min,max] = [{np.min(sim_data.coords[:,1])}," + \
+          f"{np.max(sim_data.coords[:,1])}]")
+    print(f"z [min,max] = [{np.min(sim_data.coords[:,2])}," + \
+          f"{np.max(sim_data.coords[:,2])}]")
+    print(f"t [min,max] = [{np.min(sim_data.time)},{np.max(sim_data.time)}]")
+    print(80*"-")
+

pyvale/simcases/case00_HEX20.i

@@ -0,0 +1,242 @@
+#-------------------------------------------------------------------------
+# pyvale: single element test 3D
+#-------------------------------------------------------------------------
+
+#-------------------------------------------------------------------------
+#_* MOOSEHERDER VARIABLES - START
+
+endTime = 20
+timeStep = 1
+
+# Geometric Properties
+lengX = 10e-3   # m
+lengY = 10e-3   # m
+lengZ = 10e-3   # m
+
+# Mesh Properties
+nElemX = 2
+nElemY = 2
+nElemZ = 2
+eType = HEX20 # TET10, TET11, HEX20, HEX27
+
+# Thermal BCs
+coolantTemp=100.0      # degC
+heatTransCoeff=125.0e3 # W.m^-2.K^-1
+surfHeatFlux=4.67e6    # W.m^-2, taken from Adel's first paper
+timeConst = 1   # s
+
+# Mechanical Loads/BCs
+topDispRate = ${fparse 1e-3 / endTime}  # m/s
+
+# Thermal Props:
+Density = 8829.0  # kg.m^-3
+ThermCond = 384.0 # W.m^-1.K^-1
+SpecHeat = 406.0  # J.kg^-1.K^-1
+
+# Material Properties:
+EMod= 100e9     # Pa
+PRatio = 0.33    # -
+
+# Thermo-mechanical coupling
+stressFreeTemp = 20 # degC
+ThermExp = 17.8e-6 # 1/degC
+
+#** MOOSEHERDER VARIABLES - END
+#-------------------------------------------------------------------------
+
+[GlobalParams]
+    displacements = 'disp_x disp_y disp_z'
+[]
+
+[Mesh]
+    [generated]
+        type = GeneratedMeshGenerator
+        dim = 3
+        nx = ${nElemX}
+        ny = ${nElemY}
+        nz = ${nElemZ}
+        xmax = ${lengX}
+        ymax = ${lengY}
+        zmax = ${lengZ}
+        elem_type = ${eType}
+    []
+[]
+
+[Variables]
+    [temperature]
+      family = LAGRANGE
+      order = SECOND
+      initial_condition = ${coolantTemp}
+    []
+[]
+
+[Kernels]
+    [heat_conduction]
+      type = HeatConduction
+      variable = temperature
+    []
+    [time_derivative]
+      type = HeatConductionTimeDerivative
+      variable = temperature
+    []
+[]
+
+
+[Physics/SolidMechanics/QuasiStatic]
+    [all]
+        strain = SMALL
+        incremental = true
+        add_variables = true
+        material_output_family = MONOMIAL   # MONOMIAL, LAGRANGE
+        material_output_order = FIRST       # CONSTANT, FIRST, SECOND,
+        generate_output = 'strain_xx strain_yy strain_zz strain_xy strain_yz strain_xz'
+    []
+[]
+
+[BCs]
+    [heat_flux_in]
+        type = FunctionNeumannBC
+        variable = temperature
+        boundary = 'top'
+        function = '${fparse surfHeatFlux}*(1-exp(-(1/${timeConst})*t))'
+    []
+    [heat_flux_out]
+        type = ConvectiveHeatFluxBC
+        variable = temperature
+        boundary = 'bottom'
+        T_infinity = ${coolantTemp}
+        heat_transfer_coefficient = ${heatTransCoeff}
+    []
+
+    [bottom_x]
+        type = DirichletBC
+        variable = disp_x
+        boundary = 'bottom'
+        value = 0.0
+    []
+    [bottom_y]
+        type = DirichletBC
+        variable = disp_y
+        boundary = 'bottom'
+        value = 0.0
+    []
+    [bottom_z]
+        type = DirichletBC
+        variable = disp_z
+        boundary = 'bottom'
+        value = 0.0
+    []
+    [top_x]
+        type = DirichletBC
+        variable = disp_x
+        boundary = 'top'
+        value = 0.0
+    []
+    [top_y]
+        type = FunctionDirichletBC
+        variable = disp_y
+        boundary = 'top'
+        function = '${topDispRate}*t'
+    []
+    [top_z]
+        type = DirichletBC
+        variable = disp_z
+        boundary = 'top'
+        value = 0.0
+    []
+[]
+
+[Materials]
+    [mat_thermal]
+        type = HeatConductionMaterial
+        thermal_conductivity = ${ThermCond}
+        specific_heat = ${SpecHeat}
+    []
+    [mat_density]
+        type = GenericConstantMaterial
+        prop_names = 'density'
+        prop_values = ${Density}
+    []
+    [mat_expansion]
+        type = ComputeThermalExpansionEigenstrain
+        temperature = temperature
+        stress_free_temperature = ${stressFreeTemp}
+        thermal_expansion_coeff = ${ThermExp}
+        eigenstrain_name = thermal_expansion_eigenstrain
+    []
+
+    [mat_elasticity]
+        type = ComputeIsotropicElasticityTensor
+        youngs_modulus = ${EMod}
+        poissons_ratio = ${PRatio}
+    []
+    [stress]
+        type =  ComputeFiniteStrainElasticStress
+    []
+[]
+
+[Preconditioning]
+    [SMP]
+        type = SMP
+        full = true
+    []
+[]
+
+[Executioner]
+    type = Transient
+
+    solve_type = 'NEWTON'
+    petsc_options = '-snes_converged_reason'
+    petsc_options_iname = '-pc_type -pc_hypre_type'
+    petsc_options_value = 'hypre boomeramg'
+
+    l_max_its = 1000
+    l_tol = 1e-6
+
+    nl_max_its = 50
+    nl_rel_tol = 1e-6
+    nl_abs_tol = 1e-6
+
+    start_time=0.0
+    end_time = ${endTime}
+    dt = ${timeStep}
+
+    [Predictor]
+      type = SimplePredictor
+      scale = 1
+    []
+[]
+
+
+[Postprocessors]
+    [react_y_bot]
+        type = SidesetReaction
+        direction = '0 1 0'
+        stress_tensor = stress
+        boundary = 'bottom'
+    []
+    [react_y_top]
+        type = SidesetReaction
+        direction = '0 1 0'
+        stress_tensor = stress
+        boundary = 'top'
+    []
+
+    [disp_y_max]
+        type = NodalExtremeValue
+        variable = disp_y
+    []
+    [disp_x_max]
+        type = NodalExtremeValue
+        variable = disp_x
+    []
+    [disp_z_max]
+        type = NodalExtremeValue
+        variable = disp_z
+    []
+
+[]
+
+[Outputs]
+    exodus = true
+[]

pyvale/simcases/case00_HEX27.i

@@ -0,0 +1,242 @@
+#-------------------------------------------------------------------------
+# pyvale: single element test 3D
+#-------------------------------------------------------------------------
+
+#-------------------------------------------------------------------------
+#_* MOOSEHERDER VARIABLES - START
+
+endTime = 20
+timeStep = 1
+
+# Geometric Properties
+lengX = 10e-3   # m
+lengY = 10e-3   # m
+lengZ = 10e-3   # m
+
+# Mesh Properties
+nElemX = 2
+nElemY = 2
+nElemZ = 2
+eType = HEX27 # TET10, TET11, HEX20, HEX27
+
+# Thermal BCs
+coolantTemp=100.0      # degC
+heatTransCoeff=125.0e3 # W.m^-2.K^-1
+surfHeatFlux=4.67e6    # W.m^-2, taken from Adel's first paper
+timeConst = 1   # s
+
+# Mechanical Loads/BCs
+topDispRate = ${fparse 1e-3 / endTime}  # m/s
+
+# Thermal Props:
+Density = 8829.0  # kg.m^-3
+ThermCond = 384.0 # W.m^-1.K^-1
+SpecHeat = 406.0  # J.kg^-1.K^-1
+
+# Material Properties:
+EMod= 100e9     # Pa
+PRatio = 0.33    # -
+
+# Thermo-mechanical coupling
+stressFreeTemp = 20 # degC
+ThermExp = 17.8e-6 # 1/degC
+
+#** MOOSEHERDER VARIABLES - END
+#-------------------------------------------------------------------------
+
+[GlobalParams]
+    displacements = 'disp_x disp_y disp_z'
+[]
+
+[Mesh]
+    [generated]
+        type = GeneratedMeshGenerator
+        dim = 3
+        nx = ${nElemX}
+        ny = ${nElemY}
+        nz = ${nElemZ}
+        xmax = ${lengX}
+        ymax = ${lengY}
+        zmax = ${lengZ}
+        elem_type = ${eType}
+    []
+[]
+
+[Variables]
+    [temperature]
+      family = LAGRANGE
+      order = SECOND
+      initial_condition = ${coolantTemp}
+    []
+[]
+
+[Kernels]
+    [heat_conduction]
+      type = HeatConduction
+      variable = temperature
+    []
+    [time_derivative]
+      type = HeatConductionTimeDerivative
+      variable = temperature
+    []
+[]
+
+
+[Physics/SolidMechanics/QuasiStatic]
+    [all]
+        strain = SMALL
+        incremental = true
+        add_variables = true
+        material_output_family = MONOMIAL   # MONOMIAL, LAGRANGE
+        material_output_order = FIRST       # CONSTANT, FIRST, SECOND,
+        generate_output = 'strain_xx strain_yy strain_zz strain_xy strain_yz strain_xz'
+    []
+[]
+
+[BCs]
+    [heat_flux_in]
+        type = FunctionNeumannBC
+        variable = temperature
+        boundary = 'top'
+        function = '${fparse surfHeatFlux}*(1-exp(-(1/${timeConst})*t))'
+    []
+    [heat_flux_out]
+        type = ConvectiveHeatFluxBC
+        variable = temperature
+        boundary = 'bottom'
+        T_infinity = ${coolantTemp}
+        heat_transfer_coefficient = ${heatTransCoeff}
+    []
+
+    [bottom_x]
+        type = DirichletBC
+        variable = disp_x
+        boundary = 'bottom'
+        value = 0.0
+    []
+    [bottom_y]
+        type = DirichletBC
+        variable = disp_y
+        boundary = 'bottom'
+        value = 0.0
+    []
+    [bottom_z]
+        type = DirichletBC
+        variable = disp_z
+        boundary = 'bottom'
+        value = 0.0
+    []
+    [top_x]
+        type = DirichletBC
+        variable = disp_x
+        boundary = 'top'
+        value = 0.0
+    []
+    [top_y]
+        type = FunctionDirichletBC
+        variable = disp_y
+        boundary = 'top'
+        function = '${topDispRate}*t'
+    []
+    [top_z]
+        type = DirichletBC
+        variable = disp_z
+        boundary = 'top'
+        value = 0.0
+    []
+[]
+
+[Materials]
+    [mat_thermal]
+        type = HeatConductionMaterial
+        thermal_conductivity = ${ThermCond}
+        specific_heat = ${SpecHeat}
+    []
+    [mat_density]
+        type = GenericConstantMaterial
+        prop_names = 'density'
+        prop_values = ${Density}
+    []
+    [mat_expansion]
+        type = ComputeThermalExpansionEigenstrain
+        temperature = temperature
+        stress_free_temperature = ${stressFreeTemp}
+        thermal_expansion_coeff = ${ThermExp}
+        eigenstrain_name = thermal_expansion_eigenstrain
+    []
+
+    [mat_elasticity]
+        type = ComputeIsotropicElasticityTensor
+        youngs_modulus = ${EMod}
+        poissons_ratio = ${PRatio}
+    []
+    [stress]
+        type =  ComputeFiniteStrainElasticStress
+    []
+[]
+
+[Preconditioning]
+    [SMP]
+        type = SMP
+        full = true
+    []
+[]
+
+[Executioner]
+    type = Transient
+
+    solve_type = 'NEWTON'
+    petsc_options = '-snes_converged_reason'
+    petsc_options_iname = '-pc_type -pc_hypre_type'
+    petsc_options_value = 'hypre boomeramg'
+
+    l_max_its = 1000
+    l_tol = 1e-6
+
+    nl_max_its = 50
+    nl_rel_tol = 1e-6
+    nl_abs_tol = 1e-6
+
+    start_time=0.0
+    end_time = ${endTime}
+    dt = ${timeStep}
+
+    [Predictor]
+      type = SimplePredictor
+      scale = 1
+    []
+[]
+
+
+[Postprocessors]
+    [react_y_bot]
+        type = SidesetReaction
+        direction = '0 1 0'
+        stress_tensor = stress
+        boundary = 'bottom'
+    []
+    [react_y_top]
+        type = SidesetReaction
+        direction = '0 1 0'
+        stress_tensor = stress
+        boundary = 'top'
+    []
+
+    [disp_y_max]
+        type = NodalExtremeValue
+        variable = disp_y
+    []
+    [disp_x_max]
+        type = NodalExtremeValue
+        variable = disp_x
+    []
+    [disp_z_max]
+        type = NodalExtremeValue
+        variable = disp_z
+    []
+
+[]
+
+[Outputs]
+    exodus = true
+[]