fix typos, incorrect ref to data, use of super, docs warnings, ...

Author: tomvanmele

src/compas_fea2/job/input_file.py

@@ -27,7 +27,7 @@ class InputFile(FEAData):
     """
 
     def __init__(self, problem, **kwargs):
-        super(InputFile, self).__init__(**kwargs)
+        super().__init__(**kwargs)
         self._registration = problem
         self._extension = None
         self.path = None
@@ -47,6 +47,7 @@ def model(self):
     # ==============================================================================
     # General methods
     # ==============================================================================
+
     def write_to_file(self, path=None):
         """Writes the InputFile to a file in a specified location.
 
@@ -76,5 +77,5 @@ class ParametersFile(InputFile):
     """Input file object for Optimizations."""
 
     def __init__(self, **kwargs):
-        super(ParametersFile, self).__init__(**kwargs)
-        raise NotImplementedError()
+        super().__init__(**kwargs)
+        raise NotImplementedError

src/compas_fea2/model/bcs.py

@@ -45,7 +45,7 @@
 class _BoundaryCondition(FEAData):
     """Base class for all zero-valued boundary conditions."""
 
-    __doc__ += docs
+    __doc__ += docs  # type: ignore
 
     def __init__(self, axes: str = "global", **kwargs):
         super().__init__(**kwargs)
@@ -94,7 +94,7 @@ def components(self) -> Dict[str, bool]:
         return {c: getattr(self, c) for c in ["x", "y", "z", "xx", "yy", "zz"]}
 
     @property
-    def __data__(self) -> Dict[str, any]:
+    def __data__(self) -> dict:
         return {
             "class": self.__class__.__base__.__name__,
             "axes": self._axes,
@@ -107,7 +107,7 @@ def __data__(self) -> Dict[str, any]:
         }
 
     @classmethod
