Polygon DEC

docs/docs/pointcloud/algorithms/heat_solver.md

@@ -101,7 +101,7 @@ The `SignedHeatOptions` struct allows several options:
 | Field | Default value |Meaning|
 |---|---|---|
 | `#!cpp bool preserveSourceNormals`| `false` | If `true`, preserve the initial curve normals at the source curve during vector diffusion. |
-| `#!cpp LevelSetConstraint levelSetConstraint`| `LevelSetConstraint::ZeroSet` | Specifies how/if level sets should be preserved. Can be set to `LevelSetConstraint::ZeroSet`, `LevelSetConstraint::Multiple`, or `LevelSetConstraint::None`, corresponding to preserving the zero set, mulitple level sets (one for each curve component), or no level sets, respectively. |
+| `#!cpp LevelSetConstraint levelSetConstraint`| `LevelSetConstraint::ZeroSet` | Specifies how/if level sets should be preserved. Can be set to `LevelSetConstraint::ZeroSet`, `LevelSetConstraint::Multiple`, or `LevelSetConstraint::None`, corresponding to preservation of `curves` as the zero set, as multiple level sets (one for each curve component), or no constraint, respectively. |
 | `#!cpp double softLevelSetWeight`| `-1` | If greater than 0, gives the weight with which the given level set constraint is "softly" enforced. |
 
 ## Scalar extension

docs/docs/surface/algorithms/geodesic_distance.md

@@ -182,6 +182,8 @@ This class also supports any (possibly-nonmanifold) triangle mesh as input, and
 
 `#include "geometrycentral/surface/heat_method_distance.h"`
 
+For the polygon mesh version, see the [polygon mesh heat solver](/surface/algorithms/polygon_heat_solver); for point clouds, see the [point cloud heat solver](/pointcloud/algorithms/heat_solver/).
+
 ### Single Solves
 
 A one-off utility function is provided which computes the distance from a source vertex using the heat method. Repeated solves or more general source data should use the stateful version below.

docs/docs/surface/algorithms/polygon_heat_solver.md

