[BREAKING CHANGE] Renaming getElementType to elementType

tdegeus · Jul 14, 2023 · 4ff8d7c · 4ff8d7c
1 parent 782b7a5
commit 4ff8d7c
Show file tree

Hide file tree

Showing 20 changed files with 30 additions and 31 deletions.
diff --git a/docs/details/MeshHex8.rst b/docs/details/MeshHex8.rst
@@ -55,8 +55,8 @@ Mesh::Hex8::Regular::ndim()
 
 Return number of dimensions (= 2).
 
-Mesh::Hex8::Regular::getElementType()
--------------------------------------
+Mesh::Hex8::Regular::elementType()
+----------------------------------
 
 Return element-type.
 
@@ -150,8 +150,8 @@ Mesh::Hex8::FineLayer::h()
 
 Unit edge size (matches input).
 
-Mesh::Hex8::FineLayer::getElementType()
----------------------------------------
+Mesh::Hex8::FineLayer::elementType()
+------------------------------------
 
 Return element-type.
 

diff --git a/docs/details/MeshQuad4.rst b/docs/details/MeshQuad4.rst
@@ -43,8 +43,8 @@ Mesh::Quad4::Regular::ndim()
 
 Return number of dimensions (= 2).
 
-Mesh::Quad4::Regular::getElementType()
---------------------------------------
+Mesh::Quad4::Regular::elementType()
+-----------------------------------
 
 Return element-type.
 
@@ -148,8 +148,8 @@ Mesh::Quad4::FineLayer::h()
 
 Unit edge size (matches input).
 
-Mesh::Quad4::FineLayer::getElementType()
-----------------------------------------
+Mesh::Quad4::FineLayer::elementType()
+-------------------------------------
 
 Return element-type.
 

diff --git a/docs/details/MeshTri3.rst b/docs/details/MeshTri3.rst
@@ -43,8 +43,8 @@ Mesh::Tri3::Regular::ndim()
 
 Return number of dimensions (= 2).
 
-Mesh::Tri3::Regular::getElementType()
--------------------------------------
+Mesh::Tri3::Regular::elementType()
+----------------------------------
 
 Return element-type.
 

diff --git a/docs/details/figures/MeshHex8/FineLayer/paraview.py b/docs/details/figures/MeshHex8/FineLayer/paraview.py
@@ -23,7 +23,7 @@
 
 # write XDMF-file with metadata
 xdmf = pv.Mesh(
-    pv.Connectivity(fname, "/conn", mesh.getElementType(), mesh.conn.shape),
+    pv.Connectivity(fname, "/conn", mesh.elementType, mesh.conn.shape),
     pv.Coordinates(fname, "/coor", mesh.coor.shape),
 )
 

diff --git a/docs/details/figures/MeshHex8/FineLayer/paraview_nodesets.py b/docs/details/figures/MeshHex8/FineLayer/paraview_nodesets.py
@@ -118,7 +118,7 @@
 
 # write XDMF-file with metadata
 xdmf = pv.Mesh(
-    pv.Connectivity(fname, "/conn", mesh.getElementType(), mesh.conn.shape),
+    pv.Connectivity(fname, "/conn", mesh.elementType, mesh.conn.shape),
     pv.Coordinates(fname, "/coor", mesh.coor.shape),
 )
 

diff --git a/docs/details/figures/MeshHex8/Regular/paraview.py b/docs/details/figures/MeshHex8/Regular/paraview.py
@@ -17,6 +17,6 @@
 
 # write XDMF-file with metadata
 pv.Mesh(
-    pv.Connectivity(fname, "/conn", mesh.getElementType(), mesh.conn.shape),
+    pv.Connectivity(fname, "/conn", mesh.elementType, mesh.conn.shape),
     pv.Coordinates(fname, "/coor", mesh.coor.shape),
 ).write(os.path.splitext(fname)[0] + ".xdmf")