-    def __from_data__(cls, data: Dict[str, any]):
+    def __from_data__(cls, data: dict):
         return cls(
             axes=data.get("axes", "global"),
             x=data.get("x", False),
@@ -122,7 +122,8 @@ def __from_data__(cls, data: Dict[str, any]):
 class GeneralBC(_BoundaryCondition):
     """Customized boundary condition."""
 
-    __doc__ += docs
+    __doc__ += docs  # type: ignore
+
     __doc__ += """
 Additional Parameters
 ---------------------
@@ -153,7 +154,7 @@ def __init__(self, x: bool = False, y: bool = False, z: bool = False, xx: bool =
 class FixedBC(_BoundaryCondition):
     """A fixed nodal displacement boundary condition."""
 
-    __doc__ += docs
+    __doc__ += docs  # type: ignore
 
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
@@ -168,7 +169,7 @@ def __init__(self, **kwargs):
 class FixedBCX(_BoundaryCondition):
     """A fixed nodal displacement boundary condition along and around X."""
 
-    __doc__ += docs
+    __doc__ += docs  # type: ignore
 
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
@@ -179,7 +180,7 @@ def __init__(self, **kwargs):
 class FixedBCY(_BoundaryCondition):
     """A fixed nodal displacement boundary condition along and around Y."""
 
-    __doc__ += docs
+    __doc__ += docs  # type: ignore
 
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
@@ -190,7 +191,7 @@ def __init__(self, **kwargs):
 class FixedBCZ(_BoundaryCondition):
     """A fixed nodal displacement boundary condition along and around Z."""
 
-    __doc__ += docs
+    __doc__ += docs  # type: ignore
 
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
@@ -201,7 +202,7 @@ def __init__(self, **kwargs):
 class PinnedBC(_BoundaryCondition):
     """A pinned nodal displacement boundary condition."""
 
-    __doc__ += docs
+    __doc__ += docs  # type: ignore
 
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
@@ -213,7 +214,7 @@ def __init__(self, **kwargs):
 class ClampBCXX(PinnedBC):
     """A pinned nodal displacement boundary condition clamped in XX."""
 
-    __doc__ += docs
+    __doc__ += docs  # type: ignore
 
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
@@ -223,7 +224,7 @@ def __init__(self, **kwargs):
 class ClampBCYY(PinnedBC):
     """A pinned nodal displacement boundary condition clamped in YY."""
 
-    __doc__ += docs
+    __doc__ += docs  # type: ignore
 
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
@@ -233,7 +234,7 @@ def __init__(self, **kwargs):
 class ClampBCZZ(PinnedBC):
     """A pinned nodal displacement boundary condition clamped in ZZ."""
 
-    __doc__ += docs
+    __doc__ += docs  # type: ignore
 
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
@@ -243,7 +244,7 @@ def __init__(self, **kwargs):
 class RollerBCX(PinnedBC):
     """A pinned nodal displacement boundary condition released in X."""
 
-    __doc__ += docs
+    __doc__ += docs  # type: ignore
 
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
@@ -253,7 +254,7 @@ def __init__(self, **kwargs):
 class RollerBCY(PinnedBC):
     """A pinned nodal displacement boundary condition released in Y."""
 
-    __doc__ += docs
+    __doc__ += docs  # type: ignore
 
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
@@ -263,7 +264,7 @@ def __init__(self, **kwargs):
 class RollerBCZ(PinnedBC):
     """A pinned nodal displacement boundary condition released in Z."""
 
-    __doc__ += docs
+    __doc__ += docs  # type: ignore
 
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
@@ -273,7 +274,7 @@ def __init__(self, **kwargs):
 class RollerBCXY(PinnedBC):
     """A pinned nodal displacement boundary condition released in X and Y."""
 
-    __doc__ += docs
+    __doc__ += docs  # type: ignore
 
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
@@ -284,7 +285,7 @@ def __init__(self, **kwargs):
 class RollerBCYZ(PinnedBC):
     """A pinned nodal displacement boundary condition released in Y and Z."""
 
-    __doc__ += docs
+    __doc__ += docs  # type: ignore
 
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
@@ -295,7 +296,7 @@ def __init__(self, **kwargs):
 class RollerBCXZ(PinnedBC):
     """A pinned nodal displacement boundary condition released in X and Z."""
 
-    __doc__ += docs
+    __doc__ += docs  # type: ignore
 
     def __init__(self, **kwargs):
         super().__init__(**kwargs)

src/compas_fea2/model/ics.py

@@ -15,7 +15,7 @@ def __init__(self, **kwargs):
         super(_InitialCondition, self).__init__(**kwargs)
 
     @property
-    def __data__(self):
+    def __data__(self) -> dict:
         return {
             "type": self.__class__.__base__.__name__,
         }
@@ -111,11 +111,7 @@ def stress(self, value):
     @property
     def __data__(self):
         data = super().__data__
-        data.update(
-            {
-                "stress": self._s,
-            }
-        )
+        data.update({"stress": self._s})
         return data
 
     @classmethod

src/compas_fea2/model/materials/concrete.py

@@ -45,7 +45,7 @@ class Concrete(_Material):
     """
 
     def __init__(self, *, fck, E=None, v=None, density=None, fr=None, units=None, **kwargs):
-        super(Concrete, self).__init__(density=density, **kwargs)
+        super().__init__(density=density, **kwargs)
 
         # Ensure small increment for stress-strain curve
         de = 0.0001
@@ -107,9 +107,7 @@ def __str__(self):
 G   : {}
 fck : {}
 fr  : {}
-""".format(
-            self.name, self.density, self.E, self.v, self.G, self.fck, self.fr
-        )
+""".format(self.name, self.density, self.E, self.v, self.G, self.fck, self.fr)
 
     @property
     def __data__(self):
@@ -140,9 +138,9 @@ def __from_data__(cls, data):
     @classmethod
     def C20_25(cls, units, **kwargs):
         if not units:
-            units = u.get_default_units()
+            units = u(system="SI_mm")
         elif not isinstance(units, UnitRegistry):
-            units = u.get_units(units)
+            units = u(units)
 
         return cls(fck=25 * units.MPa, E=30 * units.GPa, v=0.17, density=2400 * units("kg/m**3"), name="C20/25", **kwargs)
 
@@ -196,7 +194,7 @@ class ConcreteSmearedCrack(_Material):
     """
 
     def __init__(self, *, E, v, density, fc, ec, ft, et, fr=[1.16, 0.0836], **kwargs):
-        super(ConcreteSmearedCrack, self).__init__(density=density, **kwargs)
+        super().__init__(density=density, **kwargs)
 
         self.E = E
         self.v = v
@@ -228,9 +226,7 @@ def __str__(self):
 ft : {}
 et : {}
 fr : {}
-""".format(
-            self.name, self.density, self.E, self.v, self.G, self.fc, self.ec, self.ft, self.et, self.fr
-        )
+""".format(self.name, self.density, self.E, self.v, self.G, self.fc, self.ec, self.ft, self.et, self.fr)
 
     @property
     def __data__(self):
@@ -303,7 +299,7 @@ class ConcreteDamagedPlasticity(_Material):
     """
 
     def __init__(self, *, E, v, density, damage, hardening, stiffening, **kwargs):
-        super(ConcreteDamagedPlasticity, self).__init__(density=density, **kwargs)
+        super().__init__(density=density, **kwargs)
 
         self.E = E
         self.v = v

src/compas_fea2/model/materials/material.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from compas_fea2.base import FEAData
 
 
@@ -37,15 +39,11 @@ class _Material(FEAData):
 
     """
 
-    def __init__(self, density: float, expansion: float = None, **kwargs):
+    def __init__(self, density: Optional[float] = None, expansion: Optional[float] = None, **kwargs):
         super().__init__(**kwargs)
         self.density = density
         self.expansion = expansion
 
-    @property
-    def key(self) -> int:
-        return self._key
-
     @property
     def model(self):
         return self._registration
@@ -77,9 +75,7 @@ def __str__(self) -> str:
 name        : {}
 density     : {}
 expansion   : {}
-""".format(
-            self.__class__.__name__, len(self.__class__.__name__) * "-", self.name, self.density, self.expansion
-        )
+""".format(self.__class__.__name__, len(self.__class__.__name__) * "-", self.name, self.density, self.expansion)
 
     def __html__(self) -> str:
         return """<html>
@@ -138,7 +134,21 @@ class ElasticOrthotropic(_Material):
         Shear modulus Gzx in z-x directions.
     """
 
-    def __init__(self, Ex: float, Ey: float, Ez: float, vxy: float, vyz: float, vzx: float, Gxy: float, Gyz: float, Gzx: float, density: float, expansion: float = None, **kwargs):
+    def __init__(
+        self,
+        Ex: float,
+        Ey: float,
+        Ez: float,
+        vxy: float,
+        vyz: float,
+        vzx: float,
+        Gxy: float,
+        Gyz: float,
+        Gzx: float,
+        density: float,
+        expansion: Optional[float] = None,
+        **kwargs,
+    ):
         super().__init__(density=density, expansion=expansion, **kwargs)
         self.Ex = Ex
         self.Ey = Ey
@@ -152,7 +162,7 @@ def __init__(self, Ex: float, Ey: float, Ez: float, vxy: float, vyz: float, vzx:
 
     @property
     def __data__(self):
-        data = super().__data__()
+        data = super().__data__
         data.update(
             {
                 "Ex": self.Ex,
@@ -241,7 +251,7 @@ class ElasticIsotropic(_Material):
 
     """
 
-    def __init__(self, E: float, v: float, density: float, expansion: float = None, **kwargs):
+    def __init__(self, E: float, v: float, density: float, expansion: Optional[float] = None, **kwargs):
         super().__init__(density=density, expansion=expansion, **kwargs)
         self.E = E
         self.v = v
@@ -272,9 +282,7 @@ def __str__(self) -> str:
 E : {}
 v : {}
 G : {}
-""".format(
-            self.name, self.density, self.expansion, self.E, self.v, self.G
-        )
+""".format(self.name, self.density, self.expansion, self.E, self.v, self.G)
 
     @property
     def G(self) -> float:
@@ -284,7 +292,7 @@ def G(self) -> float:
 class Stiff(_Material):
     """Elastic, very stiff and massless material."""
 
-    def __init__(self, *, density: float, expansion: float = None, name: str = None, **kwargs):
+    def __init__(self, *, density: float, expansion: Optional[float] = None, name: Optional[str] = None, **kwargs):
         raise NotImplementedError()
 
 
@@ -318,13 +326,13 @@ class ElasticPlastic(ElasticIsotropic):
         in the form of strain/stress value pairs.
     """
 
-    def __init__(self, *, E: float, v: float, density: float, strain_stress: list[tuple[float, float]], expansion: float = None, **kwargs):
+    def __init__(self, *, E: float, v: float, density: float, strain_stress: list[tuple[float, float]], expansion: Optional[float] = None, **kwargs):
         super().__init__(E=E, v=v, density=density, expansion=expansion, **kwargs)
         self.strain_stress = strain_stress
 
     @property
     def __data__(self):
-        data = super().__data__()
+        data = super().__data__
         data.update(
             {
                 "strain_stress": self.strain_stress,
@@ -355,9 +363,7 @@ def __str__(self) -> str:
 G  : {}
 
 strain_stress : {}
-""".format(
-            self.name, self.density, self.expansion, self.E, self.v, self.G, self.strain_stress
-        )
+""".format(self.name, self.density, self.expansion, self.E, self.v, self.G, self.strain_stress)
 
 
 # ==============================================================================