Numerical Integrator added to SRC along with the __init__() file #391
Conversation
Witt-D
changed the title
gusto/numerical_integrator.py
Outdated
| class NumericalIntegral(object): | ||
| """ | ||
| A class for numerically evaluating and tabulating some 1D integral. | ||
| :arg lower_bound: lower bound of integral |
There was a problem hiding this comment.
These docstrings don't match the style now used through the rest of Gusto -- would you be able to be able to update this?
gusto/numerical_integrator.py
Outdated
| def evaluate_at(self, points): | ||
| """ | ||
| Evaluates the integral at some point using linear interpolation. | ||
| :arg points: the point value, or array of point values to evaluate |
There was a problem hiding this comment.
Same with the docstrings here
gusto/numerical_integrator.py
Outdated
| def tabulate(self, expression): | ||
| """ | ||
| Tabulate some integral expression using Simpson's rule. | ||
| :arg expression: a function representing the integrand to be evaluated. |
There was a problem hiding this comment.
Same with these docstrings
| answer = 9 | ||
| elif integrand_name == "sine": | ||
| integrand = sine | ||
| upperbound = 2*pi |
There was a problem hiding this comment.
Could you integrate this to pi instead of 2*pi so that the answer isn't 0? Just in case the whole thing is doing nothing we would get 0 as the answer so this makes the test extra-safe
| Evaluates the integral at some point using linear interpolation. | ||
| Args: | ||
| points (float or iter) the point value, or array of point values to | ||
| evaluate the integral at. |
There was a problem hiding this comment.
This docstring should also have a Returns: statement, as the function routines something
gusto/__init__.py
Outdated
| @@ -21,3 +21,4 @@ | |||
| from gusto.timeloop import * # noqa | |||
| from gusto.transport_methods import * # noqa | |||
| from gusto.wrappers import * # noqa | |||
| from gusto.numerical_integrator import * # noqa | |||
There was a problem hiding this comment.
These imports are ordered alphabetically so could you put it in its correct place?
Added a numerical integrator to Gusto SRC along with a corrosponding initialisation call into the innit() file