Skip to content

Commit

Permalink
Update documentation on Integral operator (#4595) (#4609)
Browse files Browse the repository at this point in the history
* Update documentation on Integral operator to give additional details on different coordinate systems (#4595)

* use double backslash to avoid \pi being interpreted as an escape sequence

Co-authored-by: Agriya Khetarpal <[email protected]>

---------

Co-authored-by: Agriya Khetarpal <[email protected]>
  • Loading branch information
isaacbasil and agriyakhetarpal authored Nov 25, 2024
1 parent 3421fac commit ddf6aa8
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions src/pybamm/expression_tree/unary_operators.py
Original file line number Diff line number Diff line change
Expand Up @@ -611,10 +611,13 @@ class Integral(SpatialOperator):
A node in the expression tree representing an integral operator.
.. math::
I = \\int_{a}^{b}\\!f(u)\\,du,
I = \\int_{u_{min}}^{u_{max}}\\!f(u)\\,dq,
where :math:`a` and :math:`b` are the left-hand and right-hand boundaries of
the domain respectively, and :math:`u\\in\\text{domain}`.
where :math:`u\\in\\text{domain}` is a spatial variable, :math:`u_{min}` and :math:`u_{max}` are the values of
:math:`u` at the left-hand and right-hand boundaries of the domain respectively, and :math:`dq` is given by, \n
:math:`dq=du` for cartesian coordinates, \n
:math:`dq=2\\pi udu` for cylindrical coordinates, \n
:math:`dq=4\\pi u^2 du` for spherical coordinates.
Parameters
----------
Expand Down

0 comments on commit ddf6aa8

Please sign in to comment.