Skip to content

Commit 3da5c5d

Browse files
committedOct 4, 2019
#644 fix atol docstring
1 parent e361f5d commit 3da5c5d

6 files changed

+6
-6
lines changed
 

‎pybamm/solvers/base_solver.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ class BaseSolver(object):
1313
rtol : float, optional
1414
The relative tolerance for the solver (default is 1e-6).
1515
atol : float, optional
16-
The relative tolerance for the solver (default is 1e-6).
16+
The absolute tolerance for the solver (default is 1e-6).
1717
"""
1818

1919
def __init__(self, method=None, rtol=1e-6, atol=1e-6):

‎pybamm/solvers/dae_solver.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ class DaeSolver(pybamm.BaseSolver):
1515
rtol : float, optional
1616
The relative tolerance for the solver (default is 1e-6).
1717
atol : float, optional
18-
The relative tolerance for the solver (default is 1e-6)
18+
The absolute tolerance for the solver (default is 1e-6).
1919
root_method : str, optional
2020
The method to use to find initial conditions (default is "lm")
2121
root_tol : float, optional

‎pybamm/solvers/ode_solver.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ class OdeSolver(pybamm.BaseSolver):
1313
rtol : float, optional
1414
The relative tolerance for the solver (default is 1e-6).
1515
atol : float, optional
16-
The relative tolerance for the solver (default is 1e-6).
16+
The absolute tolerance for the solver (default is 1e-6).
1717
"""
1818

1919
def __init__(self, method=None, rtol=1e-6, atol=1e-6):

‎pybamm/solvers/scikits_dae_solver.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ class ScikitsDaeSolver(pybamm.DaeSolver):
2525
rtol : float, optional
2626
The relative tolerance for the solver (default is 1e-6).
2727
atol : float, optional
28-
The relative tolerance for the solver (default is 1e-6).
28+
The absolute tolerance for the solver (default is 1e-6).
2929
root_method : str, optional
3030
The method to use to find initial conditions (default is "lm")
3131
root_tol : float, optional

‎pybamm/solvers/scikits_ode_solver.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ class ScikitsOdeSolver(pybamm.OdeSolver):
2929
rtol : float, optional
3030
The relative tolerance for the solver (default is 1e-6).
3131
atol : float, optional
32-
The relative tolerance for the solver (default is 1e-6).
32+
The absolute tolerance for the solver (default is 1e-6).
3333
linsolver : str, optional
3434
Can be 'dense' (= default), 'lapackdense', 'spgmr', 'spbcgs', 'sptfqmr'
3535
"""

‎pybamm/solvers/scipy_solver.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ class ScipySolver(pybamm.OdeSolver):
1717
rtol : float, optional
1818
The relative tolerance for the solver (default is 1e-6).
1919
atol : float, optional
20-
The relative tolerance for the solver (default is 1e-6).
20+
The absolute tolerance for the solver (default is 1e-6).
2121
"""
2222

2323
def __init__(self, method="BDF", rtol=1e-6, atol=1e-6):

0 commit comments

Comments
 (0)
Please sign in to comment.