fix: fixes the bug reported in issue #70 (#71)

* Fixing the bug with the bi-planar factory function, which was using the wrong input_args structure.
* Added regression test.
* Adding additional export step, for debugging purposes.

Author: kev-m

pyCoilGen/__init__.py

@@ -1,3 +1,3 @@
 """Magnetic Field Coil Generator for Python."""
 # Semantic Versioning according to https://semver.org/spec/v2.0.0.html
-__version__ = "0.2.1" # Fix level, due to bugfix, issue #68
+__version__ = "0.2.2" # Fix level, due to bugfix, issue #70

pyCoilGen/mesh_factory/build_biplanar_mesh.py

@@ -113,7 +113,7 @@ def create_bi_planar_mesh(input_args):
     Used when 'input_args.coil_mesh_file' is 'create bi-planar mesh'.
     """
     log.debug("Creating bi-planar mesh with '%s'", input_args.biplanar_mesh_parameter_list)
-    mesh_data = build_biplanar_mesh(*input_args.planar_mesh_parameter_list)
+    mesh_data = build_biplanar_mesh(*input_args.biplanar_mesh_parameter_list)
     coil_mesh = create_unique_noded_mesh(mesh_data)
     return coil_mesh
 

pyCoilGen/pyCoilGen_release.py

@@ -153,6 +153,13 @@ def pyCoilGen(log, input_args=None):
             timer.stop()
             runpoint_tag = '02'
 
+            if get_level() >= DEBUG_VERBOSE:
+                # Export data
+                print('Exporting initial data:')
+                timer.start()
+                export_data(solution)
+                timer.stop()
+
             # Define the target field
             print('Define the target field:')
             timer.start()

pytest.ini

@@ -1,2 +1,3 @@
 [pytest]
-pythonpath = .
+pythonpath = .
+python_files = test_*.py regression_*.py

scratchpad/issue70.py

@@ -0,0 +1,66 @@
+# System imports
+import sys
+
+# Logging
+import logging
+
+# Debugging imports
+# Add the sub_functions directory to the Python module search path
+from pathlib import Path
+sub_functions_path = Path(__file__).resolve().parent / '..'
+sys.path.append(str(sub_functions_path))
+
+# Local imports
+from pyCoilGen.pyCoilGen_release import pyCoilGen
+from pyCoilGen.sub_functions.constants import DEBUG_BASIC, DEBUG_VERBOSE
+
+if __name__ == '__main__':
+    # Set up logging
+    log = logging.getLogger(__name__)
+    logging.basicConfig(level=logging.DEBUG, stream=sys.stdout)
+    # logging.basicConfig(level=logging.INFO)
+
+    arg_dict = {
+        'field_shape_function': 'x',  # definition of the target field
+
+        # 'coil_mesh_file': 'bi_planer_rectangles_width_1000mm_distance_500mm.stl',
+        'coil_mesh': 'create bi-planar mesh',
+        'biplanar_mesh_parameter_list': [1.0, 1.0,   # planar_height, planar_width of the planar mesh.
+                                         20, 20,     # num_lateral_divisions, num_longitudinal_divisions
+                                         0.0, 1.0, 0.0,    # target_normal_x, target_normal_y, target_normal_z
+                                         0, 0, 0,    # center_position_x, center_position_y, center_position_z
+                                         0.5],       # plane_distance (`float`): Distance between the two planes.
+
+        'target_mesh_file': 'none',
+        'secondary_target_mesh_file': 'none',
+        'secondary_target_weight': 0.5,
+        'target_region_radius': 0.1,  # in meter
+        # 'target_region_resolution': 10,  # MATLAB 10 is the default
+        'use_only_target_mesh_verts': False,
+        'sf_source_file': 'none',
+        # the number of potential steps that determines the later number of windings (Stream function discretization)
+        'levels': 14,
+        # a potential offset value for the minimal and maximal contour potential ; must be between 0 and 1
+        'pot_offset_factor': 0.25,
+        'surface_is_cylinder_flag': True,
+        # the width for the interconnections are interconnected; in meter
+        'interconnection_cut_width': 0.05,
+        # the length for which overlapping return paths will be shifted along the surface normals; in meter
+        'normal_shift_length': 0.01,
+        'iteration_num_mesh_refinement': 0, # 1,  # the number of refinements for the mesh;
+        'set_roi_into_mesh_center': True,
+        'force_cut_selection': ['high'],
+        # Specify one of the three ways the level sets are calculated: "primary","combined", or "independent"
+        'level_set_method': 'primary',
+        'skip_postprocessing': False,
+        'skip_inductance_calculation': False,
+        'tikhonov_reg_factor': 10,  # Tikhonov regularization factor for the SF optimization
+
+        'output_directory': 'images/issue70',  # [Current directory]
+        # 'project_name': 'issue70',
+        'project_name': 'biplanar_xgradient_Tj',
+        'persistence_dir': 'debug',
+        'debug': DEBUG_BASIC,
+    }
+
+    result = pyCoilGen(log, arg_dict)

tests/regression_issue70.py

@@ -0,0 +1,62 @@
+import numpy as np
+
+# Test support
+from pytest import approx
+
+# Local import
+from pyCoilGen.sub_functions.data_structures import DataStructure
+
+# Function under test
+from pyCoilGen.mesh_factory import load_mesh_factory_plugins
+
+
+def test_issue70():
+
+    planar_height = 0.75
+    planar_width = 0.85
+    num_lateral_divisions = 20
+    num_longitudinal_divisions = 25
+    target_normal_x = 0.0
+    target_normal_y = 1.0
+    target_normal_z = 0.0
+    center_position_x = 0
+    center_position_y = 0
+    center_position_z = 0
+    plane_distance = 0.5
+
+
+    input_args = DataStructure(coil_mesh='create bi-planar mesh',
+        biplanar_mesh_parameter_list=[planar_height, planar_width,
+                                num_lateral_divisions, num_longitudinal_divisions,
+                                target_normal_x, target_normal_y, target_normal_z,
+                                center_position_x, center_position_y, center_position_z,
+                                plane_distance],
+    )
+
+    print(f"input_args.coil_mesh => {input_args.coil_mesh}")
+    plugin_name = input_args.coil_mesh.replace(' ', '_').replace('-', '_')
+    plugins = load_mesh_factory_plugins()
+    found = False
+    for plugin in plugins:
+        mesh_creation_function = getattr(plugin, plugin_name, None)
+        if mesh_creation_function:
+            coil_mesh = mesh_creation_function(input_args)
+            found = True
+            break
+
+    assert found
+
+    # Min x is -0.5 width
+    assert np.min(coil_mesh.v[:, 0]) == approx(-planar_width/2.0)
+    # Max x is 0.5 width
+    assert np.max(coil_mesh.v[:, 0]) == approx(planar_width/2.0)
+
+    # Min y is -0.5 height
+    assert np.min(coil_mesh.v[:, 1]) == approx(-plane_distance/2.0)
+    # Max y is 0.5 height
+    assert np.max(coil_mesh.v[:, 1]) == approx(plane_distance/2.0)
+
+    # Min z is 0
+    assert np.min(coil_mesh.v[:, 2]) == -planar_height/2.0
+    # Max z is 0
+    assert np.max(coil_mesh.v[:, 2]) == planar_height/2.0