Merge pull request #96 from tldr-group/feature-exit-after-iter_limit-reached

exit solve after iter_limit reached

Author: amirDahari1

docs/conf.py

@@ -84,6 +84,7 @@
 # a list of builtin themes.
 #
 html_theme = 'sphinx_rtd_theme'
+html_theme_path = ["_themes", ]
 
 # Theme options are theme-specific and customize the look and feel of a
 # theme further.  For a list of options available for each theme, see the

docs/requirements.txt

@@ -3,4 +3,7 @@ torch
 scipy
 matplotlib
 tifffile
-myst_parser
+myst_parser
+sphinx==5.3.0
+sphinx_rtd_theme==1.1.1
+readthedocs-sphinx-search==0.1.1

taufactor/taufactor.py

@@ -137,7 +137,7 @@ def solve(self, iter_limit=5000, verbose=True, conv_crit=2*10**-2):
 
         with torch.no_grad():
             start = timer()
-            while not self.converged:
+            while not self.converged and self.iter < iter_limit:
                 # find sum of all nearest neighbours
                 out = self.conc[:, 2:, 1:-1, 1:-1] + \
                     self.conc[:, :-2, 1:-1, 1:-1] + \
@@ -149,8 +149,7 @@ def solve(self, iter_limit=5000, verbose=True, conv_crit=2*10**-2):
                 out /= self.nn
                 # check convergence using criteria
                 if self.iter % 100 == 0:
-                    self.converged = self.check_convergence(
-                        verbose, conv_crit, start, iter_limit)
+                    self.converged = self.check_convergence(verbose, conv_crit)
                 # efficient way of adding flux to old conc with overrelaxation
                 out -= self.crop(self.conc, 1)
                 out *= self.cb[self.iter % 2]
@@ -161,7 +160,7 @@ def solve(self, iter_limit=5000, verbose=True, conv_crit=2*10**-2):
             self.end_simulation(iter_limit, verbose, start)
             return self.tau
 
-    def check_convergence(self, verbose, conv_crit, start, iter_limit):
+    def check_convergence(self, verbose, conv_crit):
         # print progress
         self.semi_converged, self.new_fl, err = self.check_vertical_flux(
             conv_crit)
@@ -276,8 +275,7 @@ def solve(self, iter_limit=5000, verbose=True, conv_crit=2*10**-2, D_0=1):
             out = out[:, 2:-2]
             out /= self.nn
             if self.iter % 50 == 0:
-                self.converged = self.check_convergence(
-                    verbose, conv_crit, start, iter_limit)
+                self.converged = self.check_convergence(verbose, conv_crit)
             out -= self.conc[:, 2:-2]
             out *= self.cb[self.iter % 2]
             self.conc[:, 2:-2] += out
@@ -441,16 +439,15 @@ def solve(self, iter_limit=5000, verbose=True, conv_crit=2*10**-2):
                 self.pre_factors[5][:, 1:-1, 1:-1, :-2]
             out /= self.nn
             if self.iter % 20 == 0:
-                self.converged = self.check_convergence(
-                    verbose, conv_crit, start, iter_limit)
+                self.converged = self.check_convergence(verbose, conv_crit)
             out -= self.crop(self.conc, 1)
             out *= self.cb[self.iter % 2]
             self.conc[:, 1:-1, 1:-1, 1:-1] += out
 
         self.end_simulation(iter_limit, verbose, start)
         return self.tau
 
-    def check_convergence(self, verbose, conv_crit, start, iter_limit):
+    def check_convergence(self, verbose, conv_crit):
         # print progress
         if self.iter % 100 == 0:
             self.semi_converged, self.new_fl, err = self.check_vertical_flux(