Skip to main content

Mesh optimization/smoothing

Project description

optimesh

Triangular mesh optimization.

PyPi Version PyPI pyversions DOI GitHub stars PyPi downloads

Discord

Several mesh smoothing/optimization methods with one simple interface. optimesh

  • is fast,
  • preserves submeshes,
  • only works for triangular meshes, flat and on a surface, (for now; upvote this issue if you're interested in tetrahedral mesh smoothing), and
  • supports all mesh formats that meshio can handle.

Installation

Install optimesh from PyPI with

pip install optimesh

How to get a license

Licenses for personal and academic use can be purchased here. You'll receive a confirmation email with a license key. Install the key with

slim install <your-license-key>

on your machine and you're good to go.

For commercial use, please contact support@mondaytech.com.

Using optimesh

Example call:

optimesh in.e out.vtk

Output: terminal-screenshot

The left hand-side graph shows the distribution of angles (the grid line is at the optimal 60 degrees). The right hand-side graph shows the distribution of simplex quality, where quality is twice the ratio of circumcircle and incircle radius.

All command-line options are documented at

optimesh -h

Showcase

disk-step0

The following examples show the various algorithms at work, all starting from the same randomly generated disk mesh above. The cell coloring indicates quality; dark green is bad, yellow is good.

CVT (centroidal Voronoi tessellation)

cvt-uniform-lloyd2 cvt-uniform-qnb cvt-uniform-qnf
uniform-density relaxed Lloyd's algorithm (--method lloyd --omega 2.0) uniform-density quasi-Newton iteration (block-diagonal Hessian, --method cvt-block-diagonal) uniform-density quasi-Newton iteration (default method, full Hessian, --method cvt-full)

Centroidal Voronoi tessellation smoothing (Du et al.) is one of the oldest and most reliable approaches. optimesh provides classical Lloyd smoothing as well as several variants that result in better meshes.

CPT (centroidal patch tessellation)

cpt-cp cpt-uniform-fp cpt-uniform-qn
density-preserving linear solve (Laplacian smoothing, --method cpt-linear-solve) uniform-density fixed-point iteration (--method cpt-fixed-point) uniform-density quasi-Newton (--method cpt-quasi-newton)

A smoothing method suggested by Chen and Holst, mimicking CVT but much more easily implemented. The density-preserving variant leads to the exact same equation system as Laplacian smoothing, so CPT smoothing can be thought of as a generalization.

The uniform-density variants are implemented classically as a fixed-point iteration and as a quasi-Newton method. The latter typically converges faster.

ODT (optimal Delaunay tessellation)

odt-dp-fp odt-uniform-fp odt-uniform-bfgs
density-preserving fixed-point iteration (--method odt-dp-fp) uniform-density fixed-point iteration (--method odt-fixed-point) uniform-density BFGS (--method odt-bfgs)

Optimal Delaunay Triangulation (ODT) as suggested by Chen and Holst. Typically superior to CPT, but also more expensive to compute.

Implemented once classically as a fixed-point iteration, once as a nonlinear optimization method. The latter typically leads to better results.

Using optimesh from Python

You can also use optimesh in a Python program. Try

import optimesh

# [...] create points, cells [...]

points, cells = optimesh.optimize_points_cells(
    points, cells, "CVT (block-diagonal)", 1.0e-5, 100
)

# or create a meshplex Mesh
import meshplex

mesh = meshplex.MeshTri(points, cells)
optimesh.optimize(mesh, "CVT (block-diagonal)", 1.0e-5, 100)
# mesh.points, mesh.cells, ...

If you only want to do one optimization step, do

points = optimesh.get_new_points(mesh, "CVT (block-diagonal)")

Surface mesh smoothing

optimesh also supports optimization of triangular meshes on surfaces which are defined implicitly by a level set function (e.g., spheres). You'll need to specify the function and its gradient, so you'll have to do it in Python:

import meshzoo
import optimesh

points, cells = meshzoo.tetra_sphere(20)


class Sphere:
    def f(self, x):
        return 1.0 - (x[0] ** 2 + x[1] ** 2 + x[2] ** 2)

    def grad(self, x):
        return -2 * x


# You can use all methods in optimesh:
points, cells = optimesh.optimize_points_cells(
    points,
    cells,
    "CVT (full)",
    1.0e-2,
    100,
    verbose=False,
    implicit_surface=Sphere(),
    # step_filename_format="out{:03d}.vtk"
)

This code first generates a mediocre mesh on a sphere using meshzoo,

and then optimizes. Some results:

odt-dp-fp odt-uniform-fp odt-uniform-bfgs
CPT ODT CVT (full Hessian)

Which method is best?

From practical experiments, it seems that the CVT smoothing variants, e.g.,

optimesh in.vtk out.vtk -m cvt-uniform-qnf

give very satisfactory results. (This is also the default method, so you don't need to specify it explicitly.) Here is a comparison of all uniform-density methods applied to the random circle mesh seen above:

(Mesh quality is twice the ratio of incircle and circumcircle radius, with the maximum being 1.)

Why optimize?

Gmsh mesh Gmsh mesh after optimesh dmsh mesh

Let us compare the properties of the Poisson problem (Δu = f with Dirichlet boundary conditions) when solved on different meshes of the unit circle. The first mesh is the on generated by Gmsh, the second the same mesh but optimized with optimesh, the third a very high-quality dmsh mesh.

We consider meshings of the circle with an increasing number of points:

gmsh-quality gmsh-cond gmsh-cg
average cell quality condition number of the Poisson matrix number of CG steps for Poisson problem

Quite clearly, the dmsh generator produces the highest-quality meshes (left). The condition number of the corresponding Poisson matrices is lowest for the high quality meshes (middle); one would hence suspect faster convergence with Krylov methods. Indeed, most CG iterations are necessary on the Gmsh mesh (right). After optimesh, one saves between 10 and 20 percent of iterations/computing time. The dmsh mesh cuts the number of iterations in half.

Access from Python

All optimesh functions can also be accessed from Python directly, for example:

import optimesh

X, cells = optimesh.odt.fixed_point(X, cells, 1.0e-2, 100, verbose=False)

Relevant publications

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

optimesh-0.12.5-cp314-none-any.whl (83.0 kB view details)

Uploaded CPython 3.14

optimesh-0.12.5-cp313-none-any.whl (79.7 kB view details)

Uploaded CPython 3.13

optimesh-0.12.5-cp312-none-any.whl (80.0 kB view details)

Uploaded CPython 3.12

optimesh-0.12.5-cp311-none-any.whl (88.3 kB view details)

Uploaded CPython 3.11

optimesh-0.12.5-cp310-none-any.whl (51.9 kB view details)

Uploaded CPython 3.10

File details

Details for the file optimesh-0.12.5-cp314-none-any.whl.

File metadata

  • Download URL: optimesh-0.12.5-cp314-none-any.whl
  • Upload date:
  • Size: 83.0 kB
  • Tags: CPython 3.14
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for optimesh-0.12.5-cp314-none-any.whl
Algorithm Hash digest
SHA256 be5a3d0438c59a675f2242789b1f2c48e1813512f122da149b175de7e78999e9
MD5 4ff0ee2467fbfc7175c1f51fc92111bf
BLAKE2b-256 f21db3898bc73eef0d968338f12f49e764cd340465fdf09306856e84e6247aa7

See more details on using hashes here.

Provenance

The following attestation bundles were made for optimesh-0.12.5-cp314-none-any.whl:

Publisher: release.yml on meshpro/optimesh-dev

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file optimesh-0.12.5-cp313-none-any.whl.

File metadata

  • Download URL: optimesh-0.12.5-cp313-none-any.whl
  • Upload date:
  • Size: 79.7 kB
  • Tags: CPython 3.13
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for optimesh-0.12.5-cp313-none-any.whl
Algorithm Hash digest
SHA256 44a3470ee0dc311e087c5b87ee1436ad342d16d0fc0faf62f07442ed117edb09
MD5 01050dcc36c390a87638366acb83ed7c
BLAKE2b-256 503d63593285a4921f8db4b78581e47560954d9c04b13c8caf5648d48477910b

See more details on using hashes here.

Provenance

The following attestation bundles were made for optimesh-0.12.5-cp313-none-any.whl:

Publisher: release.yml on meshpro/optimesh-dev

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file optimesh-0.12.5-cp312-none-any.whl.

File metadata

  • Download URL: optimesh-0.12.5-cp312-none-any.whl
  • Upload date:
  • Size: 80.0 kB
  • Tags: CPython 3.12
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for optimesh-0.12.5-cp312-none-any.whl
Algorithm Hash digest
SHA256 b74f6602803cf6c878713137b4c10c7eec1cdc0440985a18dda2fd4544798914
MD5 808b6647886f909a4119f858620ada54
BLAKE2b-256 167c75a81ddc3cba9710d3d3d0e4916ec2b1c8458088647844385ba3ca45ca37

See more details on using hashes here.

Provenance

The following attestation bundles were made for optimesh-0.12.5-cp312-none-any.whl:

Publisher: release.yml on meshpro/optimesh-dev

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file optimesh-0.12.5-cp311-none-any.whl.

File metadata

  • Download URL: optimesh-0.12.5-cp311-none-any.whl
  • Upload date:
  • Size: 88.3 kB
  • Tags: CPython 3.11
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for optimesh-0.12.5-cp311-none-any.whl
Algorithm Hash digest
SHA256 69a123353dcd689b3195f29168a575fb7532f18da224b0e1bf5590c75088bdd7
MD5 ab1c4749e7bf0c3f17962e63f0c00c2d
BLAKE2b-256 749e2f2ecf4bae20c646f83791ec45d0a315bd3aaf941ba907666f6843aee174

See more details on using hashes here.

Provenance

The following attestation bundles were made for optimesh-0.12.5-cp311-none-any.whl:

Publisher: release.yml on meshpro/optimesh-dev

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file optimesh-0.12.5-cp310-none-any.whl.

File metadata

  • Download URL: optimesh-0.12.5-cp310-none-any.whl
  • Upload date:
  • Size: 51.9 kB
  • Tags: CPython 3.10
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for optimesh-0.12.5-cp310-none-any.whl
Algorithm Hash digest
SHA256 c8fdbc135f73f9e52a18306d2057ab63a6e25482af9d545879ee6c1a6396ad6e
MD5 1bbbfb5bdc76f6d55c22f498cc4a3900
BLAKE2b-256 802e69851ce31393089a56ada014c9713b6d5d1503d43fe426a6d0c599bfc612

See more details on using hashes here.

Provenance

The following attestation bundles were made for optimesh-0.12.5-cp310-none-any.whl:

Publisher: release.yml on meshpro/optimesh-dev

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page