Change the visibility of the helpers in the mechanics-module from private to public

CHANGELOG.md

@@ -18,6 +18,7 @@ All notable changes to this project will be documented in this file. The format
 - Change the internal initialization of `field = Field(region, values=1, dtype=None)` values from `field.values = np.ones(shape) * values` to `field = np.full(shape, fill_value=values, dtype=dtype)`. This enforces `field = Field(region, values=1)` to return the gradient array with data-type `int` which was of type `float` before.
 - Initialize empty matrices of `SolidBodyForce`, `SolidBodyGravity` and `PointLoad` with `dtype=float`.
 - Don't multiply the assembled vectors of `SolidBodyForce`, `SolidBodyGravity` and `PointLoad` by `-1.0`.
+- Change the visibility of the internal helpers `Assemble`, `Evaluate` and `Results` of the mechanics-module `felupe.mechanics` from private to public.
 
 ### Deprecated
 - Deprecate `SolidBodyGravity`, `SolidBodyForce` should be used instead.

docs/felupe/mechanics.rst

@@ -14,12 +14,6 @@ Mechanics
    SolidBodyPressure
    SolidBodyForce
 
-**State Variables**
-
-.. autosummary::
-
-   StateNearlyIncompressible
-
 **Steps and Jobs**
 
 .. autosummary::
@@ -35,6 +29,15 @@ Mechanics
    PointLoad
    MultiPointConstraint
    MultiPointContact
+
+**Helpers for Custom Items and State Variables**
+
+.. autosummary::
+
+   StateNearlyIncompressible
+   mechanics.Assemble
+   mechanics.Evaluate
+   mechanics.Results
 
 **Detailed API Reference**
 
@@ -48,11 +51,6 @@ Mechanics
    :undoc-members:
    :show-inheritance:
 
-.. autoclass:: felupe.StateNearlyIncompressible
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 .. autoclass:: felupe.SolidBodyForce
    :members:
    :undoc-members:
@@ -92,3 +90,23 @@ Mechanics
    :members:
    :undoc-members:
    :inherited-members:
+
+.. autoclass:: felupe.StateNearlyIncompressible
+   :members:
+   :undoc-members:
+   :inherited-members:
+
+.. autoclass:: felupe.mechanics.Assemble
+   :members:
+   :undoc-members:
+   :inherited-members:
+
+.. autoclass:: felupe.mechanics.Evaluate
+   :members:
+   :undoc-members:
+   :inherited-members:
+
+.. autoclass:: felupe.mechanics.Results
+   :members:
+   :undoc-members:
+   :inherited-members:

src/felupe/mechanics/__init__.py

@@ -1,5 +1,5 @@
 from ._curve import CharacteristicCurve
-from ._helpers import StateNearlyIncompressible
+from ._helpers import Assemble, Evaluate, Results, StateNearlyIncompressible
 from ._item import FormItem
 from ._job import Job
 from ._multipoint import MultiPointConstraint, MultiPointContact
@@ -12,11 +12,14 @@
 from ._step import Step
 
 __all__ = [
+    "Assemble",
     "CharacteristicCurve",
+    "Evaluate",
     "FormItem",
     "StateNearlyIncompressible",
     "Job",
     "PointLoad",
+    "Results",
     "SolidBody",
     "SolidBodyGravity",
     "SolidBodyForce",

src/felupe/mechanics/_helpers.py

@@ -24,7 +24,7 @@
 
 
 class Assemble:
-    "A class with methods for assembling vectors and matrices of a SolidBody."
+    "A class with methods for assembling vectors and matrices of an Item."
 
     def __init__(self, vector, matrix, multiplier=None):
         self.vector = vector
@@ -33,7 +33,7 @@ def __init__(self, vector, matrix, multiplier=None):
 
 
 class Evaluate:
-    "A class with evaluate methods of a SolidBody."
+    "A class with evaluate methods of an Item."
 
     def __init__(self, gradient, hessian, cauchy_stress=None, kirchhoff_stress=None):
         self.gradient = gradient
@@ -45,7 +45,7 @@ def __init__(self, gradient, hessian, cauchy_stress=None, kirchhoff_stress=None)
 
 
 class Results:
-    "A class with intermediate results of a SolidBody."
+    "A class with intermediate results of an Item."
 
     def __init__(self, stress=False, elasticity=False):
         self.force = None