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

pyvale/examples/ex4_3_strain2d.py

@@ -1,12 +1,9 @@
-'''
-================================================================================
-Example: strain sensors on a 2d plate
-
-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 matplotlib.pyplot as plt
 from scipy.spatial.transform import Rotation as R

pyvale/examples/ex5_1_multiphysics2d.py

@@ -1,12 +1,9 @@
-'''
-================================================================================
-Example: thermo-mechanical multiphysics on 2D plate
+# ================================================================================
+# 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 matplotlib.pyplot as plt
 import mooseherder as mh

pyvale/examples/ex6_1_multiphysics2d_expsim.py

@@ -1,12 +1,9 @@
-'''
-================================================================================
-Example: thermo-mechanical multiphysics on a 2D plate
-
-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 matplotlib.pyplot as plt
 import mooseherder as mh

pyvale/examples/ex6_2_multiphysics3d_expsim.py

@@ -1,12 +1,9 @@
-'''
-================================================================================
-Example: thermo-mechanical multiphysics on a divertor armour heatsink
-
-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 pathlib import Path
 import numpy as np
 import matplotlib.pyplot as plt
@@ -33,6 +30,7 @@ def main() -> None:
     else:
         sample_times = np.linspace(0.0,np.max(sim_data.time),50)
 
+    save_figs = False
     save_tag = "thermomech3d"
     fig_save_path = Path.cwd()/"images"
     if not fig_save_path.is_dir():
@@ -62,7 +60,8 @@ def main() -> None:
     pv_plot.camera_position = [(59.354, 43.428, 69.946),
                                (-2.858, 13.189, 4.523),
                                (-0.215, 0.948, -0.233)]
-    pv_plot.save_graphic(fig_save_path/(save_tag+"_tc_vis.svg"))
+    if save_figs:
+        pv_plot.save_graphic(fig_save_path/(save_tag+"_tc_vis.svg"))
     pv_plot.show()
 
     #---------------------------------------------------------------------------
@@ -90,7 +89,8 @@ def main() -> None:
     pv_plot.camera_position = [(59.354, 43.428, 69.946),
                                (-2.858, 13.189, 4.523),
                                (-0.215, 0.948, -0.233)]
-    pv_plot.save_graphic(fig_save_path/(save_tag+"_sg_vis.svg"))
+    if save_figs:
+        pv_plot.save_graphic(fig_save_path/(save_tag+"_sg_vis.svg"))
     pv_plot.show()
 
     #---------------------------------------------------------------------------
@@ -141,7 +141,8 @@ def main() -> None:
                                    sens_array_num=0,
                                    sim_num=0,
                                    trace_opts=trace_opts)
