Merged proof_assertions_description()

Author: lisawim

pySDC/implementations/problem_classes/Battery.py

@@ -63,7 +63,7 @@ def eval_f(self, u, t):
 
         t_switch = np.inf if self.t_switch is None else self.t_switch
 
-        if u[1] <= self.params.V_ref or t >= t_switch:
+        if u[1] <= self.params.V_ref[0] or t >= t_switch:
             f.expl[0] = self.params.Vs / self.params.L
 
         else:
@@ -88,11 +88,11 @@ def solve_system(self, rhs, factor, u0, t):
 
         t_switch = np.inf if self.t_switch is None else self.t_switch
 
-        if rhs[1] <= self.params.V_ref or t >= t_switch:
+        if rhs[1] <= self.params.V_ref[0] or t >= t_switch:
             self.A[0, 0] = -(self.params.Rs + self.params.R) / self.params.L
 
         else:
-            self.A[1, 1] = -1 / (self.params.C * self.params.R)
+            self.A[1, 1] = -1 / (self.params.C[0] * self.params.R)
 
         me = self.dtype_u(self.init)
         me[:] = np.linalg.solve(np.eye(self.params.nvars) - factor * self.A, rhs)
@@ -113,7 +113,7 @@ def u_exact(self, t):
         me = self.dtype_u(self.init)
 
         me[0] = 0.0  # cL
-        me[1] = self.params.alpha * self.params.V_ref  # vC
+        me[1] = self.params.alpha * self.params.V_ref[0]  # vC
 
         return me
 
@@ -135,12 +135,12 @@ def get_switching_info(self, u, t):
         m_guess = -100
 
         for m in range(len(u)):
-            if u[m][1] - self.params.V_ref <= 0:
+            if u[m][1] - self.params.V_ref[0] <= 0:
                 switch_detected = True
                 m_guess = m - 1
                 break
 
-        vC_switch = [u[m][1] - self.params.V_ref for m in range(1, len(u))] if switch_detected else []
+        vC_switch = [u[m][1] - self.params.V_ref[0] for m in range(1, len(u))] if switch_detected else []
 
         return switch_detected, m_guess, vC_switch
 
@@ -193,12 +193,12 @@ def eval_f(self, u, t):
 
         t_switch = np.inf if self.t_switch is None else self.t_switch
 
-        if u[1] <= self.params.V_ref or t >= t_switch:
+        if u[1] <= self.params.V_ref[0] or t >= t_switch:
             self.A[0, 0] = -(self.params.Rs + self.params.R) / self.params.L
             non_f[0] = self.params.Vs
 
         else:
-            self.A[1, 1] = -1 / (self.params.C * self.params.R)
+            self.A[1, 1] = -1 / (self.params.C[0] * self.params.R)
             non_f[0] = 0
 
         f[:] = self.A.dot(u) + non_f
@@ -224,12 +224,12 @@ def solve_system(self, rhs, factor, u0, t):
 
         t_switch = np.inf if self.t_switch is None else self.t_switch
 
-        if rhs[1] <= self.params.V_ref or t >= t_switch:
+        if rhs[1] <= self.params.V_ref[0] or t >= t_switch:
             self.A[0, 0] = -(self.params.Rs + self.params.R) / self.params.L
             non_f[0] = self.params.Vs
 
         else:
-            self.A[1, 1] = -1 / (self.params.C * self.params.R)
+            self.A[1, 1] = -1 / (self.params.C[0] * self.params.R)
             non_f[0] = 0
 
         # start newton iteration

pySDC/projects/PinTSimE/battery_2capacitors_model.py

@@ -7,7 +7,7 @@
 from pySDC.implementations.problem_classes.Battery import battery_n_capacitors
 from pySDC.implementations.sweeper_classes.imex_1st_order import imex_1st_order
 from pySDC.implementations.controller_classes.controller_nonMPI import controller_nonMPI
-from pySDC.projects.PinTSimE.battery_model import get_recomputed
+from pySDC.projects.PinTSimE.battery_model import get_recomputed, proof_assertions_description
 from pySDC.projects.PinTSimE.piline_model import setup_mpl
 import pySDC.helpers.plot_helper as plt_helper
 from pySDC.core.Hooks import hooks
@@ -126,7 +126,7 @@ def main(use_switch_estimator=True):
     if use_switch_estimator:
         description['convergence_controllers'] = convergence_controllers
 
-    proof_assertions_description(description, use_switch_estimator)
+    proof_assertions_description(description, False, use_switch_estimator)
 
     # set time parameters
     t0 = 0.0
@@ -300,43 +300,5 @@ def get_data_dict(stats, use_switch_estimator, recomputed=False):
     return data
 
 
-def proof_assertions_description(description, use_switch_estimator):
-    """
-    Function to proof the assertions (function to get cleaner code)
-
-    Args:
-        description(dict): contains all information for a controller run
-        use_switch_estimator (bool): flag if the switch estimator wants to be used or not
-    """
-
-    assert (
-        description['problem_params']['alpha'] > description['problem_params']['V_ref'][0]
-    ), 'Please set "alpha" greater than "V_ref1"'
-    assert (
-        description['problem_params']['alpha'] > description['problem_params']['V_ref'][1]
-    ), 'Please set "alpha" greater than "V_ref2"'
-
-    if description['problem_params']['ncondensators'] > 1:
-        assert (
-            type(description['problem_params']['V_ref']) == np.ndarray
-        ), '"V_ref" needs to be an array (of type float)'
-        assert (
-            description['problem_params']['ncondensators'] == np.shape(description['problem_params']['V_ref'])[0]
-        ), 'Number of reference values needs to be equal to number of condensators'
-        assert (
-            description['problem_params']['ncondensators'] == np.shape(description['problem_params']['C'])[0]
-        ), 'Number of capacitance values needs to be equal to number of condensators'
-
-    assert description['problem_params']['V_ref'][0] > 0, 'Please set "V_ref1" greater than 0'
-    assert description['problem_params']['V_ref'][1] > 0, 'Please set "V_ref2" greater than 0'
-
-    assert 'errtol' not in description['step_params'].keys(), 'No exact solution known to compute error'
-    assert 'alpha' in description['problem_params'].keys(), 'Please supply "alpha" in the problem parameters'
-    assert 'V_ref' in description['problem_params'].keys(), 'Please supply "V_ref" in the problem parameters'
-
-    if use_switch_estimator:
-        assert description['level_params']['restol'] == -1, "Please set restol to -1 or omit it"
-
-
 if __name__ == "__main__":
     main()

