pyfvm 0.5.3__cp315-none-any.whl

pyfvm-0.5.3.dist-info/METADATA

@@ -0,0 +1,169 @@
+Metadata-Version: 2.4
+Name: pyfvm
+Version: 0.5.3
+Summary: Finite volume discretizations for Python
+Author-email: Nico Schlömer <nico.schloemer@gmail.com>
+License-Expression: LicenseRef-Proprietary
+Project-URL: Home, https://github.com/meshpro/pyfvm
+Project-URL: Issues, https://github.com/meshpro/pyfvm/issues
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: meshplex<0.23.0,>=0.22.0
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: sphinxcontrib-bibtex
+Requires-Dist: stonefish-license-manager>=0.8
+Requires-Dist: stonefish-runtime>=0.8
+Requires-Dist: sympy
+Requires-Dist: stonefish-runtime>=0.8.1
+
+# pyfvm
+
+[![PyPi Version](https://img.shields.io/pypi/v/pyfvm.svg?style=flat-square)](https://pypi.org/project/pyfvm)
+[![PyPI pyversions](https://img.shields.io/pypi/pyversions/pyfvm.svg?style=flat-square)](https://pypi.org/pypi/pyfvm/)
+[![GitHub stars](https://img.shields.io/github/stars/meshpro/pyfvm.svg?style=flat-square&logo=github&label=Stars&logoColor=white)](https://github.com/meshpro/pyfvm)
+[![PyPi downloads](https://img.shields.io/pypi/dm/pyfvm.svg?style=flat-square)](https://pypistats.org/packages/pyfvm)
+
+[![Discord](https://img.shields.io/static/v1?logo=discord&logoColor=white&label=chat&message=on%20discord&color=7289da&style=flat-square)](https://discord.gg/hnTJ5MRX2Y)
+
+Creating finite volume equation systems with ease.
+
+pyfvm provides everything that is needed for setting up finite volume equation
+systems. The user needs to specify the finite volume formulation in a
+configuration file, and pyfvm will create the matrix/right-hand side or the
+nonlinear system for it. This package is for everyone who wants to quickly
+construct FVM systems.
+
+### Examples
+
+#### Linear equation systems
+
+pyfvm works by specifying the residuals, so for solving Poisson's equation with
+Dirichlet boundary conditions, simply do
+
+```python
+import meshplex
+import meshzoo
+import numpy as np
+from scipy.sparse import linalg
+
+import pyfvm
+from pyfvm.form_language import Boundary, dS, dV, integrate, n_dot_grad
+
+
+class Poisson:
+    def apply(self, u):
+        return integrate(lambda x: -n_dot_grad(u(x)), dS) - integrate(lambda x: 1.0, dV)
+
+    def dirichlet(self, u):
+        return [(lambda x: u(x) - 0.0, Boundary())]
+
+
+# Create mesh using meshzoo
+vertices, cells = meshzoo.rectangle_tri(
+    np.linspace(0.0, 2.0, 401), np.linspace(0.0, 1.0, 201)
+)
+mesh = meshplex.Mesh(vertices, cells)
+
+matrix, rhs = pyfvm.discretize_linear(Poisson(), mesh)
+
+u = linalg.spsolve(matrix, rhs)
+
+mesh.write("out.vtk", point_data={"u": u})
+```
+
+This example uses [meshzoo](https://pypi.org/project/meshzoo) for creating a
+simple mesh, but anything else that provides vertices and cells works as well.
+For example, reading from a wide variety of mesh files is supported (via
+[meshio](https://pypi.org/project/meshio)):
+
+<!--pytest.mark.skip-->
+
+```python
+mesh = meshplex.read("pacman.e")
+```
+
+Likewise, [PyAMG](https://github.com/pyamg/pyamg) is a much faster solver for
+this problem
+
+<!--pytest.mark.skip-->
+
+```python
+import pyamg
+
+ml = pyamg.smoothed_aggregation_solver(matrix)
+u = ml.solve(rhs, tol=1e-10)
+```
+
+More examples are contained in the [examples directory](examples/).
+
+#### Nonlinear equation systems
+
+Nonlinear systems are treated almost equally; only the discretization and
+obviously the solver call is different. For Bratu's problem:
+
+```python
+import pyfvm
+from pyfvm.form_language import *
+import meshzoo
+import numpy as np
+from sympy import exp
+import meshplex
+
+
+class Bratu:
+    def apply(self, u):
+        return integrate(lambda x: -n_dot_grad(u(x)), dS) - integrate(
+            lambda x: 2.0 * exp(u(x)), dV
+        )
+
+    def dirichlet(self, u):
+        return [(u, Boundary())]
+
+
+vertices, cells = meshzoo.rectangle_tri(
+    np.linspace(0.0, 2.0, 101), np.linspace(0.0, 1.0, 51)
+)
+mesh = meshplex.Mesh(vertices, cells)
+
+f, jacobian = pyfvm.discretize(Bratu(), mesh)
+
+
+def jacobian_solver(u0, rhs):
+    from scipy.sparse import linalg
+
+    jac = jacobian.get_linear_operator(u0)
+    return linalg.spsolve(jac, rhs)
+
+
+u0 = np.zeros(len(vertices))
+u = pyfvm.newton(f.eval, jacobian_solver, u0)
+
+mesh.write("out.vtk", point_data={"u": u})
+```
+
+Note that the Jacobian is computed symbolically from the `Bratu` class.
+
+Instead of `pyfvm.newton`, you can use any solver that accepts the residual
+computation `f.eval`, e.g.,
+
+<!--pytest.mark.skip-->
+
+```python
+import scipy.optimize
+
+u = scipy.optimize.newton_krylov(f.eval, u0)
+```

pyfvm-0.5.3.dist-info/RECORD

@@ -0,0 +1,5 @@
+pyfvm-0.5.3.dist-info/METADATA,sha256=tngmilIAHgOqqW-fUpeiPsIiXzB7LUwdIAb3dOYdN2w,5130
+pyfvm-0.5.3.dist-info/WHEEL,sha256=E0bxZwGow566sLu-koO-FIhzqGs-_etk-jdmZvGiCJ0,91
+pyfvm-0.5.3.dist-info/top_level.txt,sha256=KDGgSlY_Zi0py3eTPNYK_69ArscWtdoK4Mfd7xbQWHM,6
+pyfvm.cpython-315.sfc,sha256=H0nb4LrBcW-_L0Ctzj9fHuAZQtA3TGM2pqLbHSzFq_g,69350
+pyfvm-0.5.3.dist-info/RECORD,,

pyfvm-0.5.3.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: stonefish (0.8.1)
+Root-Is-Purelib: true
+Tag: cp315-none-any
+

pyfvm-0.5.3.dist-info/top_level.txt

@@ -0,0 +1 @@
+pyfvm