From 48af8aa1e6c43be2c4e06c120133e038a74f2a56 Mon Sep 17 00:00:00 2001 From: Sam Date: Mon, 15 Nov 2021 09:41:41 +0100 Subject: [PATCH] Docstrings --- src/compas_fd/solvers/solver.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/compas_fd/solvers/solver.py b/src/compas_fd/solvers/solver.py index 3fb23e33..52e340c4 100644 --- a/src/compas_fd/solvers/solver.py +++ b/src/compas_fd/solvers/solver.py @@ -18,7 +18,7 @@ def __init__(self, self.result = None def __call__(self) -> Result: - """Iteratively apply the solve algorithm.""" + """Iteratively apply the solver algorithm.""" for self.kcount in range(1, self.kmax + 1): self.solve() if self.is_converged: @@ -28,12 +28,12 @@ def __call__(self) -> Result: return self.result def solve(self) -> None: - """Apply solver algorithm for a single iteration.""" + """Apply the solver algorithm for a single iteration.""" raise NotImplementedError @property def is_converged(self) -> bool: - """Verify if all convergence criteria are met.""" + """Verify if convergence criteria are met.""" raise NotImplementedError def post_process(self) -> None: