fluxfem 0.1.3__py3-none-any.whl → 0.1.4__py3-none-any.whl

fluxfem/helpers_wf.py

@@ -10,12 +10,14 @@ from .core.weakform import (
     inner,
     action,
     gaction,
+    outer,
     I,
     det,
     inv,
     transpose,
     transpose_last2,
     matmul,
+    matmul_std,
     log,
     normal,
     ds,
@@ -31,12 +33,14 @@ __all__ = [
     "inner",
     "action",
     "gaction",
+    "outer",
     "I",
     "det",
     "inv",
     "transpose",
     "transpose_last2",
     "matmul",
+    "matmul_std",
     "log",
     "normal",
     "ds",

fluxfem/mesh/base.py

@@ -8,6 +8,11 @@ import jax.numpy as jnp
 
 @dataclass
 class BaseMeshClosure:
+    """
+    Base mesh container with coordinates, connectivity, and optional tags.
+
+    Concrete mesh types should implement face_node_patterns() for boundary queries.
+    """
     coords: jnp.ndarray
     conn: jnp.ndarray
     cell_tags: Optional[jnp.ndarray] = None
@@ -230,6 +235,7 @@ class BaseMeshClosure:
 
 @jax.tree_util.register_pytree_node_class
 class BaseMeshPytree(BaseMeshClosure):
+    """BaseMesh variant that registers as a JAX pytree."""
     def tree_flatten(self):
         children = (self.coords, self.conn, self.cell_tags, self.node_tags)
         return children, {}
@@ -241,4 +247,3 @@ class BaseMeshPytree(BaseMeshClosure):
 
 
 BaseMesh = BaseMeshClosure
-

fluxfem/mesh/hex.py

@@ -36,6 +36,7 @@ class HexMesh(BaseMesh):
 @jax.tree_util.register_pytree_node_class
 @dataclass(eq=False)
 class HexMeshPytree(BaseMeshPytree):
+    """Hex mesh registered as a JAX pytree."""
     def face_node_patterns(self):
         return [
             (0, 1, 2, 3),  # -z

fluxfem/mesh/io.py

@@ -69,6 +69,7 @@ def load_gmsh_mesh(path: str):
 
 
 def load_gmsh_hex_mesh(path: str):
+    """Load a Gmsh mesh and return a HexMesh with optional facets/tags."""
     mesh, facets, tags = load_gmsh_mesh(path)
     if not isinstance(mesh, HexMesh):
         raise ValueError("gmsh mesh is not hexahedral")
@@ -76,6 +77,7 @@ def load_gmsh_hex_mesh(path: str):
 
 
 def load_gmsh_tet_mesh(path: str):
+    """Load a Gmsh mesh and return a TetMesh with optional facets/tags."""
     mesh, facets, tags = load_gmsh_mesh(path)
     if not isinstance(mesh, TetMesh):
         raise ValueError("gmsh mesh is not tetrahedral")

{fluxfem-0.1.3.dist-info → fluxfem-0.1.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fluxfem
-Version: 0.1.3
+Version: 0.1.4
 Summary: FluxFEM: A weak-form-centric differentiable finite element framework in JAX
 License: Apache-2.0
 Author: Kohei Watanabe
@@ -10,8 +10,8 @@ Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: jax (==0.8.2)
-Requires-Dist: jaxlib (==0.8.2)
+Requires-Dist: jax (>=0.8.2,<0.9.0)
+Requires-Dist: jaxlib (>=0.8.2,<0.9.0)
 Requires-Dist: matplotlib (>=3.10.7,<4.0.0)
 Requires-Dist: meshio (>=5.3.5,<6.0.0)
 Requires-Dist: pyvista (>=0.46.4,<0.47.0)
@@ -22,6 +22,8 @@ Description-Content-Type: text/markdown
 [![Python Version](https://img.shields.io/pypi/pyversions/fluxfem.svg)](https://pypi.org/project/fluxfem/)
 ![CI](https://github.com/kevin-tofu/fluxfem/actions/workflows/python-tests.yml/badge.svg)
 ![CI](https://github.com/kevin-tofu/fluxfem/actions/workflows/sphinx.yml/badge.svg)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.18055465.svg)](https://doi.org/10.5281/zenodo.18055465)
+
 
 # FluxFEM
  A weak-form-centric differentiable finite element framework in JAX
@@ -44,13 +46,10 @@ Description-Content-Type: text/markdown
 
 
 ## Features
-- Built on JAX, enabling automatic differentiation and high-performance execution via grad, jit, vmap, and related transformations.
-
-- A FEM framework with a weak-form–centric API, emphasizing a smooth transition from theoretical formulations to practical code implementations.
-
-- Supports two assembly approaches: weak-form-based assembly and a tensor-based (scikit-fem–style) assembly.
-
-- enables to handle both Linear / Non-Linear analysis with AD in JAX
+- Built on JAX, enabling automatic differentiation with grad, jit, vmap, and related transformations.
+- Weak-form–centric API that keeps formulations close to code; weak forms are represented as expression trees and compiled to element kernels.
+- Two assembly approaches: weak-form-based assembly and a tensor-based (scikit-fem–style) assembly.
+- Handles both linear and nonlinear analyses with AD in JAX.
 
 ## Usage 
 
@@ -62,6 +61,9 @@ The first approach offers simplicity and convenience, as mathematical expression
 However, for more complex operations, the second approach can be easier to implement in practice.
 This is because the weak-form-based assembly is ultimately transformed into the tensor-based representation internally during computation.
 
+## Weak Form Compile Flow
+Weak-form expressions are compiled into an evaluation plan and then executed per element.
+
 ### weak-form-based assembly
 ```Python
 import fluxfem as ff
@@ -70,7 +72,7 @@ import fluxfem.helpers_wf as h_wf
 space = ff.make_hex_space(mesh, dim=3, intorder=2)
 D = ff.isotropic_3d_D(1.0, 0.3)
 bilinear_form = ff.BilinearForm.volume(
-    lambda u, v, D: h_wf.ddot(v.sym_grad, D @ u.sym_grad) * h_wf.dOmega()
+    lambda u, v, D: h_wf.ddot(v.sym_grad, h_wf.matmul_std(D, u.sym_grad)) * h_wf.dOmega()
 )
 K_wf = space.assemble_bilinear_form(
     bilinear_form.get_compiled(),

{fluxfem-0.1.3.dist-info → fluxfem-0.1.4.dist-info}/RECORD

@@ -1,20 +1,21 @@
-fluxfem/__init__.py,sha256=wpnJOQj4PSIzWfYd6R0WjAAxN6V8CV7GfxeZqM1WNjc,8145
-fluxfem/core/__init__.py,sha256=DgGJ1Z8ZPfEFjv-q_srihazOxqcPMyEWM2w495ojmHQ,7490
+fluxfem/__init__.py,sha256=VXd7BM-dOt74bF_W8NumTMlE7lCrz3jTwoCFNZnpDW0,6122
+fluxfem/core/__init__.py,sha256=LzHXumR__i656SEmZuGZa09TqTDltTzMIyBBbN1GOKs,8156
 fluxfem/core/assembly.py,sha256=yhc14y4XWvmBpiLun2eH9k1mjAsNmpTbHPJS2VJFO3M,25370
 fluxfem/core/basis.py,sha256=ZxTQUAEC2UBuvxGhiSqAPjVnUwP_nIptY_b9Wn2etak,32113
+fluxfem/core/context_types.py,sha256=QGv1oc_9Crn3vztyPy_uUN0TpmDkgH5HPrhYzZ_kuys,663
 fluxfem/core/data.py,sha256=_byAZTasIGGwNRU3gqw_ZZR1HMVLJpk9gix2AI3AJWk,1818
 fluxfem/core/dtypes.py,sha256=WQ_wfJW_R8Mty76mS7h-R2xgCokraEWjsUvjeKYmVJU,118
-fluxfem/core/forms.py,sha256=ZxmpmaZa-uTRi-0Dltvn0VkEcXpW4HgNFr8Po0b8JyQ,7264
+fluxfem/core/forms.py,sha256=qDaN750oiH44aSReVbOISBR9IsWSEnsv1gxHB7We_D0,7374
 fluxfem/core/interp.py,sha256=v9HzkYgQnEqf6GnB9tXqfrNk0N7YsmPcZBfNGNUU3b8,2004
 fluxfem/core/solver.py,sha256=nNpb90ddZq8Ek6XPerlKzV4YWtC5ZgEcsRv4KeoFIug,3770
 fluxfem/core/space.py,sha256=jj4koa6_7lBBtXWGrF1CehOBKWg--uUW_7q8pB2EFCk,13902
-fluxfem/core/weakform.py,sha256=Q2SoOX1KwwPTigJMDUygQnEuKoxBAHh0R3qwI_sf4gY,27470
+fluxfem/core/weakform.py,sha256=ux4gZukZZBMO6vUegjOn_oaQ2l-nwQMO9L2D98LFh6E,41249
 fluxfem/helpers_ts.py,sha256=T3HCqXniF116lvznq0b7CDUok5_yZZc8l9XtlE81yvg,221
-fluxfem/helpers_wf.py,sha256=JUKiA5p_V9NmUdskHYgYYOlsa8xKTZzBkJCoeUqTu1c,574
+fluxfem/helpers_wf.py,sha256=InXhYr0WqyibiNWRJllAPf23sluTyaGSJApbv-Yn8b0,632
 fluxfem/mesh/__init__.py,sha256=3ECN0qsVzOnEGTHfrWJ2PV7RJUbSboow1ewfpknI4F4,927
-fluxfem/mesh/base.py,sha256=NCJxqKLb6AOC2oGN-GfjC8Uu1Mddpa3E10RNYCyLYtI,10214
-fluxfem/mesh/hex.py,sha256=37xSQDDIndbz7JfBCSdI9ptV19L4_OZ4XgKfkFRGS00,12373
-fluxfem/mesh/io.py,sha256=ZNTXNRB9_tx_J99y-c46ypboQh1IpTHretWXtYWdCag,2834
+fluxfem/mesh/base.py,sha256=cxfv-m-0qQq3UL4aM0YUJEiAyVrKmtSszwe8rE7PQyQ,10448
+fluxfem/mesh/hex.py,sha256=diFF6AngLpA9OllbaPAT00P_0YR4vMVgpc04_IqOLv8,12420
+fluxfem/mesh/io.py,sha256=3Nx5WLFP9gG_Ruks4F7jSTVGnc_i5qcxkLBQkQhsmhk,2984
 fluxfem/mesh/predicate.py,sha256=7O9kcKYg_OPtwhqYVdA-j9LQYtcG2Nl781UupKm6U-A,1505
 fluxfem/mesh/surface.py,sha256=mmtePb1ptd9BSbD79oyPnQwiKadpyVO41xSHDr2XylE,9176
 fluxfem/mesh/tet.py,sha256=Yjmx_2UsCxO_rl0Jr60au5zccBVWLJvAaGEzhLCi_LA,9768
@@ -41,7 +42,7 @@ fluxfem/tools/__init__.py,sha256=S7flze8kfHABc0fdhGgdELzKO8aeBCrDbwRUE3aTGpA,95
 fluxfem/tools/jit.py,sha256=WVThoNs2XD8ZVCeyLjBgbFaZXHot5RK_RNzvvAjSaew,1110
 fluxfem/tools/timer.py,sha256=fvMrKqjOT2S_DoGlTYC5L5TtBnoLS4zyiAZtJVJGt0o,22848
 fluxfem/tools/visualizer.py,sha256=aDqSgtX9xOu120-zCzJfwlCOUmxjL_kJ6kAvj27-H14,3733
-fluxfem-0.1.3.dist-info/LICENSE,sha256=QwcOLU5TJoTeUhuIXzhdCEEDDvorGiC6-3YTOl4TecE,11356
-fluxfem-0.1.3.dist-info/METADATA,sha256=FkdJPsdozjTFWGBp3f87EOaRp2IPdo2G2oW1qPCA4-g,4259
-fluxfem-0.1.3.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-fluxfem-0.1.3.dist-info/RECORD,,
+fluxfem-0.1.4.dist-info/LICENSE,sha256=QwcOLU5TJoTeUhuIXzhdCEEDDvorGiC6-3YTOl4TecE,11356
+fluxfem-0.1.4.dist-info/METADATA,sha256=hn8uJc3N47pozgegKrVvXCbdFhTQX6sbuLLdpnhQT7U,4463
+fluxfem-0.1.4.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+fluxfem-0.1.4.dist-info/RECORD,,