Merge pull request #5 from petrasvestartas/meshsolver

Solver implementation using a single mesh.

Author: tomvanmele

AUTHORS.md

@@ -1,3 +1,11 @@
-# Authors
+# Credits
 
-* petras vestartas <[email protected]>
+## COMPAS ShapeOp Python Package
+
+### Main Developers
+
+- Petras Vestartas <<[email protected]>> [@petrasvestartas](https://github.com/petrasvestartas)
+- Tom Van Mele <<[email protected]>> [@brgcode](https://github.com/brgcode), [@tomvanmele](https://github.com/tomvanmele)
+
+### ShapeOp Authors from GCM, EPFL
+- Sofien Bouaziz <<[email protected]>> [@sofienbouaziz](https://github.com/sofienbouaziz)

CHANGELOG.md

@@ -9,8 +9,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+* Added MeshSolver class.
+
 ### Changed
 
+* Fix circular Solver import.
+
 ### Removed
 
 

LICENSE

@@ -2,7 +2,7 @@
 compas_shapeop
 ********************************************************************************
 
-.. currentmodule:: compas_shapeop
+.. currentmodule:: compas_shapeop.solvers
 
 Classes
 =======
@@ -11,7 +11,7 @@ Classes
     :toctree: generated/
     :nosignatures:
 
-    Solver
+    MeshSolver
 
 Functions and Methods
 =====================
@@ -23,9 +23,8 @@ Mesh Integration
     :toctree: generated/
     :nosignatures:
 
-    Solver.from_mesh
-    Solver.add_mesh_edge_strain_constraint
-    Solver.add_mesh_vertex_force
+    MeshSolver.from_obj
+    MeshSolver.from_grid
 
 Constraints
 -----------
@@ -34,16 +33,13 @@ Constraints
     :toctree: generated/
     :nosignatures:
 
-    Solver.add_closeness_constraint
-    Solver.add_closeness_constraint_with_position
-    Solver.add_edge_strain_constraint
-    Solver.add_shrinking_edge_constraint
-    Solver.add_circle_constraint
-    Solver.add_plane_constraint
-    Solver.add_similarity_constraint
-    Solver.add_regular_polygon_constraint
-    Solver.add_bending_constraint
-    Solver.add_shape_constraint
+    MeshSolver.constrain_edge_lengths
+    MeshSolver.constrain_face_diagonals
+    MeshSolver.constrain_face_planarity
+    MeshSolver.constrain_face_regularization
+    MeshSolver.constrain_triface_bending
+    MeshSolver.fix_vertex
+    MeshSolver.fix_vertices
 
 Forces
 ------
@@ -52,9 +48,8 @@ Forces
     :toctree: generated/
     :nosignatures:
 
-    Solver.add_vertex_force
-    Solver.add_normal_force_with_faces
-    Solver.add_gravity_force
+    MeshSolver.add_gravity
+    MeshSolver.inflate
 
 Core Methods
 ------------
@@ -63,9 +58,7 @@ Core Methods
     :toctree: generated/
     :nosignatures:
 
-    Solver.points
-    Solver.init
-    Solver.solve
+    MeshSolver.solve
 
 .. toctree::
     :maxdepth: 1

data/hex_mesh.json

@@ -8,5 +8,5 @@ This example demonstrates how to use COMPAS ShapeOp to apply bending constraints
     :figclass: figure
     :class: figure-img img-fluid
 
-.. literalinclude:: ../../examples/bending_constraint.py
+.. literalinclude:: ../../examples/meshsolver_bending_constraint.py
     :language: python

docs/_images/bending_constraint.png

@@ -8,5 +8,5 @@ This example demonstrates how to use COMPAS ShapeOp to apply circle constraints
     :figclass: figure
     :class: figure-img img-fluid
 
-.. literalinclude:: ../../examples/circularization.py
+.. literalinclude:: ../../examples/meshsolver_circularization.py
     :language: python

docs/api/compas_shapeop.rst

@@ -8,5 +8,5 @@ This example demonstrates how to use COMPAS ShapeOp to create a tensioned cable
     :figclass: figure
     :class: figure-img img-fluid
 
-.. literalinclude:: ../../examples/closeness_constraint_with_target.py
+.. literalinclude:: ../../examples/meshsolver_closeness_constraint_with_target.py
     :language: python

docs/examples/bending_constraint.rst

@@ -8,5 +8,5 @@ Vertex forces are computed by applying a normal force to each face of the mesh.
     :figclass: figure
     :class: figure-img img-fluid
 
-.. literalinclude:: ../../examples/face_normal_force.py
+.. literalinclude:: ../../examples/meshsolver_face_normal_force.py
     :language: python