@@ -0,0 +1,115 @@
+# Heat distance and transport on general polygon meshes
+
+Compute signed and unsigned geodesic distance, and transport tangent vectors using fast solvers based on short-time heat flow.
+
+![polygon mesh heat solve results](/media/polygon_heat_solvers.png)
+
+These routines implement polygon mesh versions of the algorithms from:
+
+- [The Heat Method for Distance Computation](http://www.cs.cmu.edu/~kmcrane/Projects/HeatMethod/index.html) (distance)
+- [The Vector Heat Method](https://nmwsharp.com/research/vector-heat-method) (parallel transport)
+- [A Heat Method for Generalized Signed Distance](https://nzfeng.github.io/research/SignedHeatMethod/index.html) (signed distance)
+
+All computation is encapsulated by the `PolygonMeshHeatSolver` class, which maintains prefactored linear systems for the various methods. Some setup work is performed both on construction, and after the first query. Subsequent queries, even with different source points, will be fast.
+
+`#include "geometrycentral/surface/polygon_mesh_heat_solver.h"`
+
+For the original algorithms on triangle meshes, see the documentation for the [Unsigned Heat Method](/surface/algorithms/geodesic_distance/#heat-method-for-distance), [Vector Heat Method](/surface/algorithms/vector_heat_method), and [Signed Heat Method](/surface/algorithms/signed_heat_method).
+
+**Example:** Basic usage
+
+```cpp
+#include "geometrycentral/surface/polygon_mesh_heat_solver.h"
+
+using namespace geometrycentral;
+using namespace geometrycentral::surface;
+
+// Read in a polygon mesh
+std::unique_ptr<SurfaceMesh> mesh;
+std::unique_ptr<VertexPositionGeometry> geom;
+std::tie(mesh, geom) = readSurfaceMesh("my_mesh.obj");
+
+// Create the solver
+PolygonMeshHeatSolver solver(*geom);
+
+// Pick a source point or two
+Vertex vSource = mesh->vertex(7);
+Vertex vSource2 = mesh->vertex(8);
+
+// Pick some source curves
+std::vector<std::vector<Vertex>> curves;
+curves.push_back({mesh->vertex(11), mesh->vertex(12), mesh->vertex(15), mesh->vertex(14), mesh->vertex(13)});
+curves.push_back({mesh->vertex(17), mesh->vertex(18), mesh->vertex(19)});
+
+// Compute geodesic distance
+VertexData<double> distance = solver.computeDistance(vSource);
+
+// Compute signed distance to a set of curves.
+VertexData<double> signedDistance = solver.computeSignedDistance(curves);
+
+// Compute scalar extension
+VertexData<double> extended = solver.extendScalars({{vSource,  3.},
+                                                   {vSource2, -5.}});
+
+// Compute parallel transport
+Vector2 sourceVec{1, 2};
+VertexData<Vector2> transport = solver.transportTangentVector(vSource, sourceVec);
+```
+
+### Constructor
+
+??? func "`#!cpp PolygonMeshHeatSolver::PolygonMeshHeatSolver(EmbeddedGeometryInterface& geom, double tCoef = 1.0)`"
+
+    Create a new solver for the heat methods. Precomputation is performed at startup and lazily as needed.
+
+    - `geom` is the geometry (and hence mesh) on which to compute. Any embedded geometry object (`VertexPositionGeometry`, etc) can be passed here.
+
+    - `tCoef` is the time to use for short time heat flow, as a factor `m * h^2`, where `h` is the maximum between-point spacing. The default value of `1.0` is almost always sufficient.
+
+    Algorithm options (like `tCoef`) cannot be changed after construction; create a new solver object with the new settings.
+
+
+## Geodesic distance
+
+_Geodesic distance_ is the distance from a given source along the surface represented by the point cloud. Specifying multiple source points yields the distance to the nearest source.
+
+??? func "`#!cpp VertexData<double> PolygonMeshHeatSolver::computeDistance(const Vertex& sourceVert)`"
+
+    Compute the geodesic distance from `sourceVert` to all other points.
+
+??? func "`#!cpp VertexData<double> PolygonMeshHeatSolver::computeDistance(const std::vector<Vertex>& sourceVerts)`"
+
+    Like above, but for multiple source points.
+
+## Signed geodesic distance
+
+??? func "`#!cpp VertexData<double> PolygonMeshHeatSolver::computeSignedDistance(const std::vector<std::vector<Vertex>>& curves, const LevelSetConstraint& levelSetConstraint = LevelSetConstraint::ZeroSet)`"
+
+    Compute the signed geodesic distance from a set of curves `curves` to all other points. Each curve in `curves` is a single connected component specified as an ordered sequence of points; curve orientations are derived from this order. The argument `levelSetConstraint` can be set to `LevelSetConstraint::ZeroSet`, `LevelSetConstraint::Multiple`, or `LevelSetConstraint::None`, corresponding to preservation of `curves` as the zero set, as multiple level sets (one for each curve component), or no constraint, respectively. 
+
+## Scalar extension
+
+Given scalar values defined at isolated vertices in the domain, extend it to a scalar field on all vertices. Each point will take the value from the nearest source point, in the sense of geodesic distance. Note that the fast diffusion algorithm means the result is a slightly smoothed-out field.
+
+??? func "`#!cpp VertexData<double> PolygonMeshHeatSolver::extendScalars(const std::vector<std::tuple<Vertex, double>>& sources)`"
+
+    Given a collection of source vertices and scalars at those vertices, extends the scalar field to the whole mesh as a nearest-geodesic-neighbor interpolant.
+
+
+## Vector extension
+
+Given tangent vectors defined at one or more isolated source locations on a surface, extend transport the vectors across the entire domain according to parallel transport. Each point on the domain will take the value of the nearest source point.  Note that the fast diffusion algorithm means the result is a slightly smoothed-out field.
+
+??? func "`#!cpp VertexData<Vector2> PolygonMeshHeatSolver::transportTangentVector(const Vertex& sourceVert, const Vector2& sourceVector)`"
+
+    Shorthand for the general version below when there is just one vector.
+
+    Computes parallel transport of the given vector along shortest geodesics to the rest of the domain.
+
+    Polar directions are defined in each vertex's tangent space. [See `EmbeddedGeometryInterface::vertexTangentBasis`](/surface/geometry#vertex-tangent-basis).
+
+??? func "`#!cpp VertexData<Vector2> PolygonMeshHeatSolver::transportTangentVectors(const std::vector<std::tuple<Vertex, Vector2>>& sources)`"
+
+    Given a collection of source vertices and tangent vectors at those vertices, extends the vector field to the whole domain as a nearest-geodesic-neighbor interpolant via parallel transport along shortest geodesics.
+
+    Polar directions are defined in each vertex's tangent space. [See `EmbeddedGeometryInterface::vertexTangentBasis`](/surface/geometry#vertex-tangent-basis).

docs/docs/surface/algorithms/signed_heat_method.md

@@ -2,10 +2,11 @@ This section describes the _Signed Heat Method_ in geometry-central, which compu
 
 Note that these quantities all depend on the _intrinsic_ geometry of a surface (via the `IntrinsicGeometryInterface`). Therefore, these routines can be run on abstract geometric domains as well as traditional surfaces in 3D.
 
-These algorithms are described in [A Heat Method for Generalized Signed Distance](https://nzfeng.github.io/research/SignedHeatMethod/SignedDistance.pdf). 
+This algorithm is described in [A Heat Method for Generalized Signed Distance](https://nzfeng.github.io/research/SignedHeatMethod/SignedDistance.pdf). 
 
 `#include "geometrycentral/surface/signed_heat_method.h"`
 
+For the polygon mesh version, see the [polygon mesh heat solver](/surface/algorithms/polygon_heat_solver); for point clouds, see the [point cloud heat solver](/pointcloud/algorithms/heat_solver/).
 
 ## Signed Heat Solver
 
@@ -78,7 +79,7 @@ Options are passed in to `computeDistance` via a `SignedHeatOptions` struct, whi
 | Field | Default value |Meaning|
 |---|---|---|
 | `#!cpp bool preserveSourceNormals`| `false` | If `true`, preserve the initial curve normals at the source curve during vector diffusion. |
-| `#!cpp LevelSetConstraint levelSetConstraint`| `LevelSetConstraint::ZeroSet` | Specifies how/if level sets should be preserved. Can be set to `LevelSetConstraint::ZeroSet`, `LevelSetConstraint::Multiple`, or `LevelSetConstraint::None`, corresponding to preserving the zero set, mulitple level sets (one for each curve component), or no level sets, respectively. |
+| `#!cpp LevelSetConstraint levelSetConstraint`| `LevelSetConstraint::ZeroSet` | Specifies how/if level sets should be preserved. Can be set to `LevelSetConstraint::ZeroSet`, `LevelSetConstraint::Multiple`, or `LevelSetConstraint::None`, corresponding to preservation of the input curves as the zero set, as multiple level sets (one for each curve component), or no constraint, respectively. |
 | `#!cpp double softLevelSetWeight`| `-1` | If greater than 0, gives the weight with which the given level set constraint is "softly" enforced. |
 
 ## Citation

docs/docs/surface/algorithms/vector_heat_method.md

@@ -6,6 +6,7 @@ These algorithms are described in [The Vector Heat Method](http://www.cs.cmu.edu
 
 `#include "geometrycentral/surface/vector_heat_method.h"`
 
+For the polygon mesh version, see the [polygon mesh heat solver](/surface/algorithms/polygon_heat_solver); for point clouds, see the [point cloud heat solver](/pointcloud/algorithms/heat_solver/).
 
 ## Vector Heat Solver