pySDC/projects/PinTSimE/battery_model.py

@@ -108,11 +108,11 @@ def main(dt, problem, sweeper, use_switch_estimator, use_adaptivity):
     problem_params['ncondensators'] = 1  # number of condensators
     problem_params['Vs'] = 5.0
     problem_params['Rs'] = 0.5
-    problem_params['C'] = 1.0
+    problem_params['C'] = np.array([1.0])
     problem_params['R'] = 1.0
     problem_params['L'] = 1.0
     problem_params['alpha'] = 1.2
-    problem_params['V_ref'] = 1.0
+    problem_params['V_ref'] = np.array([1.0])
 
     # initialize step parameters
     step_params = dict()
@@ -600,18 +600,29 @@ def proof_assertions_description(description, use_adaptivity, use_switch_estimat
         use_switch_estimator (bool): flag if the switch estimator wants to be used or not
     """
 
+    n = description['problem_params']['ncondensators']
     assert (
-        description['problem_params']['alpha'] > description['problem_params']['V_ref']
-    ), 'Please set "alpha" greater than "V_ref"'
-    assert description['problem_params']['V_ref'] > 0, 'Please set "V_ref" greater than 0'
-    assert type(description['problem_params']['V_ref']) == float, '"V_ref" needs to be of type float'
+        description['problem_params']['alpha'] > description['problem_params']['V_ref'][k] for k in range(n)
+    ), 'Please set "alpha" greater than values of "V_ref"'
+    assert type(description['problem_params']['V_ref']) == np.ndarray, '"V_ref" needs to be an np.ndarray'
+    assert type(description['problem_params']['C']) == np.ndarray, '"C" needs to be an np.ndarray '
+    assert (
+        description['problem_params']['ncondensators'] == np.shape(description['problem_params']['V_ref'])[0]
+    ), 'Number of reference values needs to be equal to number of condensators'
+    assert (
+        description['problem_params']['ncondensators'] == np.shape(description['problem_params']['C'])[0]
+    ), 'Number of capacitance values needs to be equal to number of condensators'
+
+    assert (
+        description['problem_params']['V_ref'][k] > 0 for k in range(n)
+    ), 'Please set values of "V_ref" greater than 0'
 
     assert 'errtol' not in description['step_params'].keys(), 'No exact solution known to compute error'
     assert 'alpha' in description['problem_params'].keys(), 'Please supply "alpha" in the problem parameters'
     assert 'V_ref' in description['problem_params'].keys(), 'Please supply "V_ref" in the problem parameters'
 
     if use_switch_estimator or use_adaptivity:
-        assert description['level_params']['restol'] == -1, "For adaptivity, please set restol to -1 or omit it"
+        assert description['level_params']['restol'] == -1, "Please set restol to -1 or omit it"
 
 
 if __name__ == "__main__":

pySDC/projects/PinTSimE/estimation_check.py

@@ -17,7 +17,7 @@
 from pySDC.implementations.convergence_controller_classes.adaptivity import Adaptivity
 
 
-def run(dt, problem, sweeper, use_switch_estimator, use_adaptivity, V_ref):
+def run(dt, problem, sweeper, use_switch_estimator, use_adaptivity):
     """
     A simple test program to do SDC/PFASST runs for the battery drain model
 
@@ -53,11 +53,11 @@ def run(dt, problem, sweeper, use_switch_estimator, use_adaptivity, V_ref):
     problem_params['ncondensators'] = 1
     problem_params['Vs'] = 5.0
     problem_params['Rs'] = 0.5
-    problem_params['C'] = 1.0
+    problem_params['C'] = np.array([1.0])
     problem_params['R'] = 1.0
     problem_params['L'] = 1.0
     problem_params['alpha'] = 1.2
-    problem_params['V_ref'] = V_ref
+    problem_params['V_ref'] = np.array([1.0])
 
     # initialize step parameters
     step_params = dict()
@@ -127,7 +127,6 @@ def check(cwd='./'):
         cwd: current working directory
     """
 
-    V_ref = 1.0
     dt_list = [4e-2, 4e-3]
     use_switch_estimator = [True, False]
     use_adaptivity = [True, False]
@@ -148,9 +147,10 @@ def check(cwd='./'):
                         sweeper=sweeper,
                         use_switch_estimator=use_SE,
                         use_adaptivity=use_A,
-                        V_ref=V_ref,
                     )
 
+                    V_ref = description['problem_params']['V_ref'][0]
+
                     if use_A or use_SE:
                         check_solution(stats, dt_item, problem.__name__, use_A, use_SE)
 

pySDC/projects/PinTSimE/estimation_check_2capacitors.py

@@ -82,7 +82,7 @@ def run(dt, use_switch_estimator=True):
     if use_switch_estimator:
         description['convergence_controllers'] = convergence_controllers
 
-    proof_assertions_description(description, problem_params)
+    proof_assertions_description(description, False, use_switch_estimator)
 
     # set time parameters
     t0 = 0.0