diff --git a/docs/details/figures/MeshHex8/Regular/paraview_nodesets.py b/docs/details/figures/MeshHex8/Regular/paraview_nodesets.py
@@ -118,7 +118,7 @@
 
 # write XDMF-file with metadata
 xdmf = pv.Mesh(
-    pv.Connectivity(fname, "/conn", mesh.getElementType(), mesh.conn.shape),
+    pv.Connectivity(fname, "/conn", mesh.elementType, mesh.conn.shape),
     pv.Coordinates(fname, "/coor", mesh.coor.shape),
 )
 

diff --git a/docs/details/figures/MeshQuad4/FineLayer/paraview.py b/docs/details/figures/MeshQuad4/FineLayer/paraview.py
@@ -23,7 +23,7 @@
 
 # write XDMF-file with metadata
 xdmf = pv.Mesh(
-    pv.Connectivity(fname, "/conn", mesh.getElementType(), mesh.conn.shape),
+    pv.Connectivity(fname, "/conn", mesh.elementType, mesh.conn.shape),
     pv.Coordinates(fname, "/coor", mesh.coor.shape),
 )
 

diff --git a/docs/details/figures/MeshQuad4/FineLayer/paraview_nodesets.py b/docs/details/figures/MeshQuad4/FineLayer/paraview_nodesets.py
@@ -54,7 +54,7 @@
 
 # write XDMF-file with metadata
 xdmf = pv.Mesh(
-    pv.Connectivity(fname, "/conn", mesh.getElementType(), mesh.conn.shape),
+    pv.Connectivity(fname, "/conn", mesh.elementType, mesh.conn.shape),
     pv.Coordinates(fname, "/coor", mesh.coor.shape),
 )
 

diff --git a/docs/details/figures/MeshQuad4/Regular/paraview.py b/docs/details/figures/MeshQuad4/Regular/paraview.py
@@ -17,6 +17,6 @@
 
 # write XDMF-file with metadata
 pv.Mesh(
-    pv.Connectivity(fname, "/conn", mesh.getElementType(), mesh.conn.shape),
+    pv.Connectivity(fname, "/conn", mesh.elementType, mesh.conn.shape),
     pv.Coordinates(fname, "/coor", mesh.coor.shape),
 ).write(os.path.splitext(fname)[0] + ".xdmf")
diff --git a/docs/details/figures/MeshQuad4/Regular/paraview_nodesets.py b/docs/details/figures/MeshQuad4/Regular/paraview_nodesets.py
@@ -54,7 +54,7 @@
 
 # write XDMF-file with metadata
 xdmf = pv.Mesh(
-    pv.Connectivity(fname, "/conn", mesh.getElementType(), mesh.conn.shape),
+    pv.Connectivity(fname, "/conn", mesh.elementType, mesh.conn.shape),
     pv.Coordinates(fname, "/coor", mesh.coor.shape),
 )
 

diff --git a/docs/details/figures/MeshTri3/Regular/paraview.py b/docs/details/figures/MeshTri3/Regular/paraview.py
@@ -17,6 +17,6 @@
 
 # write XDMF-file with metadata
 pv.Mesh(
-    pv.Connectivity(fname, "/conn", mesh.getElementType(), mesh.conn.shape),
+    pv.Connectivity(fname, "/conn", mesh.elementType, mesh.conn.shape),
     pv.Coordinates(fname, "/coor", mesh.coor.shape),
 ).write(os.path.splitext(fname)[0] + ".xdmf")
diff --git a/docs/details/figures/MeshTri3/Regular/paraview_nodesets.py b/docs/details/figures/MeshTri3/Regular/paraview_nodesets.py
@@ -54,7 +54,7 @@
 
 # write XDMF-file with metadata
 xdmf = pv.Mesh(
-    pv.Connectivity(fname, "/conn", mesh.getElementType(), mesh.conn.shape),
+    pv.Connectivity(fname, "/conn", mesh.elementType, mesh.conn.shape),
     pv.Coordinates(fname, "/coor", mesh.coor.shape),
 )
 

