Merge pull request #315 from davidrudlstorfer/purge_mentioning_of_dat

Purge all mentionings of dat

Author: davidrudlstorfer

src/meshpy/abaqus/beam.py

@@ -25,7 +25,6 @@
 import numpy as _np
 
 from meshpy.core.element_beam import Beam as _Beam
-from meshpy.core.material import MaterialBeam as _MaterialBeam
 
 
 def generate_abaqus_beam(beam_type: str):
@@ -69,19 +68,3 @@ def generate_abaqus_beam(beam_type: str):
             "n_dim": n_dim,
         },
     )
-
-
-class AbaqusBeamMaterial(_MaterialBeam):
-    """A class representing an Abaqus beam material."""
-
-    def __init__(self, name: str):
-        """Initialize the material. For now it is only supported to state the
-        name of the resulting element set here. The material and cross-section
-        lines in the input file have to be defined manually.
-
-        Args
-        ----
-        name: str
-            Name of the material, this will be the name of the resulting element set
-        """
-        super().__init__(data=name)

src/meshpy/abaqus/input_file.py

@@ -308,7 +308,7 @@ def get_material_lines(self):
         # Create the element sets for the different materials.
         input_file_lines = []
         for material, elements in materials.items():
-            material_name = material.get_dat_lines()[0]
+            material_name = material.dump_to_list()[0]
             input_file_lines.extend(get_set_lines("Elset", elements, material_name))
         return input_file_lines
 

src/meshpy/abaqus/material.py

@@ -0,0 +1,45 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2018-2025 MeshPy Authors
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+"""This file provides functions to create Abaqus beam element classes to be
+used with MeshPy."""
+
+from meshpy.core.material import MaterialBeam as _MaterialBeam
+
+
+class AbaqusBeamMaterial(_MaterialBeam):
+    """A class representing an Abaqus beam material."""
+
+    def __init__(self, name: str):
+        """Initialize the material. For now it is only supported to state the
+        name of the resulting element set here. The material and cross-section
+        lines in the input file have to be defined manually.
+
+        Args
+        ----
+        name: str
+            Name of the material, this will be the name of the resulting element set
+        """
+        super().__init__(data=name)
+
+    def dump_to_list(self):
+        """Return a list with the (single) item representing this material."""
+        return [self.data]

src/meshpy/core/base_mesh_item.py

@@ -47,36 +47,12 @@ def __init__(self, data=None, comments=None):
         else:
             self.comments = comments
 
-    def get_dat_lines(self):
-        """Return the content of this object as a list.
-
-        If comments exist, also add those.
-        """
-
-        # Get data of object.
-        data = self._get_dat()
-        if isinstance(data, str):
-            data = [data]
-
-        # Get comments if given.
-        return_list = []
-        if not len(self.comments) == 0:
-            return_list.extend(self.comments)
-
-        # Return final list.
-        return_list.extend(data)
-        return return_list
-
-    def _get_dat(self):
-        """Return the content of this object as either a list or a str."""
-        return self.data
-
 
 class BaseMeshItemFull(BaseMeshItem):
     """Base class for all objects that are related to a mesh and are fully
     created in MeshPy."""
 
 
 class BaseMeshItemString(BaseMeshItem):
-    """Base class for all objects that are imported from a dat file as a plain
-    string."""
+    """Base class for all objects that are imported from an input file as a
+    plain string."""

src/meshpy/core/boundary_condition.py

@@ -37,10 +37,8 @@ def __init__(self, geometry_set, bc_type=None, **kwargs):
 
         Args
         ----
-        geometry_set: GeometrySet, int
-            Geometry that this boundary condition acts on. An integer can be
-            given, in the case a dat file is imported. This integer is only
-            temporary and will be replaced with the GeometrySet object.
+        geometry_set: GeometrySet
+            Geometry that this boundary condition acts on.
         bc_type: mpy.bc
             Type of the boundary condition.
         """

src/meshpy/core/conf.py

@@ -151,7 +151,7 @@ def set_default_values(self):
         self.git_date = None
 
         # Precision for floats in output.
-        self.dat_precision = "{:.12g}"
+        self.output_precision = "{:.12g}"
 
         # Set the epsilons for comparison of different types of values.
         self.eps_quaternion = 1e-10
@@ -166,10 +166,7 @@ def set_default_values(self):
         self.geometric_search_max_nodes_brute_force = 1000
         self.geometric_search_binning_n_bin = 10
 
-        # Values for the formatting of the input file.
-        self.dat_len_section = 80
-
-        # Import meshes as pure dat or import the geometry.
+        # Import meshes as pure dict or import the geometry.
         self.import_mesh_full = False
 
         # Number of digits for node set output (this will be set in the
@@ -179,7 +176,7 @@ def set_default_values(self):
         self.vtk_nan_int = -1
         self.vtk_nan_float = 0.0
 
-        # Check for overlapping elements when creating a dat file.
+        # Check for overlapping elements when creating an input file.
         self.check_overlapping_elements = True
 
         # Lines to be added to each created input file

src/meshpy/core/coupling.py

@@ -60,12 +60,12 @@ def __init__(
             physical position.
         check_at_init: bool
             If the previous check should be performed at initialization. This is required
-            when importing a coupling from a dat file as the nodes themselves are not build
+            when importing a coupling from an input file as the nodes themselves are not build
             up when the coupling is read.
         """
 
         if isinstance(geometry, int):
