Merge pull request #37 from adtzlr/simplify

Simplify the code

CHANGELOG.md

@@ -3,6 +3,12 @@ All notable changes to this project will be documented in this file. The format
 
 ## [Unreleased]
 
+## [1.0.3] - 2023-03-15
+
+### Changed
+- Simplify the source code: Remove unused lines of code, To-Do's from function or class docstrings, unify file docstrings. Trim the header printed by `Model`.
+- Build HTML and PDF logfiles only if `Settings.logpdf=True` (Pandoc and LaTeX must be installed). Otherwise, only the Markdown logfile `analysis.md` for `Model(logfile=True)` is created (no Pandoc install required).
+
 ## [1.0.2] - 2023-03-13
 
 ### Added

src/trusspy/__about__.py

@@ -1 +1 @@
-__version__ = "1.0.2"
+__version__ = "1.0.3"

src/trusspy/core/analysis.py

@@ -16,64 +16,48 @@ class Analysis:
     U : None
         placeholder for 2d-array with total displacement vector at the end of the inc.
         `U.shape = (nnodes, ndim)`. To get Ux,Uy,Uz of node i type: `U[i]`
-
     U0 : None
-        placeholder for 2d-array with total displacement vector at the beginning of the inc.
-        `U0.shape = (nnodes, ndim)`. To get U0x,U0y,U0z of node i type: `U0[i]`
-
+        placeholder for 2d-array with total displacement vector at the beginning of the
+        inc. `U0.shape = (nnodes, ndim)`. To get U0x,U0y,U0z of node i type: `U0[i]`
     r : None
         placeholder for 2d-array with internal force vector
         `r.shape = (nnodes, ndim)`. To get rx,ry,rz of node i type: `r[i]`
-
     g : None
         placeholder for 2d-array with equilibrium vector
         `g.shape = (nnodes, ndim)`. To get gx,gy,gz of node i type: `g[i]`
-
     K : None
         placeholder for 4d-array with stiffness matrix
         `K.shape = (nnodes,nnodes,ndim,ndim)`. To get K with shape (ndim,ndim)
         between force of node i w.r.t. displacement of node j type K[i,j].
-
     stretch : None
         placeholder for 2d-array with stretch vector
         `stretch.shape = (nelems, 1)`. To get stretch of element i
         type: `stretch[i]`
-
     element_force : None
         placeholder for 2d-array with element force vector
         `element_force.shape = (nelems, 1)`. To get element_force of element i
         type: `element_force[i]`
-
     element_stress : None
         placeholder for 2d-array with element stress vector
         `element_stress.shape = (nelems, 1)`. To get element_stress of element i
         type: `element_stress[i]`
-
     element_stress0 : None
-        placeholder for 2d-array with element stress vector at the beginning of the increment
-        `element_stress0.shape = (nelems, 1)`. To get element_stress0 of element i
-        type: `element_stress0[i]`
-
+        placeholder for 2d-array with element stress vector at the beginning of the
+        increment ``element_stress0.shape = (nelems, 1)``. To get element_stress0 of
+        element ``i`` type: ``element_stress0[i]``.
     DOF0 : None
         placeholder for indices of inactive (locked) degree of freedoms
-
     DOF1 : None
         placeholder for indices of active (free) degree of freedoms
-
     Ured : None
         placeholder for reduced dispaclement vector
         (only active components of U)
-
     Vred : None
         placeholder for reduced dispaclement vector
         (only active components of V)
-
     state_v : None
         placeholder for state variable vector
 
-    Todo
-    ----
-    * simplify reduced set with DOF1 read/write options
     """
 
     def __init__(self):
@@ -122,9 +106,6 @@ def build(self, nnodes, nelems, ndim, DOF0, DOF1, nstatev=0):
         ValueError : Result is not empty and can't be built.
             Dimensions already set.
 
-        Todo
-        ----
-        * simplify reduced slice read/write operations
         """
         if self.U is None:
             self.step = 1

src/trusspy/core/boundary.py

@@ -27,9 +27,6 @@ class BoundaryU:
         Array of boundary components: `array([U1, U2, U3])`.
         Set 1 for active (free) DOF and 0 for inactive (locked) DOF.
 
-    Todo
-    ----
-    - rename to DOFState or something similar
     """
 
     def __init__(self, node, values):

src/trusspy/core/element.py

@@ -11,24 +11,6 @@
 class Element:
     """Element class.
 