-    fig.savefig(fig_save_path/(save_tag+"_tc_traces.png"),
+    if save_figs:
+        fig.savefig(fig_save_path/(save_tag+"_tc_traces.png"),
                 dpi=300, format='png', bbox_inches='tight')
 
     (fig,ax) = pyv.plot_exp_traces(exp_sim,
@@ -149,7 +150,8 @@ def main() -> None:
                                    sens_array_num=1,
                                    sim_num=0,
                                    trace_opts=trace_opts)
-    fig.savefig(fig_save_path/(save_tag+"_sg_traces.png"),
+    if save_figs:
+        fig.savefig(fig_save_path/(save_tag+"_sg_traces.png"),
                 dpi=300, format='png', bbox_inches='tight')
     plt.show()
 

pyvale/examples/features/__init__.py

@@ -1,7 +1,5 @@
-"""
-================================================================================
-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
+#===============================================================================

pyvale/examples/rasterisation/ex_rastenp.py

@@ -1,10 +1,8 @@
-"""
-================================================================================
-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 pathlib import Path
 import time
 import numpy as np

pyvale/examples/rasterisation/ex_rastercyth_oneframe.py

@@ -1,10 +1,8 @@
-"""
-================================================================================
-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 time
 import numpy as np

pyvale/examples/rasterisation/ex_rastercyth_static_cypara.py

@@ -1,10 +1,8 @@
-"""
-================================================================================
-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 pathlib import Path
 import time
 import numpy as np

pyvale/examples/rasterisation/ex_rastercyth_static_pypara.py

@@ -1,10 +1,8 @@
-"""
-================================================================================
-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 pathlib import Path
 import time
 import numpy as np

pyvale/{core/experimentsimulator.py → experimentsimulator.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
+# ================================================================================
+
 from dataclasses import dataclass
 import numpy as np
-from pyvale.core.sensorarray import ISensorArray
+from pyvale.sensorarray import ISensorArray
 import mooseherder as mh
 
 # NOTE: This module is a feature under developement.

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

@@ -1,10 +1,9 @@
-"""
-================================================================================
-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 abc import ABC, abstractmethod
 import numpy as np
 from scipy.spatial.transform import Rotation

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

@@ -1,10 +1,9 @@
-"""
-================================================================================
-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 warnings
 import numpy as np
 import pyvista as pv
@@ -14,7 +13,7 @@ import mooseherder as mh
 
 def simdata_to_pyvista(sim_data: mh.SimData,
                         components: tuple[str,...] | None,
-                        spat_dim: int
+                        elem_dims: int
                         ) -> tuple[pv.UnstructuredGrid,pv.UnstructuredGrid]:
     """Converts the mesh and field data in a `SimData` object into a pyvista
     UnstructuredGrid for sampling (interpolating) the data and visualisation.
@@ -26,7 +25,7 @@ def simdata_to_pyvista(sim_data: mh.SimData,
     components : tuple[str,...] | None
         String keys for the components of the field to extract from the
         simulation data.
-    spat_dim : int
+    elem_dim : int
         Number of spatial dimensions (2 or 3) used to determine the element
         types in the mesh from the number of nodes per element.
 
@@ -44,7 +43,7 @@ def simdata_to_pyvista(sim_data: mh.SimData,
         this_connect = np.copy(sim_data.connect[cc])-1
         (nodes_per_elem,n_elems) = this_connect.shape
 
-        this_cell_type = _get_pyvista_cell_type(nodes_per_elem,spat_dim)
+        this_cell_type = _get_pyvista_cell_type(nodes_per_elem,elem_dims)
 
         # VTK and exodus have different winding for 3D higher order quads
         this_connect = _exodus_to_pyvista_connect(this_cell_type,this_connect)
@@ -70,6 +69,99 @@ def simdata_to_pyvista(sim_data: mh.SimData,
     return (pv_grid,pv_grid_vis)
 
 
+def scale_length_units(sim_data: mh.SimData,
+                       disp_comps: tuple[str,...],
+                       scale: float) -> mh.SimData:
+
+    sim_data.coords = sim_data.coords*scale
+    for cc in disp_comps:
+        sim_data.node_vars[cc] = sim_data.node_vars[cc]*scale
+
+    return sim_data
+
+
+# TODO: make this work for sim_data with multiple connectivity
+def extract_surf_mesh(sim_data: mh.SimData) -> mh.SimData:
+
+    # NOTE: need to fix exodus 1 indexing for now and put it back at the end
+    # shape=(nodes_per_elem,num_elems)
+    connect = np.copy(sim_data.connect["connect1"])-1
+    num_elems = connect.shape[1]
+
+    assert "connect2" not in sim_data.connect, \
+        "Multiple connectivity tables not supported yet."
+
+    # Mapping of node numbers to faces for each element face
+    face_map = _get_surf_map(nodes_per_elem=connect.shape[0])
+    faces_per_elem = face_map.shape[0]
+    nodes_per_face = face_map.shape[1]
+
+    # shape=(faces_per_elem,nodes_per_face,num_elems)
+    faces_wound = connect[face_map,:]
+    # shape=(num_elems,faces_per_elem,nodes_per_face)
+    faces_wound = faces_wound.transpose((2,0,1))
+
+    # Create an array of all faces with shape=(total_faces,nodes_per_face)
+    faces_total = faces_per_elem*num_elems
+    faces_flat_wound = faces_wound.reshape((faces_total,nodes_per_face))
+    # Sort the rows so nodes are in the same order when comparing them
+    faces_flat_sorted = np.copy(np.sort(faces_flat_wound,axis=1))
+
+    # Count each unique face in the list of faces, faces that appear only once
+    # must be external faces
+    (_,
+     faces_unique_inds,
+     faces_unique_counts) = np.unique(faces_flat_sorted,
+                                      axis=0,
+                                      return_counts=True,
+                                      return_index=True)
+
+    # Indices of the external faces in faces_flat
+    faces_ext_inds_in_unique = np.where(faces_unique_counts==1)[0]
+
+    # shape=(num_ext_faces,nodes_per_face)
+    faces_ext_inds = faces_unique_inds[faces_ext_inds_in_unique]
+
+    faces_ext_wound = faces_flat_wound[faces_ext_inds]
+
+    faces_coord_inds = np.unique(faces_ext_wound.flatten())
+    faces_coords = np.copy(sim_data.coords[faces_coord_inds])
+
+    faces_shape = faces_ext_wound.shape
+    faces_ext_wound_flat = faces_ext_wound.flatten()
+    faces_ext_remap_flat = np.copy(faces_ext_wound_flat)
+
+    # Remap coordinates in the connectivity to match the trimmed list of coords
+    # that belong to the external faces
+    for mm,cc in enumerate(faces_coord_inds):
+        if mm == cc:
+            continue
+
+        ind_to_map = np.where(faces_ext_wound_flat == cc)[0]
+        faces_ext_remap_flat[ind_to_map] = mm
+
+    faces_ext_remap = faces_ext_remap_flat.reshape(faces_shape)
+    faces_ext_remap = faces_ext_remap + 1 # back to exodus 1 index
+
+    # Now we build the SimData object and slice out the node and element
+    # variables using the coordinate indexing.
+    face_data = mh.SimData(coords=faces_coords,
+                           connect={"connect1":faces_ext_remap.T},
+                           time=sim_data.time)
+
+    if sim_data.node_vars is not None:
+        face_data.node_vars = {}
+        for nn in sim_data.node_vars:
+            face_data.node_vars[nn] = sim_data.node_vars[nn][faces_coord_inds,:]
+
+    if sim_data.elem_vars is not None:
+        face_data.elem_vars = {}
+        for ee in sim_data.node_vars:
+            face_data.elem_vars[ee] = sim_data.elem_vars[ee][faces_coord_inds,:]
+
+    return face_data
+
+
 def _get_pyvista_cell_type(nodes_per_elem: int, spat_dim: int) -> CellType:
     """Helper function to identify the pyvista element type in the mesh.
 
@@ -141,14 +233,43 @@ def _exodus_to_pyvista_connect(cell_type: CellType, connect: np.ndarray) -> np.n
 
     return connect
 
-def scale_length_units(sim_data: mh.SimData,
-                       disp_comps: tuple[str,...],
-                       scale: float) -> mh.SimData:
 
-    sim_data.coords = sim_data.coords*scale
-    for cc in disp_comps:
-        sim_data.node_vars[cc] = sim_data.node_vars[cc]*scale
+def _get_surf_map(nodes_per_elem: int) -> np.ndarray:
 
-    return sim_data
+    if nodes_per_elem == 4: # TET4
+       return np.array(((0,1,2),
+                        (0,3,1),
+                        (0,2,3),
+                        (1,3,2)))
+
+    if nodes_per_elem == 8: # HEX8
+        return np.array(((0,1,2,3),
+                         (0,3,7,4),
+                         (4,7,6,5),
+                         (1,5,6,2),
+                         (0,4,5,1),
+                         (2,6,7,3)))
+
+    if nodes_per_elem == 10: # TET10
+       return np.array(((0,1,2,4,5,6),
+                        (0,3,1,4,8,7),
+                        (0,2,3,6,9,7),
+                        (1,3,2,8,9,5)))
+
+    if nodes_per_elem == 20: # HEX20
+        return np.array(((0,1,2,3,8,9,10,11),
+                         (0,3,7,4,11,15,19,12),
+                         (4,7,6,5,19,18,17,16),
+                         (1,5,6,2,13,17,14,9),
+                         (0,4,5,1,12,16,13,8),
+                         (2,6,7,3,14,18,15,10)))
 
+    if nodes_per_elem == 27: # HEX27
+        return np.array(((0,1,2,3,8,9,10,11,21),
+                         (0,3,7,4,11,15,19,12,23),
+                         (4,7,6,5,19,18,17,16,22),
+                         (1,5,6,2,13,17,14,9,24),
+                         (0,4,5,1,12,16,13,8,25),
+                         (2,6,7,3,14,18,15,10,26)))
 
+    raise ValueError("Number of nodes does not match a 3D element type for surface extraction.")

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

@@ -1,15 +1,14 @@
-"""
-================================================================================
-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 pyvista as pv
-from pyvale.core.field import IField
-from pyvale.core.sensordata import SensorData
-from pyvale.core.integratorfactory import build_spatial_averager
+from pyvale.field import IField
+from pyvale.sensordata import SensorData
+from pyvale.integratorfactory import build_spatial_averager
 
 
 def sample_field_with_sensor_data(field: IField, sensor_data: SensorData

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

@@ -1,18 +1,17 @@
-"""
-================================================================================
-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 pyvista as pv
 from scipy.spatial.transform import Rotation
 import mooseherder as mh
 
-from pyvale.core.field import IField
-from pyvale.core.fieldconverter import simdata_to_pyvista
-from pyvale.core.fieldsampler import sample_pyvista_grid
+from pyvale.field import IField
+from pyvale.fieldconverter import simdata_to_pyvista
+from pyvale.fieldsampler import sample_pyvista_grid
 
 class FieldScalar(IField):
     """Class for sampling (interpolating) scalar fields from simulations to

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

@@ -1,19 +1,18 @@
-"""
-================================================================================
-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 pyvista as pv
 from scipy.spatial.transform import Rotation
 import mooseherder as mh
 
-from pyvale.core.field import IField
-from pyvale.core.fieldconverter import simdata_to_pyvista
-from pyvale.core.fieldsampler import sample_pyvista_grid
-from pyvale.core.fieldtransform import (transform_tensor_2d,
+from pyvale.field import IField
+from pyvale.fieldconverter import simdata_to_pyvista
+from pyvale.fieldsampler import sample_pyvista_grid
+from pyvale.fieldtransform import (transform_tensor_2d,
                                    transform_tensor_2d_batch,
                                    transform_tensor_3d,
                                    transform_tensor_3d_batch)

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

@@ -1,10 +1,9 @@
-"""
-================================================================================
-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
 
 def transform_vector_2d(trans_mat: np.ndarray, vector: np.ndarray

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

@@ -1,19 +1,18 @@
-"""
-================================================================================
-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 pyvista as pv
 from scipy.spatial.transform import Rotation
 import mooseherder as mh
 
-from pyvale.core.field import IField
-from pyvale.core.fieldconverter import simdata_to_pyvista
-from pyvale.core.fieldsampler import sample_pyvista_grid
-from pyvale.core.fieldtransform import (transform_vector_2d,
+from pyvale.field import IField
+from pyvale.fieldconverter import simdata_to_pyvista
+from pyvale.fieldsampler import sample_pyvista_grid
+from pyvale.fieldtransform import (transform_vector_2d,
                                         transform_vector_2d_batch,
                                         transform_vector_3d,
                                         transform_vector_3d_batch)

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

@@ -1,10 +1,9 @@
-"""
-================================================================================
-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 abc import ABC, abstractmethod
 import numpy as np
 

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

@@ -1,10 +1,9 @@
-"""
-================================================================================
-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 time
 import warnings
 from dataclasses import dataclass
@@ -14,9 +13,9 @@ from scipy.interpolate import griddata
 from scipy.interpolate import RectBivariateSpline
 from scipy import ndimage
 
-from pyvale.core.rasternp import edge_function, RasterNP
-from pyvale.core.cameradata2d import CameraData2D
-from pyvale.core.cameratools import CameraTools
+from pyvale.rasternp import edge_function, RasterNP
+from pyvale.cameradata2d import CameraData2D
+from pyvale.cameratools import CameraTools
 
 
 @dataclass(slots=True)

pyvale/{core/integratorfactory.py → integratorfactory.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.sensordata import SensorData
-from pyvale.core.integratorspatial import IIntegratorSpatial
-from pyvale.core.integratortype import EIntSpatialType
-from pyvale.core.integratorrectangle import Rectangle2D
-from pyvale.core.integratorquadrature import (Quadrature2D,
+from pyvale.field import IField
+from pyvale.sensordata import SensorData
+from pyvale.integratorspatial import IIntegratorSpatial
+from pyvale.integratortype import EIntSpatialType
+from pyvale.integratorrectangle import Rectangle2D
+from pyvale.integratorquadrature import (Quadrature2D,
                                               create_gauss_weights_2d_4pts,
                                               create_gauss_weights_2d_9pts)