Skip to content

Commit 421e241

Browse files
authored
more math formatting
1 parent 308e3f0 commit 421e241

File tree

1 file changed

+6
-9
lines changed

1 file changed

+6
-9
lines changed

lapy/diffgeo.py

+6-9
Original file line numberDiff line numberDiff line change
@@ -285,9 +285,9 @@ def tria_compute_divergence2(tria, tfunc):
285285
Divergence is the flux density leaving or entering a point.
286286
It can be measured by summing the dot product of the vector
287287
field with the normals to the outer edges of the 1-ring triangles
288-
around a vertex. Summing < tfunc , e_ij cross n >
289-
Note: this is the integrated divergence, you may want to multiply
290-
with B^-1 to get back the function in some applications
288+
around a vertex. Summing :math:`< tfunc , e_ij cross n >`,
289+
this is the integrated divergence, you may want to multiply
290+
with :math:`B^-1` to get back the function in some applications.
291291
292292
Parameters
293293
----------
@@ -727,7 +727,9 @@ def tet_compute_divergence(tet, tfunc):
727727
Divergence is the flux density leaving or entering a point.
728728
It can be measured by summing the dot product of the vector
729729
field with the normals to the outer faces of the 1-ring tetras
730-
around a vertex. Summing < tfunc , n_tria_oposite_v >
730+
around a vertex. Summing :math:`< tfunc , n_tria_oposite_v >`,
731+
this is the integrated divergence, you may want to multiply
732+
with :math:`B^-1` to get back the function in some applications.
731733
732734
Parameters
733735
----------
@@ -740,11 +742,6 @@ def tet_compute_divergence(tet, tfunc):
740742
-------
741743
vfunc: array
742744
Scalar function of divergence at vertices.
743-
744-
Notes
745-
-----
746-
This is the integrated divergence, you may want to multiply
747-
with B^-1 to get back the function in some applications.
748745
"""
749746
v0 = tet.v[tet.t[:, 0], :]
750747
v1 = tet.v[tet.t[:, 1], :]

0 commit comments

Comments
 (0)