diff --git a/Quadrature.py b/Quadrature.py index 1091d776753e4b0084f22d7e4b9b01ab6e7e531f..7af958a0062e903f71b16a3b5baacbec9b474c6b 100644 --- a/Quadrature.py +++ b/Quadrature.py @@ -1,5 +1,6 @@ # -*- coding: utf-8 -*- -""" +"""Module for quadrature. + @author: Laura C. Kühle """ @@ -26,8 +27,9 @@ class Quadrature(ABC): Weights used for approximation calculation. """ - def __init__(self, config): - """Initializes Quadrature. + + def __init__(self, config: dict) -> None: + """Initialize Quadrature. Parameters ---------- @@ -37,8 +39,8 @@ class Quadrature(ABC): """ self._reset(config) - def _reset(self, config): - """Resets instance variables. + def _reset(self, config: dict) -> None: + """Reset instance variables. Parameters ---------- @@ -57,17 +59,17 @@ class Quadrature(ABC): @property def num_nodes(self) -> str: - """Returns number of nodes (evaluation points).""" + """Return number of nodes.""" return self._num_nodes @property def nodes(self) -> ndarray: - """Returns nodes (evaluation points).""" + """Return nodes.""" return self._nodes @property def weights(self) -> ndarray: - """Returns evaluation weights.""" + """Return evaluation weights.""" return self._weights @@ -86,8 +88,9 @@ class Gauss(Quadrature): Weights used for approximation calculation. """ - def _reset(self, config): - """Resets instance variables. + + def _reset(self, config: dict) -> None: + """Reset instance variables. Parameters ---------- @@ -103,6 +106,6 @@ class Gauss(Quadrature): self._nodes, self._weights = leg.leggauss(self._num_nodes) @property - def name(self): - """Returns string of class name.""" + def name(self) -> str: + """Return string of class name.""" return self.__class__.__name__ + str(self._num_nodes)