Minor style and comments fix

tdegeus · Oct 14, 2020 · a8d6041 · a8d6041
1 parent edd349f
commit a8d6041
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 8 deletions.
diff --git a/examples/friction.cpp b/examples/friction.cpp
@@ -140,6 +140,7 @@ class System {
 
         m_Eps = m_quad.AllocateQtensor<2>(0.0);
         m_Sig = m_quad.AllocateQtensor<2>(0.0);
+
         // --------
         // material
         // --------

diff --git a/include/GMatElastoPlasticQPot/Cartesian2d.h b/include/GMatElastoPlasticQPot/Cartesian2d.h
@@ -149,7 +149,7 @@ class Cusp
     double epsp() const;   // "plastic strain" (mean of currentYieldLeft and currentYieldRight)
     double energy() const; // potential energy
 
-    // Check that 'the particle' is "n" wells from the far-left/right
+    // Check that 'the particle' is at least "n" wells from the far-left/right
     bool checkYieldBoundLeft(size_t n = 0) const;
     bool checkYieldBoundRight(size_t n = 0) const;
 
@@ -204,7 +204,7 @@ class Smooth
     double epsp() const;   // "plastic strain" (mean of currentYieldLeft and currentYieldRight)
     double energy() const; // potential energy
 
-    // Check that 'the particle' is "n" wells from the far-left/right
+    // Check that 'the particle' is at least "n" wells from the far-left/right
     bool checkYieldBoundLeft(size_t n = 0) const;
     bool checkYieldBoundRight(size_t n = 0) const;
 

diff --git a/python/main.cpp b/python/main.cpp
@@ -174,13 +174,13 @@ auto add_common_members_array(T& self)
         .def(
             "checkYieldBoundLeft",
             &SM::Array<rank>::checkYieldBoundLeft,
-            "Check that the particle is 'n' wells from the far-left.",
+            "Check that 'the particle' is at least 'n' wells from the far-left.",
             py::arg("n") = 0)
 
         .def(
             "checkYieldBoundRight",
             &SM::Array<rank>::checkYieldBoundRight,
-            "Check that the particle is 'n' wells from the far-left.",
+            "Check that 'the particle' is at least 'n' wells from the far-right.",
             py::arg("n") = 0)
 
         .def(
@@ -376,13 +376,13 @@ PYBIND11_MODULE(GMatElastoPlasticQPot, m)
         .def(
             "checkYieldBoundLeft",
             &SM::Cusp::checkYieldBoundLeft,
-            "Check that the particle is 'n' wells from the far-left.",
+            "Check that 'the particle' is at least 'n' wells from the far-left.",
             py::arg("n") = 0)
 
         .def(
             "checkYieldBoundRight",
             &SM::Cusp::checkYieldBoundRight,
-            "Check that the particle is 'n' wells from the far-left.",
+            "Check that 'the particle' is at least 'n' wells from the far-right.",
             py::arg("n") = 0)
 
         .def(
@@ -439,13 +439,13 @@ PYBIND11_MODULE(GMatElastoPlasticQPot, m)
         .def(
             "checkYieldBoundLeft",
             &SM::Smooth::checkYieldBoundLeft,
-            "Check that the particle is 'n' wells from the far-left.",
+            "Check that 'the particle' is at least 'n' wells from the far-left.",
             py::arg("n") = 0)
 
         .def(
             "checkYieldBoundRight",
             &SM::Smooth::checkYieldBoundRight,
-            "Check that the particle is 'n' wells from the far-left.",
+            "Check that 'the particle' is at least 'n' wells from the far-right.",
             py::arg("n") = 0)
 
         .def(