diff --git a/include/GooseFEM/Mesh.h b/include/GooseFEM/Mesh.h
@@ -252,9 +252,9 @@ class RegularBase {
      * The ElementType().
      * @return element type
      */
-    auto getElementType() const
+    auto elementType() const
     {
-        return derived_cast().getElementType_impl();
+        return derived_cast().elementType_impl();
     }
 
     /**

diff --git a/include/GooseFEM/MeshHex8.h b/include/GooseFEM/MeshHex8.h
@@ -69,7 +69,7 @@ class Regular : public RegularBase3d<Regular> {
         return m_nelz;
     }
 
-    ElementType getElementType_impl() const
+    ElementType elementType_impl() const
     {
         return ElementType::Hex8;
     }
@@ -885,7 +885,7 @@ class FineLayer : public RegularBase3d<FineLayer> {
     {
         return xt::amax(m_layer_nelz)();
     }
-    ElementType getElementType_impl() const
+    ElementType elementType_impl() const
     {
         return ElementType::Hex8;
     }

diff --git a/include/GooseFEM/MeshQuad4.h b/include/GooseFEM/MeshQuad4.h
@@ -79,7 +79,7 @@ class Regular : public RegularBase2d<Regular> {
         return m_nely;
     }
 
-    ElementType getElementType_impl() const
+    ElementType elementType_impl() const
     {
         return ElementType::Quad4;
     }
@@ -578,7 +578,7 @@ class FineLayer : public RegularBase2d<FineLayer> {
         return xt::sum(m_nhy)();
     }
 
-    ElementType getElementType_impl() const
+    ElementType elementType_impl() const
     {
         return ElementType::Quad4;
     }

diff --git a/include/GooseFEM/MeshTri3.h b/include/GooseFEM/MeshTri3.h
@@ -61,7 +61,7 @@ class Regular : public RegularBase2d<Regular> {
         return m_nely;
     }
 
-    ElementType getElementType_impl() const
+    ElementType elementType_impl() const
     {
         return ElementType::Tri3;
     }

diff --git a/python/MatrixDiagonal.hpp b/python/MatrixDiagonal.hpp
@@ -57,8 +57,7 @@ void init_MatrixDiagonal(py::module& m)
         py::arg("dofs")
     );
 
-    cls.def("set", &GooseFEM::MatrixDiagonal::set, py::arg("A"));
-    cls.def_property_readonly("data", &GooseFEM::MatrixDiagonal::data);
+    cls.def_property("data", &GooseFEM::MatrixDiagonal::data, &GooseFEM::MatrixDiagonal::set);
 
     cls.def("__repr__", [](const GooseFEM::MatrixDiagonal&) {
         return "<GooseFEM.MatrixDiagonal>";

diff --git a/python/Mesh.hpp b/python/Mesh.hpp
@@ -25,7 +25,7 @@ void register_Mesh_RegularBase(P& cls)
     cls.def_property_readonly("nelx", &C::nelx);
     cls.def_property_readonly("nely", &C::nely);
     cls.def_property_readonly("h", &C::h);
-    cls.def_property_readonly("elementType", &C::getElementType);
+    cls.def_property_readonly("elementType", &C::elementType);
     cls.def_property_readonly("coor", &C::coor);
     cls.def_property_readonly("conn", &C::conn);
     cls.def_property_readonly("dofs", &C::dofs);

diff --git a/tests/basic/Mesh.cpp b/tests/basic/Mesh.cpp
@@ -191,7 +191,7 @@ TEST_CASE("GooseFEM::Mesh", "Mesh.h")
     {
         GooseFEM::Mesh::Quad4::Regular mesh(2, 2, 10.0);
         auto s = GooseFEM::Mesh::edgesize(mesh.coor(), mesh.conn());
-        auto t = GooseFEM::Mesh::edgesize(mesh.coor(), mesh.conn(), mesh.getElementType());
+        auto t = GooseFEM::Mesh::edgesize(mesh.coor(), mesh.conn(), mesh.elementType());
         REQUIRE(xt::allclose(s, 10.0));
         REQUIRE(xt::allclose(t, 10.0));
     }