Basic solver result feedback from the mass-spring (cloth/hair) solver.

This returns a general status (success/no-convergence/other) along with
basic statistics (min/max/average) for the error value and the number
of iterations. It allows some general estimation of the simulation
quality and detection of critical settings that could become a problem.
Better visualization and extended feedback can follow later.

1 files changed, 9 insertions, 0 deletions

diff --git a/source/blender/physics/BPH_mass_spring.h b/source/blender/physics/BPH_mass_spring.h
index 14c03d8e2b0..a1d7af9c023 100644
--- a/source/blender/physics/BPH_mass_spring.h
+++ b/source/blender/physics/BPH_mass_spring.h
@@ -35,9 +35,18 @@ extern "C" {
 struct Implicit_Data;
 struct ClothModifierData;
 
+typedef enum eMassSpringSolverStatus {
+	BPH_SOLVER_SUCCESS              = (1 << 0),
+	BPH_SOLVER_NUMERICAL_ISSUE      = (1 << 1),
+	BPH_SOLVER_NO_CONVERGENCE       = (1 << 2),
+	BPH_SOLVER_INVALID_INPUT        = (1 << 3),
+} eMassSpringSolverStatus;
+
 struct Implicit_Data *BPH_mass_spring_solver_create(int numverts, int numsprings);
 void BPH_mass_spring_solver_free(struct Implicit_Data *id);
 
+const struct MassSpringSolverResult *BPH_mass_spring_solver_result(struct Implicit_Data *data);
+
 int BPH_cloth_solver_init(struct Object *ob, struct ClothModifierData *clmd);
 void BPH_cloth_solver_free(struct ClothModifierData *clmd);
 int BPH_cloth_solve(struct Object *ob, float frame, struct ClothModifierData *clmd, struct ListBase *effectors);