Return the rms from XRotor.operate instead of boolean to quantify convergence.

Author: danieldevriesdarcorp

setup.py

@@ -24,7 +24,7 @@
 from setuptools.extension import Extension
 from setuptools.command.build_ext import build_ext
 
-version = '0.0.7'
+version = '0.0.8'
 
 options = {k: 'OFF' for k in ['--opt', '--debug', '--cuda']}
 for flag in options.keys():

src/fortran/interface.f90

@@ -96,7 +96,7 @@ subroutine set_case(&
     end subroutine set_case
 
     function operate(spec, val) bind(c, name='operate')
-        logical(c_bool) :: operate
+        real(c_float) :: operate
         integer(c_int), intent(in) :: spec
         real(c_float),  intent(in) :: val
 
@@ -110,11 +110,11 @@ function operate(spec, val) bind(c, name='operate')
             call aper(ctxt, 1, 2, ctxt%loprini)
         else
             print *, 'Unknown value for spec. Should be 1 to specify rpm, or 2 to specify thrust.'
-            operate = .false.
+            operate = 1.0
             return
         end if
 
-        operate = ctxt%conv
+        operate = ctxt%rms
     end function operate
 
     subroutine show() bind(c, name='show')

src/xrotor/test.py

@@ -94,12 +94,12 @@ def test_solve_for_rpm(self):
         """
         xr = XRotor()
         xr.case = Case.from_dict(case)
-        conv = xr.operate(1, 2000)
+        rms = xr.operate(1, 2000)
         perf = xr.performance
 
         print_perf(perf)
 
-        self.assertTrue(conv)
+        self.assertTrue(rms < 1.0e-7)
         self.assertAlmostEqual(perf.rpm, 2000, 0)
         self.assertAlmostEqual(perf.thrust, 481, 0)
         self.assertAlmostEqual(perf.torque, 105, 0)
@@ -117,12 +117,12 @@ def test_solve_for_thrust(self):
         """
         xr = XRotor()
         xr.case = Case.from_dict(case)
-        conv = xr.operate(2, 500)
+        rms = xr.operate(2, 500)
         perf = xr.performance
 
         print_perf(perf)
 
-        self.assertTrue(conv)
+        self.assertTrue(rms < 1.0e-7)
         self.assertAlmostEqual(perf.rpm, 2019, 0)
         self.assertAlmostEqual(perf.thrust, 500, 0)
         self.assertAlmostEqual(perf.torque, 107, 0)

src/xrotor/xrotor.py

@@ -50,7 +50,7 @@ def __init__(self):
         self._lib = cdll.LoadLibrary(self._lib_path)
 
         self._lib.get_print.restype = c_bool
-        self._lib.operate.restype = c_bool
+        self._lib.operate.restype = c_float
 
         self._lib.init()
         self._case: Case = None
@@ -133,10 +133,10 @@ def operate(self, specify, value):
 
         Returns
         -------
-        conv : bool
-            True is XRotor converged.
+        rms : float
+            Root-mean-squared error of XRotor's convergence. XRotor considers itself converged if rms < 1.0e-7.
         """
-        return self._lib.operate(byref(c_int(specify)), byref(c_float(value)))
+        return float(self._lib.operate(byref(c_int(specify)), byref(c_float(value))))
 
     def print_case(self):
         """Print the characteristics of the run case at the last operating point to the terminal."""