-    Parameter
-    ---------
-    label : int
-        Element ID number
-    conn : array_like
-        List of Element connectivity : `[Node 1, Node 2]`
-
-    elem_type : int, optional
-        Element Type. (default is 1 for truss)
-    mat_type : int, optional
-        Material Type. (default is 1 for linear-elastic)
-    material_properties : array_like, optional
-        List with material parameters,
-        e.g. [Young's modulus, Thermal expansion coefficient] (default is [])
-    geometric_properties : array_like, optional
-        List with geometric parameters,
-        e.g. [Section area] (default is [])
-
     Attributes
     ----------
     label : int
@@ -46,11 +28,6 @@ class Element:
         List with geometric parameters,
         e.g. [Section area] (default is [])
 
-    Todo
-    ----
-    + DONE rewrite material parameter storage
-    + DONE material properties: type, mechanical and thermal parameter
-    + DONE geometric porperties: section area
     """
 
     def __init__(
@@ -64,6 +41,27 @@ def __init__(
         mprop=None,
         gprop=None,
     ):
+        """Initialize an instance of the Element class.
+
+        Parameters
+        ----------
+        label : int
+            Element ID number
+        conn : array_like
+            List of Element connectivity ``[Node 1, Node 2]``.
+        elem_type : int, optional
+            Element Type (default is 1 for "truss").
+        mat_type : int, optional
+            Material Type (default is 1 for "linear-elastic").
+        material_properties : array_like, optional
+            List with material parameters,
+            e.g. ``[Young's modulus, Thermal expansion coefficient]`` (default is
+            [np.nan]).
+        geometric_properties : array_like, optional
+            List with geometric parameters,
+            e.g. ``[Section area]`` (default is [np.nan]).
+
+        """
 
         self.label = label
         self.conn = np.array(conn)
@@ -89,11 +87,3 @@ def __init__(
             self.geometric_properties = gprop
         else:
             self.geometric_properties = geometric_properties
-
-    # def get_NE(self):
-    #    """get end node of element"""
-    #    return self.conn[1]
-
-    # def get_NA(self):
-    #    """get begin node of element"""
-    #    return self.conn[0]

src/trusspy/core/external_force.py

@@ -11,25 +11,26 @@
 class ExternalForce:
     """External Force class.
 
-    Parameter
-    ---------
-    node : int
-        Node ID number
-    force : array_like
-        List of Force components: `[F1, F2, F3]`
-
     Attributes
     ----------
     node : int
-        Node ID number
+        The node ID number,
     force : ndarray
-        Array containing Force components `array([F1, F2, F3])`
+        Array containing force components ``array([F1, F2, F3])``.
 
-    TODO's
-    ------
-    - add steps/stages by extending `force`
     """
 
     def __init__(self, node, force):
+        """External Force class.
+
+        Parameters
+        ----------
+        node : int
+            The node ID number.
+        force : array_like
+            List of Force components ``[F1, F2, F3]``.
+
+        """
+
         self.node = node
         self.force = np.array(force, dtype=float)

src/trusspy/core/node.py

@@ -11,26 +11,26 @@
 class Node:
     """Node class.
 
-    Parameter
-    ---------
-    label : int
-        Node ID number
-    coord : array_like
-        List of node coordinates: `[X, Y, Z]`
-
     Attributes
     ----------
     label : int
         Node ID number
     coord : ndarray
-        List of node coordinates: `[X, Y, Z]`
+        List of node coordinates: ``[X, Y, Z]``
 
-    Todo
-    ----
-    - add undeformed/deformed coordinates (useful?)
-    - copy deformed coordinates to result class at the end of each increment
     """
 
     def __init__(self, label, coord):
+        """Node class.
+
+        Parameters
+        ----------
+        label : int
+            Node ID number
+        coord : array_like
+            List of node coordinates: ``[X, Y, Z]``
+
+        """
+
         self.label = label
         self.coord = np.array(coord)

src/trusspy/elements/element_definition.py

@@ -39,7 +39,6 @@ def truss(
     dx0 = dX + dU0
 
     # elemental normal vector in deformed configuration
-    n0 = dx / np.linalg.norm(dx0)
     n = dx / np.linalg.norm(dx)
 
     # elemental length in undeformed and deformed configuration