-            # This is the case if the boundary condition is read from an existing dat file
+            # This is the case if the boundary condition is read from an existing input file
             pass
         elif isinstance(geometry, _GeometrySetBase):
             pass

src/meshpy/core/node.py

@@ -122,7 +122,7 @@ def dump_to_list(self):
         coordinate_string = " ".join(
             [
                 (
-                    _mpy.dat_precision.format(component + 0)
+                    _mpy.output_precision.format(component + 0)
                     if _np.abs(component) >= _mpy.eps_pos
                     else "0"
                 )
@@ -186,7 +186,7 @@ def dump_to_list(self):
         coordinate_string = " ".join(
             [
                 (
-                    _mpy.dat_precision.format(component + 0)
+                    _mpy.output_precision.format(component + 0)
                     if _np.abs(component) >= _mpy.eps_pos
                     else "0"
                 )

src/meshpy/core/rotation.py

@@ -324,15 +324,15 @@ def __eq__(self, other):
             return object.__eq__(self, other)
 
     def get_dat(self):
-        """Return a string with the triad components for the .dat line."""
+        """Return a string with the triad components for the input line."""
 
         rotation_vector = self.get_rotation_vector()
 
         # The zeros are added to avoid negative zeros in the input file.
         return " ".join(
             [
                 (
-                    _mpy.dat_precision.format(component + 0)
+                    _mpy.output_precision.format(component + 0)
                     if _np.abs(component) >= _mpy.eps_quaternion
                     else "0"
                 )

src/meshpy/four_c/input_file.py

@@ -192,6 +192,7 @@ def __init__(self, *, yaml_file: _Optional[_Path] = None, cubit=None):
         if yaml_file is not None:
             self.read_yaml(yaml_file)
 
+        # TODO fix once cubit is converted to YAML
         # if cubit is not None:
         #     self._read_dat_lines(cubit.get_dat_lines())
 
@@ -385,7 +386,6 @@ def get_dict_to_dump(
         self,
         *,
         header: bool = True,
-        dat_header: bool = True,
         add_script_to_header: bool = True,
         check_nox: bool = True,
     ):
@@ -395,11 +395,9 @@ def get_dict_to_dump(
         Args:
             header:
                 If the header should be exported to the input file files.
-            dat_header:
-                If header lines from the imported dat file should be exported.
-            append_script_to_header:
+            add_script_to_header:
                 If true, a copy of the executing script will be added to the input
-                file. This is only in affect when dat_header is True.
+                file. This is only in affect when header is True.
             check_nox:
                 If this is true, an error will be thrown if no nox file is set.
         """
@@ -422,8 +420,6 @@ def get_dict_to_dump(
         # if header:
         #     header_text, end_text = self._get_header(add_script_to_header)
         #     lines.append(header_text)
-        # if dat_header:
-        #     lines.extend(self.dat_header)
 
         # Check if a file has to be created for the NOX xml information.
         if self.nox_xml is not None:
@@ -613,9 +609,7 @@ def get_number_of_coupling_conditions(key):
                 )
                 _dump_mesh_items(yaml_dict, section_name, bc_list)
 
-        # Add additional element sections (e.g. STRUCTURE KNOTVECTORS)
-        # We only need to to this on the "real" elements as the imported ones already have their
-        # dat sections.
+        # Add additional element sections, e.g., for NURBS knot vectors.
         for element in self.elements:
             element.dump_element_specific_section(yaml_dict)
 
@@ -707,7 +701,7 @@ def get_git_data(repo):
                     f"// git date:   {cubitpy_git_date}\n"
                 )
 
-        string_line = "// " + "".join(["-" for _i in range(_mpy.dat_len_section - 3)])
+        string_line = "// " + "".join(["-"] * 80)
 
         # If needed, append the contents of the script.
         if add_script:

src/meshpy/four_c/run_four_c.py

@@ -54,7 +54,7 @@ def run_four_c(
     Args
     ----
     input_file: str
-        Path to the dat file on the filesystem
+        Path to the input file on the filesystem
     output_dir: str
         Directory where the simulation should be performed (will be created if
         it does not exist)

tests/conftest.py

@@ -231,7 +231,7 @@ def _get_corresponding_reference_file_path(
             reference_file_base_name: Basename of reference file, if none is
                 provided the current test name is utilized
             additional_identifier: Additional identifier for reference file, by default none
-            extension: Extension of reference file, by default ".dat"
+            extension: Extension of reference file, by default ".4C.yaml"
 
         Returns:
             Path to reference file.
@@ -305,9 +305,6 @@ def _assert_results_equal(
             elif reference.suffix in [".vtk", ".vtu"]:
                 compare_vtk_files(reference, result, rtol, atol)
                 return
-            elif reference.suffix == ".dat":
-                # Do nothing here as the mechanism below will compare the dat files.
-                pass
             else:
                 raise NotImplementedError(
                     f"Comparison is not yet implemented for {reference.suffix} files."

tests/reference-files/test_meshpy_mesh_transformations_with_solid_dat.4C.yaml renamed to tests/reference-files/test_meshpy_mesh_transformations_with_solid_yaml.4C.yaml

@@ -24,8 +24,9 @@
 import numpy as np
 import pytest
 
-from meshpy.abaqus.beam import AbaqusBeamMaterial, generate_abaqus_beam
+from meshpy.abaqus.beam import generate_abaqus_beam
 from meshpy.abaqus.input_file import AbaqusBeamNormalDefinition, AbaqusInputFile
+from meshpy.abaqus.material import AbaqusBeamMaterial
 from meshpy.core.geometry_set import GeometrySet
 from meshpy.core.mesh import Mesh
 from meshpy.core.rotation import Rotation

tests/test_abaqus.py

@@ -64,11 +64,13 @@ def test_create_cubit_input_tutorial(
     """Test the creation of the solid input file for the tutorial."""
 
     # Create the tube for the tutorial.
-    result_path = tmp_path / "tutorial.dat"
+    result_path = tmp_path / "tutorial.4C.yaml"
     create_tube_tutorial(result_path)
 
     tutorial_path = (
-        reference_file_directory.parents[1] / "tutorial" / "4C_input_solid_tutorial.dat"
+        reference_file_directory.parents[1]
+        / "tutorial"
+        / "4C_input_solid_tutorial.4C.yaml"
     )
     assert_results_equal(tutorial_path, result_path, **ASSERT_RESULTS_EQUAL_TOL)
 

tests/test_create_cubit_input.py

@@ -52,8 +52,8 @@ def test_four_c_material_numbering(
     assert_results_equal, get_corresponding_reference_file_path
 ):
     """Test that materials can be added as strings to an input file (as is done
-    when importing dat files) and that the numbering with other added materials
-    does not lead to materials with double IDs."""
+    when importing input files) and that the numbering with other added
+    materials does not lead to materials with double IDs."""
 
     input_file = InputFile()
     input_file.add(
@@ -331,9 +331,9 @@ def test_four_c_locsys_condition(
 ):
     """Test case for point locsys condition for beams.
 
-    The testcase is adapted from to beam3r_herm2line3_static_locsys.dat.
-    However it has a simpler material, and an additional line locsys
-    condition.
+    The testcase is adapted from to
+    beam3r_herm2line3_static_locsys.4C.yaml. However it has a simpler
+    material, and an additional line locsys condition.
     """
 
     # Create the input file with function and material.

tests/test_four_c.py

@@ -143,9 +143,9 @@ def test_four_c_simulation_honeycomb_sphere(
 ):
     """Create the same honeycomb mesh as defined in 4C/tests/input_files/beam3r
     _herm2lin3_static_point_coupling_BTSPH_contact_stent_honeycomb_stretch_r01_
-    circ10.dat The honeycomb beam is in contact with a rigid sphere, the sphere
-    is moved compared to the original test file, since there are some problems
-    with the contact convergence.
+    circ10.4C.yaml The honeycomb beam is in contact with a rigid sphere, the
+    sphere is moved compared to the original test file, since there are some
+    problems with the contact convergence.
 
     The sphere is imported as an existing mesh.
     """