morphoGen — Specification (cahier des charges)¶
Document |
Software requirements specification |
Version |
1.164 |
Date |
2026-11-17 |
Author |
@jdirr |
Status |
Version 1.1 validated on 2026-10-21. Version 1.2 (phase 2: homogenization and statistical analysis, §3.1, §5.8, §10, §11) version 1.3 (phase 3a: cellular automata, combinatorial design, topology optimization, visualization and graphical interface, §3.2, §5.9–5.11) version 1.4 (phase 2b: polycrystals in finite elements, anisotropic crystals, parallel and cluster runs, exports, measures, combinations and further models, §3.3) and version 1.5 (phase 2c: whole periodic grains, the periodic element with macroscopic strains and stresses, thermo-elasticity, post-processing, results database and Ashby charts, nested and bio-inspired models, §3.4) version 1.6 (nonlinear behaviours along loading paths, with the macroscopic strains as degrees of freedom of the periodic element, §3.4) and version 1.7 (crystal plasticity of polycrystals, finite strains, local continuous integration, §3.4) and version 1.8 (the nonlinear FFT solver of voxel images, §3.4) and version 1.9 (RVE statistics of the curves of loading paths) and version 1.10 (phase 3b: the GPU backend of the FFT solvers, hard-core and curved fibres, rotated and graded lattices, §3.5) and version 1.11 (the behaviours of the loading paths integrated on the GPU, §3.5) and version 1.12 (AMITEX_FFTP workflows, §3.5) and version 1.13 (MFront behaviours through MGIS, §3.5) and version 1.14 (MFront sources of morphoGen’s behaviours, AMITEX runs of nonlinear materials, §3.5) and version 1.15 (the materials of Abaqus inputs, §3.5) and version 1.16 (the open points of the MFront exports, §3.5) and version 1.17 (finite strains in the AMITEX and Abaqus exports, §3.5) and version 1.18 (dead leaves models and Torquato’s approaches, §3.5) and version 1.19 (transparent dead leaves and stealthy hyperuniform germs, §3.5) are proposed. Later changes go through pull requests that update this file and its change log (§13). |
Companion documents: architecture.md (modules, data model, formats, tests) and theory.md (formulas implemented and validated).
1. Context¶
Determining the size of the representative volume element (RVE) of random or architected materials needs three things:
large populations of virtual microstructures with controlled morphology;
their morphological characterization;
discretizations suited to full-field simulations (finite elements, FFT).
The statistical method of Kanit et al. (2003) relates the ensemble variance of an apparent property Z to the volume V of the samples:
D_Z^2(V) = K V^(-gamma), eps_rel = 2 D_Z(V) / (Zbar sqrt(n)),
V_RVE = (4 K / (eps_rel^2 Zbar^2 n))^(1/gamma)
The author’s work applies it to Poisson fibres (Dirrenberger et al., 2014), Voronoi polycrystals (Yang et al., 2019) and nanolayered films imaged by AFM (Bironeau et al., 2016). Each study needs many realizations at several sizes.
The previous tool chain was:
vtkSim (Centre de Morphologie Mathématique, Mines ParisTech; C++/VTK): vector generation of random structures, surface meshing on a Cartesian grid, then commercial remeshing (YAMS) and tetrahedral meshing (TetMesh-GHS3D). It is research software that is not openly maintained.
PuMA (NASA; Python/C++; NASA Open Source Agreement 1.3): voxel-based generation and analysis of fibrous and porous media, with property solvers.
morphoGen is meant to replace this chain with one open, portable and scriptable program centred on morphological modelling.
2. Objectives¶
O1. Generate virtual microstructures from stochastic morphological models (Boolean models, point processes, tessellations, random fields, fibres…) and from deterministic architectures (strut lattices, TPMS), periodic or not, reproducibly.
O2. Provide the associated morphological and statistical characteristics: the theoretical values when they are known, and measurements on realizations.
O3. Export microstructures in three representations — vector (explicit primitives), implicit (level sets) and voxel — and as meshes for finite-element codes and volumes for FFT codes.
O4. Support RVE studies end to end: populations of realizations at several sizes, measurements, ensemble statistics, scaling-law fits and RVE sizes. This includes properties computed by external FE/FFT codes.
O5. Run on a laptop (Windows, macOS on Apple Silicon, Linux) for moderate volumes, and in batch on clusters for very large studies or volumes. Use GPU acceleration when available (later phase).
O6. Remain maintainable and extensible by a research group working in Python, and publishable as an open distribution.
3. Requirements (2026-10-21)¶
Topic |
Content |
|---|---|
Purpose |
Morphological modelling; generation of stochastic or deterministic virtual microstructures. Base it on VTK, PuMA or another library as judged best; gmsh may help. |
Users |
The author and their research group; open-source release if the code proves useful and efficient. |
First version |
Random microstructures from several morphological schemes, their statistical and morphological characteristics, and meshes for FE (or 3D volumes for FFT), for RVE-size studies as in Dirrenberger et al. (2014). |
Inputs |
Morphological parameters, starting with the volume fraction (porous media), and a morphology type (granular, porous, fibrous, tessellation, etc.). |
Outputs |
First 3D volumes, ideally vector or implicit geometry. |
Downstream codes |
Possibly an FE code, not necessarily Abaqus: rather open source (FEniCS) or in-house. |
Usage |
Command line, graphical interface, batch processing on a cluster. |
Performance |
GPU acceleration welcome; must run on an ordinary laptop for reasonable volumes; clusters reserved for very large volumes. |
Language |
Python if appropriate; Rust, C++ or Fortran possible, several languages allowed — the developer’s choice. |
Dependencies |
The developer’s choice, avoiding commercial licences. |
Platforms |
Windows, macOS (Apple Silicon), Linux. |
Language of the project |
English. |
Licence |
Eventually CC-BY-NC; GNU GPL v3 or later chosen on 2026-10-21 (decision D1); the author holds the rights, which the institution confirmed (2026-11-17). |
Existing code |
Statistical post-analysis code, to be integrated in a second phase (see §3.1: there is none, it is written from the 2014 paper). |
Reference data |
The author’s RVE papers (Dirrenberger et al. 2014; Yang et al. 2019; Bironeau et al. 2016). |
3.1 Phase 2 (2026-10-21)¶
Topic |
Content |
|---|---|
Statistical code |
There is no existing code: write it from Dirrenberger, Forest & Jeulin (2014). |
Finite element workflow |
Example Z-set input files: KUBC, mixed (MBC) and periodic conditions; bulk (k) and shear (μ) loadings; outputs: volume averages of strain, stress and energy, volume, second moments. |
Solvers |
Avoid Z-set and use free codes when possible. |
Discretization |
Finite elements must not compute on voxels when the morphologies come from implicit functions: mesh their surfaces, fill them with volume meshes and follow the morphology instead of approximating it with voxels. Voxels are reserved for the FFT solver. |
3.2 Phase 3 (2026-10-21)¶
Topic |
Content |
|---|---|
Graphical interface and visualization |
Desirable, to be implemented when possible. |
Cellular automata |
An additional generation module based on the concept of cellular automata and everything that follows from it, notably combinatorial design and topology optimization problems, and the algorithms dedicated to such systems. |
3.3 Phase 2b (2026-10-21)¶
Topic |
Content |
|---|---|
Polycrystals (D8) |
D8: finite elements on conforming meshes of polycrystals. |
Phase 2b |
Phase 2b of the roadmap (§10) to be developed. |
Parallel runs |
Running computations in parallel is very important, notably on clusters. |
3.4 Phase 2c (2026-10-22)¶
Topic |
Content |
|---|---|
Periodic polycrystal meshes |
The grains periodized, not the mesh of the cube, with a volume of grains equal to the mesh of a cube: periodic at the design, not at the mesh, which naturally gives matching edges and nodes for the PBC. |
Periodic element |
A periodic element like |
Post-processing |
Macroscopic values, homogenized values (relative to the volume fraction for porous media). |
Ashby charts and database |
A tool to generate (normalized) Ashby-type charts that can display the values of the generated microstructures, and an ad-hoc database of all the configurations tested, filterable for display. |
Nested models |
Nested models, for example a Cox-type model of spheres to represent nanocomposites, but also hierarchical, even fractal architectures (Rayneau-Kirkhope, Mao & Farr, PRL 2012). |
Bio-inspiration |
Morphological and growth models inspired by the living world. |
Wood rays (2026-10-22) |
The wood rays added to the wood model. |
Nonlinear behaviour (2026-10-22) |
The macroscopic degrees of freedom added to the periodic element, to simulate nonlinear behaviour (viscoplasticity in particular). |
Local continuous integration (2026-10-22) |
The development and its continuous integration carried on locally while GitHub Actions is unavailable (D18). |
Crystal plasticity, finite strains (2026-10-22) |
Méric–Cailletaud crystal plasticity for polycrystals; finite strains for the whole system too. |
Nonlinear FFT solver (2026-10-22) |
The nonlinear FFT solver of voxel images (viscoplasticity and crystal plasticity, macroscopic strains as degrees of freedom), the follow-up planned by decision D16. |
RVE statistics of nonlinear responses (2026-10-23) |
RVE statistics of the viscoplastic responses (the methodology of Yang et al. 2019 with the nonlinear FFT solver); the GPU backend (phase 3b) needs large packages and decision D3. |
3.5 Phase 3b (2026-10-23)¶
Topic |
Content |
|---|---|
GPU backend (2026-10-23) |
The GPU backend, then the next steps of the development. Backend chosen after benchmarks on the development machine (NVIDIA RTX 3000 Ada laptop GPU): CuPy (D3), for the FFT solvers of voxel images (FR-B3). Next steps: the remaining models of FR-G9, hard-core fibres, curved fibres (worm-like chains), rotated and graded lattices. |
GPU integration (2026-10-23) |
Phase 3b: the integration of the behaviours on the GPU to accelerate the loading paths. The behaviours are ported to CUDA (D3) and the integration points stay on the GPU; the crystal plasticity paths gain 1.4 to 1.9 times on the development laptop, bound by the double precision of its GPU (§7.4). |
AMITEX workflows (2026-10-23) |
Phase 3b: the AMITEX workflows (exports and reading of the results). The inputs of AMITEX_FFTP runs of an image and the reading of their results (FR-E6); the formats follow AMITEX’s documentation and its official Python interface (py4amitex, cpp4amitex); no AMITEX installation on the development machine (Windows), so the runs themselves are not tested. |
MFront (2026-10-23) |
The integration of MFront laws into morphoGen’s solvers through MGIS (finite elements and FFT voxels, small and finite strains), validated against morphoGen’s laws. MGIS and MFront exist on conda-forge for the three systems; MFront compiles the behaviours with a C++ compiler, which the Windows development machine lacks: they are installed with conda’s compiler in WSL (Ubuntu 22.04), where the tests of the MFront behaviours run, on the CPU and the GPU (FR-H21, D20). |
MFront exports (2026-10-23) |
The second half of the MFront integration: the exports of morphoGen’s laws for AMITEX and Abaqus. morphoGen writes its nonlinear materials as MFront sources (FR-E7), which its AMITEX exports compile with the umat interface (FR-E6); the order of the shear components (11, 22, 33, 12, 13, 23 is that of Z-set and TFEL, the usual order 11, 22, 33, 23, 13, 12) is applied at every interface and checked with distinct shear moduli. AMITEX and Abaqus are not installed on the development machine: the laws are checked through MGIS and through the umat interface called as AMITEX calls it. |
Abaqus materials (2026-10-23) |
The Abaqus side of the MFront exports. The Abaqus inputs of conforming meshes define the materials of their phases, the elastic ones (isotropic and anisotropic in the axes of the crystals) and the nonlinear ones as MFront laws of the abaqus interface (FR-E6, FR-E7). Abaqus is not installed on the development machine: CalculiX, which reads Abaqus inputs, is installed in WSL to run the elastic materials, and the MFront laws are called as Abaqus calls them. |
Open points of the exports (2026-10-23) |
Three open points: the materials of the Abaqus inputs of voxel meshes, crystal plasticity in finite strains as an MFront source (morphoGen’s kernel in it, D20), the user’s MFront laws in AMITEX and Abaqus inputs (FR-E6, FR-E7). |
Finite strains in the exports (2026-10-23) |
The MFront laws in finite strains in the AMITEX and Abaqus inputs. The AMITEX runs and the Abaqus inputs of finite strains take every phase but the voids as an MFront law of finite strains, Hencky’s elasticity for the elastic ones (the native elasticities of AMITEX and Abaqus in finite strains are not morphoGen’s), the user’s laws of finite strains included (FR-E6, FR-E7, D20). AMITEX and Abaqus are still absent from the development machine: the laws are called as the codes call them in finite strains. |
Dead leaves and Torquato (2026-10-24) |
The dead-leaves type models and Torquato’s approaches in the module of morphological generation. The dead leaves get families of leaves of their own sizes, spheroidal leaves and a finite coverage over a background, with their exact bivariate laws (Jeulin 1997); after Torquato (2002), dense packings of hard spheres grown by the Lubachevsky–Stillinger algorithm (the dense packings beyond the RSA limit of FR-G9), penetrable spheres with impenetrable cores (the cherry-pit model), the stochastic reconstruction of Yeong & Torquato (FR-G15) and the descriptors of random heterogeneous materials (FR-M3). |
NTFA (2026-10-24) |
An NTFA solver: |
Level-set foams (2026-10-24) |
The level-set tools for the modelling of foams, as in the paper of N. Degdeg and J. Dirrenberger (an anisotropic open-cell copper foam): the model |
FEniCSx (2026-10-24) |
The FEniCSx solver integrated, after the demos of COMET-FEniCSx, as the solver of morphoGen’s own problems: |
Transparent dead leaves and hyperuniformity (2026-10-24) |
The random function of transparent leaves of Jeulin and its excursions, with their exact covariance, and Voronoi tessellations of stealthy hyperuniform germs (the collective coordinates of Torquato and coworkers) (FR-G9). |
Post-bifurcation (2026-10-24) |
A module for a post-bifurcation analysis in the manner of Azulay (R. Azulay’s thesis and papers with C. Combescure and J. Dirrenberger): |
Visualization, exports, behaviours, fracture (2026-10-24) |
The graphical interface: qualitative, intuitive and clear; multiple exports (business files, raw data as .csv, .xlsx, .txt, vector files as svg or TikZ, bitmaps png, tiff); videos (mp4) of morphologies (mesh exploration, as Avizo) and simulations (colormaps, magnified fields, back and forth, loops, cross-sections); the behaviour bricks of Z-set reused; cohesive zone elements, crack propagation by remeshing and XFEM, ideally in 3D and finite strains; the analysis in the manner of Azulay in 3D; every module connected in a workflow from the morphological model to the fields of the FE mesh, their exports, images and videos (FR-E8, FR-I7 and the following versions). |
Mixed-mode cracks (2026-10-25) |
3D cracks (modes I+II+III) in finite strains: |
Finite strains, porous plasticity, microfoam (2026-10-25) |
Four developments: the analysis in the manner of Azulay in finite strains; porous_plastic, not only gen_evp; the microfoam model of Forest’s corresponding article; for fracture, finite strains in elasto-viscoplasticity, ideally with crystal plasticity too and/or nonlocal models: |
Conforming meshes (2026-10-25) |
Conforming meshes from level sets rather than voxels: |
Micromorphic models, remeshed cracks, point groups (2026-10-25) |
The micromorphic models in finite strains and micromorphic ductile damage (FR-H32), remeshed crack propagation in inelastic bodies with the transfer of their state (FR-H33), the full point groups of the mirrored meshes and the equibiaxial bifurcations (FR-E5, FR-H26). |
Buckling of 2 x 2 x 2 cells, polycrystal cracks, triaxiality (2026-10-25) |
The buckling of the cubic cell of 2 x 2 x 2, crack growth in a remeshed polycrystal and the triaxiality in the damage: the linear post-bifurcation of cells of several primitive cells split by their translations and the little co-groups of their wave vectors (FR-H26), the grains on the crack meshes of a polycrystal and its state transferred grain by grain (FR-H33), the micromorphic ductile damage driven by the plastic strain weighted by the stress triaxiality (FR-H32); the forms of the graphical interface open with the example configuration of each model. |
Interface workflow (2026-10-25) |
Six points of the interface: in the default activator-inhibitor case the fields of a simulation did not evolve during its video; a workflow that starts with the Generate module, then sends a morphology to the simulation module, then to the export module, etc., rather than recording a video at the simulation; boxes of Generate larger than 160 voxels per edge (up to 2048); the Optimize module started from a simulation result or a morphology; the Formation and Design space modules explained; the level-set functions used rather than voxels. Delivered: the videos of a load colour the fields as they grow; the workflow from tab to tab through the workspace of the session (Generate, Simulate, Export, Optimize); the views and measures of the level sets, sections at up to 2048 pixels per edge without a voxel image of the volume, voxel images on demand up to 2048 voxels per edge within the free memory; optimizations from a morphology or a simulation; the formation shown in Generate with the share of the cells changed at each step, and the tile assemblies explained (FR-I4). |
Every function in the interface (2026-10-25) |
Every function reachable from the graphical interface (the NTFA, bifurcation, fracture, nonlocal models and triaxiality were not); a Statistics tab for the RVE and related tools; tabs without numbers: there may be an intrinsic order of operations, but the modules may be called before or after one another as needed. Delivered: tools built from a registry, the tab Statistics, tabs of the mechanics (loading paths, NTFA, material points), fracture, stability, nonlocal damage, couplings and the formats of other solvers (FR-I4). |
Interface review (2026-10-26) |
An in-depth review of the graphical interface and of the sequence of the modules, some gathered in submenus; cracks through an arbitrary morphology, which the fracture tools could not handle. Delivered: the menus in four sections with their tabs, the items sent on to the forms that take them, compact forms (FR-I4); cracks through any morphology, in the library and in the tab Fracture (FR-H33). |
3.6 Phase 4 (2026-10-28)¶
Topic |
Content |
|---|---|
Release preparation (2026-10-28) |
A faster local CI, then the preparation of version 1.0 without publishing anything: the local CI runs the tests in parallel (pytest-xdist, one file per process, the longest first) and the Python versions at once, its environments kept from one run to the next (D18); the documentation site is built from |
Shorter CI (2026-10-29) |
A shorter CI, by two tiers of tests and lighter tests of the interface: the slowest tests (marker |
Hill plasticity (2026-10-29) |
Hill’s anisotropic plasticity in morphoGen’s kernels, on the CPU and the GPU (FR-H16, FR-B3), in Z-set’s form (its coefficients by component), identified on the responses of a morphology (FR-H34), read and written in Z-mat files (FR-H27), in the forms of the interface (FR-I4); the macroscopic law of an anisotropic morphology (fibres, laminates, lattices) can then be identified and written back for Z-set; then the macroscopic law of a morphology in one go (its loadings run, a law estimated on them, von Mises, Hill or, of a porous morphology, Gurson identified), in the library and as a tool of the interface; then the kernels of Hill’s criterion and of porous plasticity made faster, and the cost of each behaviour of the points measured (NFR-2). |
Kernels (2026-10-29) |
The analytical Jacobian of the porous update, porous plasticity on the GPU, the tangent of finite strains from the six directions of dC: the porous update and its consistent tangent take the analytical Jacobian of their four equations (the second derivatives of the matrix stress, implicit ones for GTN), and the FFT solvers on the GPU integrate porous points with a CUDA port of the update (FR-B3); the tangent of finite strains takes the six directions of dC (3 to 12 % faster, Jacobi’s eigen decomposition keeping most of the cost); the local CI clears the Numba caches of its kept environments, which a change of a kernel called from another file left stale (D18). |
GPU benchmark, crystal kernel, softening points (2026-10-29) |
The porous paths in the benchmark of the GPU (stiff spheres in a GTN matrix, the CPU and the GPU), and the crystal kernel 1.4 to 1.7 times faster, the exponentials of its isotropic hardening computed once per family; then, on the stall found in that benchmark, MINRES takes the linear solves over from the conjugate gradients when the tangent of softening points is indefinite; then the softening paths studied (the reference medium of the preconditioner kept, their divided steps a localization of the damage), and the FFT tools of the tab Mechanics on the GPU (a device field). |
Exports (2026-10-30) |
The thermal expansion of the MFront sources in small strains (von Mises and Hill: the brick’s Hooke potential; crystals: |
Porous exports (2026-10-30) |
Porous plasticity in the MFront sources, its kinematic hardening, and a tool to compute the percolation threshold if morphoGen had none. First, porous plasticity in the MFront sources: the materials of Gurson-Tvergaard-Needleman with the brick |
Percolation in the interface (2026-10-30) |
The percolation threshold in the interface and on the command line: the threshold of |
Forest fire (2026-10-30) |
A forest-fire algorithm for the percolation, which was computed otherwise (the components labelled by scipy, joined by a union-find on periodic images); |
Finite-size scaling, porous MFront sources (2026-10-30) |
The finite-size scaling of percolation thresholds (the thresholds of several box sizes fitted to p_c + a L^(-1/ν), the error of p_c, ν given or fitted; the sized family of a configuration; |
Anisotropy, fibres, tilings, learned behaviours (2026-10-30) |
Five points: 1) the anisotropy of percolation, in 2D and 3D, and anisotropic versions of the morphological models in general; 2) for the fibre models, the approach of Altendorf and Jeulin, and other published ones; 3) grids other than square for the cellular automata, e.g. triangular, hexagonal, quasi-periodic in 2D, and in 3D; 4) a new module of behaviours learned from data; 5) a gallery of examples and a tutorial, possibly for a later phase. Delivered: the anisotropy of percolation in 2-D and 3-D (planar images in the percolation tools, 4 or 8 neighbours, ν = 4/3; the forest fire across congruent cores of the box along any direction; the thresholds of a family along directions with paired deviations, ratio and threshold tensor; |
Learned laws in finite strains, beam frames (2026-10-31) |
Consistent learned laws in finite strains, the beam frames against the FFT solver and Ban et al.’s case 9: the learned generalized standard materials in finite strains (a free energy of the logarithmic strain or of the Green-Lagrange strain, objective, with a nonnegative dissipation and a consistent tangent), 11 % on large-strain von Mises paths where the recurrent law and the Green-Lagrange space reach 64 %; the frames of beams against the FFT solver on the voxel images of the same foams and networks (frame/FFT 0.88 to 0.98 for Euler-Bernoulli beams, the joints the cause), rigid joints as an option (Timoshenko beams rigid over a third of their radius within 4 % of the continuum, a fitted length), and Ban et al.’s case 9 examined (a factor 1.45 left, its coordination explained); the stiffness of the frames of beams of network realizations in the interface (Mechanics) and the command line ( |
Learned MFront laws, percolation exponents, tensors, tangents (2026-11-01) |
The MFront sources of the learned laws and the critical exponents of percolation: the learned laws written as MFront behaviours (the four models in C++, small and finite strains, heated and turned), equal to morphoGen’s integration to round-off through MGIS, umat and abaqus; the critical exponent t of the conductivity at the percolation threshold by finite-size scaling (2-D discs 1.13 +- 0.16 +- 0.21 for 1.30, 3-D spheres 2.37 +- 0.36 +- 0.32 for 2.0), the voxels of the FFT solvers found to conduct through their corners; then the elastic stiffnesses C_ij and compliances S_ij, not only E1, E2, E3, mu12, mu23, mu31 and nu12, nu21, etc.: the stiffness and the compliance, their notation stated, in every elastic output of the interface, the command line, the JSON files and the results database; then, following the phases planned (phase 4, version 1.0, without publishing anything): the JOSS draft, the conda-forge recipe and the citation file brought up to 0.6, kept in step with the package by a test, and the merge into main recorded among the steps of the release; the mean stiffness and compliance of each volume of the RVE studies, their scatter and the RVE size of each component; then the tensors of the window method, the elastic exponent f and the nonsymmetric tangents in morphoGen’s solvers: the stiffness, compliance and conductivity tensors of the RVE studies by windows, the tensor of a window the window means of the mutual energy densities (symmetric, positive, their mean over the windows tiling the box its tensor to round-off); the rigidity threshold of the voxels from their moduli by finite-size scaling (sites of the square lattice: 0.4647 +- 0.0056, between the thresholds through 8 and 4 neighbours) and the elastic exponent f there (2.47 +- 0.21 +- 0.34 with nu = 4/3, 2.24 with the 1.21 of central-force rigidity, below the 3.96 of bond bending); the nonsymmetric tangents in morphoGen’s solvers: the full tangents of the laws that have no symmetric one (learned perceptrons and recurrent networks, MFront laws declaring none, crystals with latent hardening, porous and kinematic laws, finite strains) solved by restarted GMRES on the CPU and the GPU, on voxels and finite elements, the symmetric cases unchanged to the bit (a learned recurrent network from 148 to 47 Newton iterations on voxels; the learned MFront laws converging through MGIS); then a solver fast near the rigidity threshold and f in 3D, shifted windows, the edges of planar windows and the restarts of GMRES: the shifted tilings of the window method on periodic images (no new solve; the variance pooled within the tilings, the count of the uncertainties that of one tiling) and the edges of planar windows as the square roots of their areas; the voxels’ own trilinear system on the bearing phase, solved by conjugate gradients on a sparse LU factorization in 0.04 to 0.6 s near the rigidity threshold where the FFT solver takes thousands of iterations or stops (an option, not the default: dense phases favour the FFT), and f measured with it, 2.88 +- 0.12 +- 0.23 on 16² to 256² sites of the square lattice (p_r = 0.4627 +- 0.0016) and 3.23 +- 0.30 +- 0.25 on 8³ to 32³ sites of the cubic lattice (p_r = 0.1307 +- 0.0009, between the thresholds through 26 and 18 neighbours); the restarts of GMRES deflated (GMRES-DR(50, 20): Rousselier’s softening points on 8³ voxels from 41,068 to 11,064 operator products, without stalled solves) and the tangent chosen by its measured asymmetry (the symmetric solvers below 2e-2 over all the points, where morphoGen’s own laws stay, up to 1.6e-2; the full tangents of the learned laws, 0.10 to 0.21), the localizing GTN composite found to bifurcate (the symmetric path the stable solution, the full one an unstable equilibrium); then the rigidity decided by the energies of the solutions, checked against the round-off of the element matrices (1,919 of 1,920 decisions on the planar realizations unchanged), the cut of the factorized voxels lowered to 1e-12, the voxels that cannot bear pruned exactly; the 3-D sites again on 8³ to 48³ (p_r = 0.12904 +- 0.00029, f = 4.58 +- 0.19 +- 0.07, the slope still steepening with the size), Boolean discs (p_r = 0.608 +- 0.006, f = 3.20 +- 0.19 +- 0.24) and spheres (p_r = 0.202 +- 0.004, f = 4.65 +- 0.59 +- 0.05), their exponents those of the sites within the errors; then the 2-D sites redone and the 3-D sites from 64³, the recycling of GMRES and the stalls of 16³, the shifts in the interface: the shifts of the window method in the RVE tool of the interface (refused on non-periodic morphologies with the messages of the API) and the areas of planar windows named on the axes of the figures; the recycling of GMRES (GCRO-DR from the first restart of a path: Rousselier on 16³ voxels from 55,869 to 14,947 products and 819 to 106 s, below CG with MINRES at 35,244), the solves stopped where their residual stagnates and the steps divided after three such corrections (the stalls of 16³ in one softening step whose preconditioned tangent has dozens of eigenvalues of both signs near zero), and auto decided by the largest asymmetry of a phase (a learned phase of 0.6 % of the volume keeps its full tangent); the rigidity confirmed at the floor of the residual (the factorized voxels solved to 1e-10, the energies under 1000 cuts solved again at 1e-11: the old 3-D threshold low by floppy images left bearing at 1e-8), the 2-D sites on 16² to 256² (p_r = 0.4617 +- 0.0004, nu = 1.14 +- 0.02 from the widths, f/nu = 2.26 +- 0.07 +- 0.05 rising with the size) and the 3-D sites on 8³ to 80³ (p_r = 0.1304 +- 0.0002, f/nu = 4.48 +- 0.09 +- 0.09, 4.85 +- 0.21 +- 0.18 with a correction to scaling: bond-bending-like in 3-D, not central-force, the 2-D class not told) |
3.7 Laser-architectured sheets (2026-11-06)¶
Topic |
Content |
|---|---|
Laser-architectured sheets (2026-11-06) |
A module dedicated to the simulation and optimization of sheets architectured by localized laser treatment, based on the thesis of Zhige Wang, on morphoGen and on the scientific literature. To be defined: the loading case, which defines the objective function; the base material; the treatment (thermal, carburizing, nitriding, diffusion through a coating…); the shape of the sheet or specimen; the laser configuration (single or symmetric); and the architecturing pattern, i.e. the path of the laser treatment. |
Delivered |
|
Cellular design of laser-treated sheets (2026-11-07) |
Beyond the first module, reaching at least the results of the paper of Wang et al. (2023) and of chapter 5 of the thesis: design and optimization with cellular automata and topology optimization, as proposed in SCOLASTIC; a survey of the scientific literature on such approaches, possibly with other materials. |
Delivered |
FR-L7–L9 ( |
Other loading cases and materials (2026-11-07) |
Other loading cases: the blunting of the crack of a CT specimen, proposed in SCOLASTIC, and the strength of an L-shaped plate; the control of the plastic anisotropy by the treatment; the application to alternative materials. |
Delivered |
FR-L10–L12 ( |
Compensation of the plastic anisotropy (2026-11-07) |
For the anisotropy: a textured sheet, typically with a rolling texture, treated so as to compensate its plastic anisotropy. |
Delivered |
FR-L13 ( |
3.8 Multiphysics, three dimensions, implicit geometry, documentation (2026-11-12 to 2026-11-14)¶
Topic |
Content |
|---|---|
Multiphysics homogenization (2026-11-12) |
The code and the documentation analysed and improved, so that the code is accessible to other researchers in the mechanics and physics of materials. The homogenization module to treat mechanical, thermal, electrical, electromagnetic, chemical, diffusive, optical and acoustic problems, static and dynamic, and the weak and strong couplings between these physics; the statistical analysis of RVE sizes for every physical property; nonlinear mechanical behaviour as a foundation: every module compatible with plasticity, viscoelasticity, hyperelasticity, ductile and brittle fracture mechanics, and damage models; an XFEM solver for the problems of mesh dependence. |
Delivered |
One homogenization module for every physics, with its guide for researchers (physics.md; theory.md §59–§66): the transport of a scalar potential (thermal, electrical, dielectric, magnetic, diffusive), the strong couplings on voxel images (piezoelectric, piezomagnetic, magneto-electro-elastic, thermoelectric), the weak couplings (swelling, the poroelasticity of Biot), the harmonic regimes (complex moduli and permittivities, the optical index), the scalar Bloch waves of sonic and photonic crystals; viscoelasticity, hyperelasticity and damage in every solver, beside the plasticity; the extended finite elements of level sets; the phase field of brittle fracture on voxel images; the RVE statistics of every result. |
Porous flow and acoustics (2026-11-13) |
Further development of the multiphysics module. |
Delivered |
The flow of a fluid through the pores (lattice Boltzmann) and the acoustics of porous media (theory.md §67–§68), with their templates; a tab Physics and the new behaviours in the graphical interface; a faster phase field and its tool; the band structures from the command line ( |
Three dimensions (2026-11-13) |
Every module of morphoGen available in 3D, not only in 2D. |
Delivered |
An audit of every module, then what worked only in the plane extended (theory.md §69–§74): light in three-dimensional photonic crystals (the vector waves of Maxwell’s equations), the particles of a phase separated in a volume, diamond and pyrochlore lattices of struts, the thermal oxidation in the voxels of a microstructure, cracks of any surface and front, the laser-treated sheet in its volume, sound at any incidence and in a diffuse field, a cell of negative Poisson’s ratio along its three axes, the vertex stars of the icosahedral tiling. |
Implicit geometry, finite strains, hyperelasticity (2026-11-13) |
Every model described in implicit geometry, so that exact geometries can be exported in the end; finite strains considered in every case; the hyperelastic models completed (Mooney-Rivlin, Arruda-Boyce, etc.); the graphical interface and the organization of its menus reviewed and improved. |
Delivered |
An implicit function for every phase of the 38 models, and conforming meshes of structures of several phases (theory.md §75); finite strains for the extended finite elements, for the phase field of fracture (§64) and for the volume of the laser-treated sheet; the strain energies of Rivlin’s polynomial, Yeoh, Arruda–Boyce and the eight chains, Gent, van der Waals, Fung, Ogden, Holzapfel–Gasser–Ogden, Blatz–Ko and Ogden–Hill, the softening of Mullins, and their fit to tests (§61); the interface in four sections, the tools of a tab under headings, a search of the tools and of their options, an address for each tool, a map, the exports of every phase. |
Documentation (2026-11-13) |
The tutorial, the gallery of examples, the documentation and the website enriched. |
Delivered |
NFR-8. Five tutorials whose snippets the tests run (tutorials.md: a whole study, the size of the representative volume, a rubber from its tests to its tearing, exact geometry from implicit functions to meshes, a tour of the graphical interface with screenshots taken by a script); recipes (howto.md), questions and troubles (faq.md) and a glossary (glossary.md); in the gallery, four templates more (a rubber, two cells that break, three phases meshed; a new family, Fracture), the curves that the runs compute on the cards of six templates, and planar sections of a volume in the configurations ( |
Quadratic elements (2026-11-14) |
Quadratic elements for the finite element analyses. |
Delivered |
An audit first: 10-node tetrahedra existed, with straight edges, and were the default of two tools only; six of the nine templates that analyse a mesh used 4-node elements, one with a plastic matrix (locking). Now (theory.md §76): isoparametric 10-node tetrahedra in the linear problems, the loading paths and the finite strains (the Jacobian of each integration point; straight elements unchanged); the nodes of the interfaces put on the implicit surfaces of the phases ( |
Isogeometric analysis, reduced integration (2026-11-14) |
Isogeometric analysis (IGA) and its application to shape optimization; quadratic elements with reduced integration for problems such as the near incompressibility of elastomers (Poisson’s ratio close to 0.5). |
Delivered (reduced integration) |
|
Delivered (isogeometric analysis) |
A package |
Delivered (isogeometric shape optimization applied) |
Periodic cells of any lattice — parallelograms (hexagonal arrays), or whole pieces of a pattern cut along no straight line —, validated by other cuts of the same cell (10⁻¹³) and by the series of Perrins et al. for arrays of holes (0.002 %); a sheet with alternating elongated holes (the rotating squares), auxetic down to a Poisson’s ratio of -0.975, confirmed by the FFT solver; design variables linked by the symmetries of a pattern and linear constraints on sizes; the lowest Poisson’s ratio at a given stiffness (-0.814 from -0.530) and an inverse design with a known answer; the image of an assembly on a grid, by which an optimized shape goes to the voxel solvers; a tutorial (tutorial_iga.md) whose snippets the tests run. Limit stated: for this pattern the free shape of the holes brings nothing beyond their two sizes — the ligaments decide. |
Sharp edges (2026-11-14) |
The sharp edges of the phases followed by the mesher: the limit that the quadratic elements had left, sharp edges rounded by the mesher. |
Delivered |
The conforming mesher follows the sharp edges of the phases (theory.md §80): the structures made of spheres and segments, their coatings and hollow members give the smooth pieces of their phases (primitives that do not overlap, by a colouring of their overlaps); the box is cut by the surface of each piece in turn and the lines where two cuts meet are kept as ridges through the remeshing ( |
Contact and damage (2026-11-14) |
Contact, self-contact and friction; then damage models. |
Delivered (first lot) |
Coulomb’s friction of the interfaces whose nodes match (theory.md §81): the cohesive laws and the contact of the lips of cracks take a coefficient of friction (the broken share of a point sticks and slides: Alfano & Sacco 2006), in small and finite strains; loadings in stages; the stress intensity factors and the energy release rate of cracks whose lips rub. Two blocks slide at T = μ N, a closed crack as under the shear less Coulomb’s; K_II within 2 % of the shear alone, G within 1 %. |
Delivered (second lot) |
Contact between surfaces that slide far, self-contact and rigid obstacles, with friction (theory.md §82): the package |
Delivered (third lot) |
Self-contact in the periodic cells of the nonlinear homogenization (theory.md §82): |
Delivered (fourth lot) |
The contact of the walls of the pores in configurations ( |
Delivered (fifth lot) |
Ready-made tests of contact (theory.md §82): |
Delivered (damage models) |
The second part of the requirement above (theory.md §83). What existed: the isotropic damage of quasi-brittle solids (crack band, delayed damage), the micromorphic damages (brittle and ductile), porous plasticity (Gurson, Rousselier), the phase field, cohesive zones, the softening of Mullins. Added, at the material point of every solver of the loading paths, in small and finite strains: damage coupled to the von Mises plasticity of a material ( |
Continuous integration, debonding, fatigue (2026-11-15) |
Further development and improvement of morphoGen, the lots taken from the limits that the previous deliveries had left and from the state of the continuous integration. |
Delivered (continuous integration) |
The two tests that failed on macOS in the last run of the workflow (the factorized solver of the rigidity percolation took 4 iterations where they asked for 3 at most) ask for fewer iterations than the FFT solver, and 10 at most; the numbers of tests of the README are those of today. |
Delivered (interfaces that debond) |
Cohesive interfaces in the periodic cells of the loading paths (theory.md §84): |
Delivered (high-cycle fatigue) |
Criteria of multiaxial fatigue on the stresses of the points of a cell along a cycle of a loading path (theory.md §85): |
Delivered (a limit lifted) |
The damage coupled to plasticity (Lemaitre, Kachanov-Rabotnov: theory.md §83) with Hill’s criterion, which the damage laws refused: the cumulated plastic strain is that of the norm dual to the criterion. |
Interface laws, figures, tools, tutorial (2026-11-15) |
The lots that the previous ones had left: a law per pair of phases and the maps of the interfaces, the fatigue in the figures, the tools of the interface, a tutorial. |
Delivered (interfaces: laws, fields, grains) |
A law for each pair of phases of a cell whose interfaces debond ( |
Delivered (interface: debonding, fatigue) |
The tool Loading path of a morphology of the graphical interface has the interfaces that debond (finite elements: those of the phases or of the grains, their strength, fracture energy, friction and viscosity; the debonded area, the damage and the opening in the values, the curves and the fields) and the fatigue of the cycle (a criterion and its two limits: utilization, factor of safety, share of the volume beyond, the fields and a figure); the configuration written beside the simulation reproduces both. |
Twinning and cleavage (2026-11-15) |
Twinning, cleavage, and intragranular and intergranular cracking in crystal plasticity. |
Delivered (twinning) |
Twins in the crystal plasticity of the grains (theory.md §86): systems that shear in one sense until the crystal has twinned (the pseudo-slip of Kalidindi, a saturation), the twins of the cubic lattices and four modes of the hexagonal one with their shears, and the slip families of hexagonal crystals (basal, prismatic, pyramidal); a fibre texture of the grains of tessellations; the twinned fraction as a field and a curve; checked against Schmid’s law in one sense, the shears of the modes, the saturation; the template |
Delivered (cleavage, cracks in and between the grains) |
Cleavage planes in the crystals (theory.md §87): opening and accommodation systems that soften (Marchal et al., Aslan & Forest), the fracture energy of the planes dissipated in a band of one element, a bound on the size of the elements; with the cohesive boundaries of the grains, cracks between the grains or through them, whichever is weaker; the opening and the damage of the planes as fields and curves; checked against the closed forms of a plane (strength, softening, work), the fracture energy of a crack band and the energy of an intergranular crack; the templates |
Delivered (the local approach of cleavage) |
The criterion of Beremin on the fields of a loading path (theory.md §88): |
Delivered (tutorial: how a microstructure breaks) |
A tutorial whose snippets the tests run (tutorial_fracture.md): interfaces that debond, the fatigue of a pore, the twins of a crystal and of a textured polycrystal of magnesium, the cleavage of a crystal and of a polycrystal of iron, the probability of cleavage of Beremin, each against a number known in advance; and a correction: the fatigue of a cycle on a voxel image with pores, whose voids are now left out. |
Delivered (interface: cleavage; compiled kernels) |
The box Cleavage of the tool of the loading paths of the graphical interface (the criterion of Beremin: its parameters, the stress that drives the cleavage, the plastic zone; the curves, a figure, the field, the configuration); and a revision of the compiled functions that hold the kernels of the crystals, so that the caches of an earlier version are not run in place of the new kernels. |
Delivered (contact: corners and edges) |
Contact points at the nodes of the faces (theory.md §82), the limit that the lots of the contact had left: |
Crack closure and twin reorientation (2026-11-15) |
The closure of cleavage cracks and the reorientation of twins. |
Delivered (cracks that close) |
The unilateral condition of the cleavage planes (theory.md §89): the opening of a plane follows the sign of its normal stress, back to nothing (Aslan & Forest 2009), and the closed plane carries the pressure as the sound crystal; the lips of a plane under pressure rub with Coulomb’s |
Delivered (twins that shear back and turn the lattice) |
Detwinning: the second variable of a twin is its net shear, which goes back to nothing under a reversed stress ( |
Delivered (twins: grain by grain; a resistance on the way back) |
What the reversal had left as limits (theory.md §89). |
Delivered (cleavage that the slip nucleates) |
The coupling of plasticity and damage of Aslan, Cordero, Gaubert & Forest (2011) for the cleavage planes of the crystals (theory.md §90), the limit that the cleavage had left (a constant strength: slip shielded cleavage for ever). |
Regularized cleavage (2026-11-16) |
The regularization of the cleavage by the microdamage of the reference, as an option. |
Delivered (cleavage planes regularized by their microdamage) |
The micromorphic regularization of Aslan & Forest (2009) for the cleavage planes of the crystals (theory.md §91), the limit that the coupling had left (a crack band of one element). |
Alternate scheme of the microdamage (2026-11-16) |
The tolerance and the passes of the microdamage in the configuration, and a faster alternate scheme where a crack runs. |
Delivered (the alternate scheme of the microdamage, accelerated) |
The options of the scheme in the configurations, |
Crystal kernel (2026-11-16) |
The crystal kernel, more than half of the time of the polycrystals. |
Delivered (the integration of the points, faster with the same results) |
The integration of the points of the loading paths (theory.md §32, The cost of a point), two to three times faster for the crystals with the same stresses, tangents and internal variables to the bit (372 arrays of short histories of 12 laws compared with those of the earlier kernels; the curves of five templates identical to the last digit). Two causes, found by replaying evaluations of the points taken from runs of the templates and by counting the cycles of each part of the kernels. (1) The work arrays of the laws were allocated in the parallel loop over the chunks of points: the rows that the kernels take of them at each call were objects whose references the compiled code counted, atomically — a third to a half of the time of a crystal point. They are allocated per chunk before the loop ( |
Linear iterations (2026-11-16) |
The linear iterations of the polycrystals (fewer of them, or a more compact tangent), at the price of results that change within the tolerances. |
Delivered (loading paths in fewer iterations) |
Fewer Newton and linear iterations along the loading paths (theory.md §31, The prediction of a step, the secant of the condensed block), by two changes of the path solver ( |
Multithreaded solvers (2026-11-17) |
Two further lots. The first one, from the profile that the previous lot left: the time of the finite element paths no longer followed their iterations, because the sweeps of the preconditioner and the products of the Krylov iterations ran on one thread. |
Delivered (the finite element solvers on several threads) |
The iterative solvers of the finite element problems (theory.md §11, Linear solvers) on all the threads, with results that do not depend on their number. (1) Gauss–Seidel sweeps in the order of the colours of the unknowns ( |
Delivered (the sweeps by nodes, the assembly by colours, the threads of BLAS) |
The second of the two lots above, from the profile that the first one left (theory.md §11, By nodes, The threads of BLAS, The assembly by colours); the iterations and the results are those of before. (1) Sweeps by nodes: where the unknowns are components of the displacements of the nodes, the nodes are coloured and the copy of the matrix that the sweeps read holds the 3 × 3 blocks of their couplings (4.4 bytes a value for 8); the three components of a node are relaxed one after the other. The sweep is the Gauss–Seidel sweep of the unknowns coloured one by one (the greedy colours of the components of a node follow each other), so the preconditioner is the same operator; the solvers take the degree of freedom of each unknown ( |
Product by nodes, preconditioner along a path (2026-11-17) |
The product of the matrix stored by blocks of nodes, and the preconditioner kept from a step of a loading path to the next. |
Delivered (the product by nodes, the preconditioner of a path kept from a step to the next) |
(theory.md §11, The product by nodes, The preconditioner along a path.) (1) The product by nodes: the products of the Krylov iterations read the matrix by the 3 × 3 blocks of its nodes in double precision ( |
Textures and orientation maps (2026-11-17) |
Textures and the import of EBSD maps, the first of four features considered alongside the release of version 1.0; the three others are on hold: the effects of the grain size in crystal plasticity (hardening by the gradients of slip), the second-gradient homogenization of architectured cells, real volumes (the segmentation of tomographs, out of scope in §4). The licence: decision D1 (§11). A complete test point (both tiers of the tests and the timed templates on 20 threads) precedes version 1.0. |
Delivered (textures and orientation maps: the core) |
(theory.md §92.) (1) |
Delivered (textures: figures, command, the texture of a map in a computed polycrystal) |
The second lot of the requirement above (theory.md §92). (1) |
Delivered (textures: the lattices along a loading path) |
The third lot of the requirement above (theory.md §92). The lattices of the crystals turn in finite strains (the rotation of the polar decomposition of the elastic part of the gradient; that of their twins): the material point gives the orientation of its lattice at each step ( |
Delivered (textures: a tutorial and a tool of the interface) |
The fourth lot of the requirement above. A tutorial whose snippets the tests run (tutorial_texture.md, From an orientation map to a textured polycrystal): the map that comes with morphoGen read with its axes, its grains and its texture, the stiffness of its polycrystal (the exact bulk modulus; the soft cube axes: 188 GPa for 227 GPa with orientations at random), a tension in finite strains in which the lattices turn (0.7° on average at 2 %), the fibres of a Taylor polycrystal at a stretch of 1.5, a polycrystal of space with the texture of the map; with its three figures. The tool Orientation map (EBSD) of the tab Statistics of the interface: the numbers of the grains and of the texture of a file, the tables of the grains and of their boundaries, the map in the colours of its crystals, pole figures, the inverse pole figure and the disorientations of the boundaries; its polycrystal joins the workspace. The first feature (textures and the import of EBSD maps) is delivered with these four lots; the three others stay on hold. |
3.9 Scale-rich networks and exact meshes (2026-11-11 to 2026-11-17)¶
Topic |
Content |
|---|---|
Scale-rich networks (2026-11-11) |
A feature of morphoGen from a paper on the nesting of scales in architectured materials: Both, Chen, Gao, Mooij, Charara, Wadhwa, Portela & Barabási, Scale-rich network-based metamaterials, Nature 659, 345, 2026. |
Delivered |
FR-G17 ( |
Scale-rich networks in 3D (2026-11-12) |
Three-dimensional microstructures of the model. |
Delivered |
FR-G18 ( |
Exact meshes (2026-11-12) |
Every morphology generated as exact geometry, as in VTK, to avoid voxelization, the initial idea of the program (clean geometry, then clean mesh); exact meshes for all (no background grid any more: exact polyhedra, adaptive refinement on the exact function for implicit surfaces). |
Delivered |
FR-E9 ( |
Exact meshes by default (2026-11-13) |
|
Delivered |
FR-E9: |
Integration with §3.8 (2026-11-17) |
The developments of §3.8 and of this section, made apart, merged |
Delivered |
|
Exact route everywhere (2026-11-17) |
The decision of 2026-11-13 (the exact mesh as the default) applied in full: the two interfaces of the implicit functions, on grids and at points, made one, and the exact route extended to what stayed on the grid: partitions of several phases, the sharp edges of smooth pieces, the phases kept by a list; one curvature of the 10-node elements |
Delivered |
FR-E9 (theory.md §75, §76, §80, §94): one interface of the functions of the phases, |
4. Scope¶
In scope:
the generation of microstructures, their description and measurement;
RVE statistics;
exports for FE and FFT codes and for additive manufacturing;
the Python API, the command line and configuration files;
later, a graphical interface and GPU acceleration.
computational homogenization (phase 2): finite elements on conforming tetrahedral meshes and an FFT solver on voxel images, for the apparent elastic and thermal properties used in RVE studies; polycrystals of anisotropic crystals (phase 2b, §3.3).
parallel runs on one machine and on clusters (phase 2b).
generation by cellular automata and lattice growth processes, combinatorial design of assemblies and frameworks, topology optimization of periodic cells, visualization and a graphical interface (phase 3a, §3.2).
the periodic element (macroscopic strains and stresses as unknowns), thermo-elasticity, post-processing of macroscopic and normalized values, a database of the configurations tested with Ashby charts, nested and bio-inspired models (phase 2c, §3.4).
nonlinear behaviours along loading paths, crystal plasticity and finite strains on cells and RVEs (phase 2c, §3.4); behaviours written in MFront, integrated through MGIS (phase 3b, §3.5).
Out of scope for now:
Non-linear analyses of structures: morphoGen’s nonlinear behaviours (phase 2c) and the MFront behaviours (phase 3b) follow loading paths on cells and RVEs; for structures, morphoGen exports meshes, volumes and material files for the codes that handle them (Abaqus/CalculiX, FEniCSx, DAMASK, AMITEX_FFTP), and fits their results (FR-V5).
Segmentation of real images. morphoGen measures binary and label images, and finds the grains of orientation maps (EBSD: their points come with the orientation of the crystal, §3.8), but does not segment micrographs or tomographs (on hold: §3.8).
CAD editing, and features tied to commercial software.
5. Functional requirements¶
Priority: M must, S should, C could. Phase: see §10 (1 = this first version, 0.1).
5.1 Morphological models¶
Id |
Requirement |
Prio. |
Phase |
|---|---|---|---|
FR-G1 |
Boolean model of spheres (Poisson germs, constant or random radii), given by its volume fraction or its intensity |
M |
1 |
FR-G2 |
Poisson fibres: Boolean model on isotropic Poisson lines (infinite cylinders), non-periodic (Dirrenberger et al. 2014) |
M |
1 |
FR-G3 |
Boolean model of finite fibres: cylinders or spherocylinders with radius and length distributions and an orientation distribution (isotropic, aligned, planar) |
M |
1 |
FR-G4 |
Hard-core spheres by random sequential addition: target fraction, minimal gap, polydispersity |
M |
1 |
FR-G5 |
Voronoi and Laguerre tessellations (Poisson or fixed number of germs), with a phase per cell (multiphase mosaics) and random crystal orientations |
M |
1 |
FR-G6 |
Excursion sets of Gaussian random fields, given by their correlation length and volume fraction |
S |
1 |
FR-G7 |
TPMS (gyroid, Schwarz P and D, Neovius), sheet or network, given by a level or a target fraction |
S |
1 |
FR-G8 |
Strut lattices (cubic, BCC, FCC, octet), given by a strut radius or a relative density |
S |
1 |
FR-G9 |
Further models: random laminates with layer breakup (Bironeau 2016), Laguerre germs from packings, dead leaves, Kelvin cells (2b); Johnson–Mehl tessellations (3a); multiscale and clustered (Cox-like) inclusions as combinations (FR-G12); hard-core fibres, dense packings beyond the RSA limit (Lubachevsky–Stillinger), curved fibres (worm-like chains, arcs of distributed radii of curvature as in PuMA, helices; overlapping or not; hollow), graded or rotated lattices, dead leaves of families of their own sizes, of spheroids and of finite coverage, penetrable spheres with impenetrable cores (the cherry-pit model), transparent dead leaves, Voronoi tessellations of stealthy hyperuniform germs (3b) |
S |
2b–3b |
FR-G10 |
Every model works in periodic and non-periodic boxes when this is meaningful; non-periodic samples are unbiased windows of the stationary model |
M |
1 |
FR-G11 |
A realization is determined by (model, domain, seed, version); seeds of a study are derived from the study seed and the item indices, independently of how the study is split across jobs |
M |
1 |
FR-G12 |
Combination of models: union, intersection, difference, complement (with combined level sets), inclusions in a polycrystal (keeping its grains and orientations), grain-boundary phase of tessellations |
S |
2b |
FR-G13 |
Nested models: a model filling the phase 1 of another (Cox spheres in aggregates, nested combinations), coatings and hollow members, hierarchical lattices of frames of tubes (Rayneau-Kirkhope et al. 2012), fractal sponges (iterated function systems), hollow strut lattices |
M |
2c |
FR-G14 |
Bio-inspired models: nacre (brick and mortar), Bouligand plywoods, honeycombs and wood (radial files, growth rings, rays), Haversian bone (remodelled osteons), open-cell foams and trabecular bone (anisotropic, relaxed cells), branching networks grown by space colonization with Murray’s law; with their closed-form characteristics |
M |
2c |
FR-G15 |
Stochastic reconstruction of two-phase microstructures from their descriptors (Yeong & Torquato 1998): the two-point probability and the lineal-path function along the axes, the targets of a Debye medium, of a model or of an image |
S |
3b |
FR-G16 |
Foams as level sets of distance fields (3b, after Degdeg & Dirrenberger 2026, Sonon et al. 2012 and Kilingar et al. 2019): seeds of aligned polydisperse ellipsoids densely packed, struts with Plateau-border cross-sections of controlled curvature thickening towards the nodes, open or closed cells, the thickness solved for a solid fraction, a level set for conforming meshes; the scale and shape factors of the seeds calibrated on the mean radii of the sections of the pores |
S |
3b |
FR-G17 |
Scale-rich networks (after Both et al. 2026): ligaments of thicknesses |
S |
3b |
FR-G18 |
Scale-rich networks in 3D: plates splitting convex polyhedral voids into closed cells, or beams grown until they touch; normals or axes uniform, from an orientation law or polarized by a pole; the density and the jamming threshold of plates in closed form, the tails of their areas and degrees; a mean field of the beams |
S |
3b |
5.2 Representations¶
Id |
Requirement |
Prio. |
Phase |
|---|---|---|---|
FR-R1 |
Vector: explicit primitives (centres, radii, axes), germs and weights, Fourier modes, analytic surfaces; saved as JSON, CSV for tables |
M |
1 |
FR-R2 |
Implicit: level-set fields on any grid (exact signed distances for unions of grains) and point membership queries |
M |
1 |
FR-R3 |
Voxel: phase or label images at any resolution, with optional partial-volume voxels (supersampling) |
M |
1 |
FR-R4 |
Chunked generation of volumes larger than memory: slabs written to memory-mapped raw files with an XDMF or MetaImage header |
S |
2b |
5.3 Morphological characterization¶
Id |
Requirement |
Prio. |
Phase |
|---|---|---|---|
FR-M1 |
Theoretical characteristics of each model when known: volume fraction, specific surface, covariance, integral range, variance exponent, cell statistics |
M |
1 |
FR-M2 |
Measurements on images: volume fraction, specific surface (Crofton, 3 or 13 directions), covariance (periodic or not), connected components and percolation, cell volumes and neighbours |
M |
1 |
FR-M3 |
Granulometry by openings, chord-length distributions, Minkowski functionals and Euler characteristic, pore sizes (local thickness), geometric tortuosity (2b); the lineal-path, two-point cluster and pore-size functions, the radial distribution function and the structure factor of point patterns (3b); (3b) Choquet capacities T(K) of balls, segments, pairs of points and cubes (dilations, erosions, openings, closings), spherical and linear contact distributions, the morphological covariance of grey-level images, the integral of mean curvature (plane sections) and the Minkowski curves of excursion sets, Betti numbers and connectivity density; (3b) mean intercept lengths and the MIL fabric tensor (principal MILs and axes, degree of anisotropy), the first minima of the covariance along the axes (hole effect); stereology: sections by the grid planes (watershed separation, frame correction), Saltykov’s unfolding for spheres and oriented ellipsoids, the shape consistency of the section radii |
S |
2b–3b |
FR-M4 |
Statistical analysis of apparent properties after Dirrenberger et al. (2014): intervals, relative errors, fitted and imposed exponents, RVE sizes and object counts, discrepancy between boundary conditions, isotropy (written from the paper, no earlier code existing) |
M |
2 |
5.4 RVE statistics¶
Id |
Requirement |
Prio. |
Phase |
|---|---|---|---|
FR-V1 |
Point variance (two-phase and multiphase), ensemble statistics per size, relative error |
M |
1 |
FR-V2 |
Fit of D²(V) = K V^-γ with γ free or imposed, on a chosen range of sizes; A₃ or A₃* when D² is known |
M |
1 |
FR-V3 |
RVE volume for (ε_rel, n), and number of realizations for (V, ε_rel) |
M |
1 |
FR-V4 |
Ensemble method (independent realizations per size) and window method (sub-volumes of a large realization or of any scalar field) |
M |
1 |
FR-V5 |
Fit of external tables (CSV), e.g. apparent moduli from FE/FFT codes or image measurements |
M |
1 |
FR-V6 |
Bootstrap confidence intervals of γ, K and V_RVE (phase 2); detection of several scaling regimes (Bironeau 2016) |
C |
2 |
FR-V7 |
RVE statistics of nonlinear responses: quantities of the curves of loading paths (a component of the strain or stress, a mean of a phase, the cumulated plastic strain, at the end of the path or of one of its steps: the flow stress at given strains) analysed as the apparent properties, in configurations and by |
S |
2c |
5.5 Exports and interoperability¶
Id |
Requirement |
Prio. |
Phase |
|---|---|---|---|
FR-E1 |
Voxel volumes: VTK XML (.vti), legacy VTK (.vtk, cell data, for FFT codes), MetaImage (.mhd/.raw), NumPy (.npz/.npy), TIFF stacks (optional dependency) |
M |
1 |
FR-E2 |
Hexahedral voxel meshes of selected phases, with phase element sets, face node sets and periodic node pairs: Abaqus/CalculiX .inp, Gmsh .msh 2.2 with boundary groups, VTK .vtu; other formats through meshio (e.g. XDMF for FEniCSx) |
M |
1 |
FR-E3 |
Watertight surface meshes (STL) from level sets, closed on the box faces (additive manufacturing) |
M |
1 |
FR-E4 |
Gmsh OpenCASCADE scripts (.geo) of unions of spheres and cylinders, for conforming tetrahedral meshes with the external gmsh program |
S |
1 |
FR-E5 |
Robust conforming tetrahedral meshes from implicit geometry (MMG level-set discretization), with matching opposite faces when the microstructure is periodic (along all or some of the axes); meshes of cells symmetric about their mid-planes mirrored from their irreducible part (exact symmetries, matching faces, copies side by side), with the diagonal mirrors of square and cubic cells (the groups 4/mmm and m-3m: the chamber of the group meshed and mapped by its operations); implicit bodies of level-set functions; exports to Abaqus/CalculiX, Gmsh, VTK, Medit and meshio formats |
M |
2 |
FR-E6 |
XDMF outputs (raw binary data, no HDF5 dependency), FEniCSx meshes with phase, grain and face tags, Neper seed files, DAMASK grids and material files, periodic constraint equations for Abaqus/CalculiX (2b), the materials of the phases in Abaqus inputs (3b); AMITEX_FFTP runs of images (material and zone fields, material, loading and algorithm files, MPI script; small and finite strains) and the reading of their results (3b), the nonlinear materials as MFront laws of the umat interface (3b; in finite strains every phase) |
S |
2b–3b |
FR-E7 |
MFront sources of the nonlinear materials (von Mises or Hill plasticity and crystal plasticity, in small and finite strains; Hencky’s elasticity in finite strains), for the codes that integrate MFront behaviours (AMITEX_FFTP and Cast3M, Abaqus, Code_Aster, MGIS), and the materials of AMITEX and Abaqus inputs (conforming and voxel meshes, small and finite strains), the user’s MFront laws included; checked against morphoGen’s kernels |
S |
3b |
FR-E8 |
Raw data and figures (3b): tables as .csv, tab-separated .txt and .xlsx (no dependency); figures as .png, .tif, .svg, .pdf and TikZ (pgfplots code of matplotlib figures, compiled by LaTeX in the tests); one entry point |
S |
3b |
FR-E9 |
Exact conforming meshes without a background grid: from the exact cells of tessellations, the exact convex pieces of faceted morphologies, or the exact point-wise level set of the others on an adaptive octree, the nodes of the interface on the exact surface, matching opposite faces when periodic; the default ( |
S |
3b |
5.6 Interfaces¶
Id |
Requirement |
Prio. |
Phase |
|---|---|---|---|
FR-I1 |
Documented Python API (library usable from scripts and notebooks) |
M |
1 |
FR-I2 |
Command line: run a configuration, fit RVE data, analyse an image, estimate the percolation threshold of a model, homogenize a sample, list and describe models, print example configurations |
M |
1–2 |
FR-I3 |
Configuration files in YAML (JSON and TOML accepted), validated with explicit error messages |
M |
1 |
FR-I4 |
Graphical interface: forms built from the parameter descriptions, sections, generation, measures, export; animations of the formation of structures; live topology optimization; design-space exploration; the whole chain on one realization (model, mesh or voxels, materials, apparent property, views of the fields on the deformed mesh, videos, every file and the configuration to download; views redrawn without solving again) ( |
M |
3a |
FR-I6 |
Figures: sections, periodic tilings, 3D surfaces, histories, transformation kinetics, animated GIFs ( |
S |
3a |
FR-I7 |
Videos (3b): .mp4 (ffmpeg), .gif or PNG frames, played once, in a loop or back and forth; sections sweeping through a voxel image and the three orthogonal sections (Avizo-like), turntables of phases and meshes, cross-sections sweeping through a mesh and fields animated with a magnified displacement, coloured by matplotlib colormaps on a fixed range (3D views rendered off screen by VTK) |
S |
3b |
FR-I8 |
The whole chain in one configuration (3b): from the morphological model to its voxel image, conforming mesh and the fields of the homogenization; the |
S |
3b |
FR-I5 |
Parameter metadata (description, kind, unit, default) available programmatically, for the command line, the documentation and the future GUI |
S |
1 |
5.7 Batch and HPC¶
Id |
Requirement |
Prio. |
Phase |
|---|---|---|---|
FR-B1 |
Multithreaded kernels, with a thread-count option |
M |
1 |
FR-B2 |
Studies split across cluster jobs (task id and number of tasks, e.g. SLURM job arrays), with per-task result files and a merge step |
M |
1 |
FR-B5 |
Parallel realizations on one machine (process pool with a thread budget) and on clusters: job arrays of SLURM, PBS Pro, Torque, SGE, OAR and LSF written and submitted with a dependent merging job, task id read from the scheduler, MPI; per-realization records, resumption of interrupted runs, status; results independent of the splitting |
M |
2b |
FR-B3 |
GPU acceleration of the heaviest kernels as an optional backend: the FFT solvers of voxel images, linear and along loading paths (the integration of the behaviours included), on NVIDIA GPUs (CuPy, D3), chosen per problem ( |
S |
3b |
FR-B4 |
Distributed generation of a single gigantic volume (slab decomposition) |
C |
4 |
5.8 Homogenization¶
Id |
Requirement |
Prio. |
Phase |
|---|---|---|---|
FR-H1 |
Apparent elastic (bulk and shear moduli, stiffness tensor) and thermal (conductivity, tensor) properties of each realization, with the volume averages, energy estimates and per-phase statistics of the fields; pores carry no stress nor flux |
M |
2 |
FR-H2 |
Kinematic (KUBC), mixed (MBC, Dirrenberger et al. 2014), periodic (PBC) and static (SUBC, non-porous media) boundary conditions |
M |
2 |
FR-H3 |
Finite elements on the conforming meshes of FR-E5: 4-node and 10-node tetrahedra; no finite elements on voxels |
M |
2 |
FR-H4 |
FFT solver of voxel images (periodic conditions), in particular for models without a level set (tessellations) |
M |
2 |
FR-H5 |
Solvers for 10⁵–10⁶ unknowns on a laptop, without compiled dependencies beyond binary wheels |
M |
2 |
FR-H6 |
Validation: exact solutions (homogeneous media, laminates), an independent finite element code, ordering of the boundary conditions, bounds (Table 4 of the 2014 paper) |
M |
2 |
FR-H7 |
Isotropy criteria (eqs. 72–74) and discrepancy between conditions (eq. 69) |
M |
2 |
FR-H8 |
Local fields (stress, strain, energy, flux) written for ParaView |
S |
2 |
FR-H9 |
Homogenization within configurations and RVE studies (one results row per realization, a long table per property and condition), and from the command line |
M |
2 |
FR-H10 |
Conforming meshes of tessellations (polycrystals) for finite elements: one subdomain per grain, from the exact cells, with the features smaller than a length removed, matching periodic faces |
M |
2b |
FR-H11 |
Anisotropic phases: cubic, hexagonal or general stiffness and conductivity tensors turned by the orientation of each grain, in the finite element and FFT solvers; bounds of polycrystals |
M |
2b |
FR-H12 |
Periodic polycrystals meshed from their whole cells (periodized at the design): the boundary of the union made of translated facets meshed alike, node-to-node periodic links |
M |
2c |
FR-H13 |
Macroscopic loadings mixing prescribed strain and stress components (the periodic element of Z-set), in elasticity and conduction, for every boundary condition and both solvers; named loadings in configurations and on the command line |
M |
2c |
FR-H14 |
Thermo-elasticity: thermal expansion of the phases, apparent thermal expansion tensor, thermal stresses; Levin’s relation and bounds |
M |
2c |
FR-H15 |
Post-processing: engineering constants, anisotropy indices, macroscopic values of porous media, relative, normalized and specific values |
M |
2c |
FR-H16 |
Nonlinear behaviours of the phases: von Mises elasto-viscoplasticity (Norton flow, linear and nonlinear isotropic and kinematic hardening) and rate-independent plasticity, integrated implicitly with their consistent tangent, and Hill’s anisotropic criterion with the same hardenings (2026-10-29); a material point simulator |
M |
2c |
FR-H17 |
Loading paths in time (each component a strain or a stress, and a change of temperature, piecewise linear) solved by finite elements with the macroscopic strain components as degrees of freedom of the Newton iterations (the periodic element), under periodic and kinematic conditions; macroscopic curves, phase averages and element fields; configurations and command line |
M |
2c |
FR-H18 |
Crystal plasticity of Méric and Cailletaud for polycrystals: slip families of cubic crystals (octahedral, cube, {110} and {112} bcc), Norton flow, nonlinear isotropic hardening with an interaction matrix (Franciosi’s six interactions) and nonlinear kinematic hardening per system; slip systems turned by the orientation of each grain; implicit integration with its consistent tangent, robust for large steps |
M |
2c |
FR-H19 |
Finite strains for every nonlinear behaviour and loading path: total Lagrangian finite elements, elasticity and von Mises plasticity in the logarithmic strain space, multiplicative crystal plasticity with lattice rotations; nominal, true (Cauchy) stresses and logarithmic strains as outputs; the material point simulator, configurations and command line |
M |
2c |
FR-H20 |
Loading paths on voxel images by the FFT solver: the periodic element on trilinear voxels whose volumetric strain is averaged over each voxel (B-bar, F-bar: no locking under plastic flow), Newton–Krylov iterations (conjugate gradients preconditioned in Fourier space, the tangent applied without assembly), small and finite strains, von Mises and crystal plasticity in the grains of a label image; configurations ( |
M |
2c |
FR-H21 |
Behaviours written in MFront (TFEL) for every nonlinear solver: standard strain-based behaviours in small strains, standard finite strain behaviours in finite strains (first Piola–Kirchhoff stress and its derivative), integrated point by point by MGIS with their consistent tangents, by finite elements, on voxels (CPU and GPU) and at a material point; crystals turned by the orientation of each grain; material properties, parameters, temperature and external state variables; |
S |
3b |
FR-H22 |
Couplings of transport, chemistry and mechanics (3b): transient diffusion in voxel images (heterogeneous diffusivities and solubilities, exposed faces, first-order consumption); thermal oxidation of polymers by the closed-loop scheme, homogeneous or diffusion-limited (Ernault et al. 2019); properties as functions of an ageing tracer and graded phases of tracer fields for every solver and export (shrinkage and swelling as eigenstrains); Ekenstam’s hydrolysis of cellulose with the critical degree of polymerization of Vibert et al. (2024); hygromorph multilayers: moisture through the thickness and curvatures of the free plate (Mou et al. 2025); transient diffusion in configurations ( |
S |
3b |
FR-H23 |
FEniCSx as the solver of the finite element problems of tetrahedral meshes (3b): |
S |
3b |
FR-H24 |
Nonuniform transformation field analysis (3b; Michel & Suquet 2003, 2004): reduced models of periodic voxel microstructures of von Mises phases with isotropic and kinematic hardening (plastic or viscoplastic), modes by POD of full-field snapshots, elastic influence fields by FFT, reduced laws integrated implicitly along loading paths under strain, stress or mixed control, local fields rebuilt, models stored; in configurations ( |
S |
3b |
FR-H25 |
Bloch waves in periodic cells (3b): the band structure of the elastic waves of tetrahedral meshes and voxel images along the edges of the Brillouin zone (Bloch-periodic map of the fluctuations, consistent mass matrices of 4- and 10-node elements, shift-invert Lanczos), band gaps and figures |
S |
3b |
FR-H26 |
Post-bifurcated patterns of periodic architectured materials by group theory (3b, after Azulay & Combescure 2024): symmetry groups of cells of several primitive cells restricted to the loading, real irreducible representations computed from the regular representation, the axial isotropy subgroups of the equivariant branching lemma, the patterns that minimize the elastic energy in their fixed-point and isotypic subspaces, the first bifurcation of a loading by linear buckling in each isotypic subspace; periodic plane frames of Euler-Bernoulli beams (honeycomb, triangular, square, kagome) and frames of struts in space (cubic, body-centred cubic, octet, Kelvin; 3D Euler-Bernoulli beams of circular section, torsion, the O_h group with the centring translations, their apparent stiffness against the scaling laws of lattice materials), and their Bloch-wave stability, which selects the cell; Schoenflies symbols of the point groups in space; continua (tetrahedral meshes and voxel images): the initial-stress matrix of the periodic prestress, the symmetries detected on the mesh, mechanisms left out; along nonlinear loading paths in finite strains with nonlinear behaviours (Hencky elasticity, von Mises elasto-(visco)plasticity, crystals, MFront laws): the consistent tangent of each converged step block-diagonalized in the isotypic subspaces of the group restricted to the path, the macroscopic components of prescribed stress condensed, the first loss of positive definiteness of a block (time, irrep, multiplicity, softest patterns) and the switch to the bifurcated branch by an equivariant imperfection; checked against the linear buckling of slender columns, the pattern transformation of a square array of holes (alternating ellipses, plateau, negative Poisson’s ratio) and an elastoplastic column; conforming mirrored meshes of level sets, whose symmetries are exact, with the diagonal mirrors of square and cubic cells (equibiaxial compression of square arrays of holes, cubic cells and their three-dimensional irreps) (Bertoldi’s specimen 1 within the extrapolation of 2.3-2.6 % against 2.25 % in uniaxial strain); cells of several primitive cells split first by their translations (the wave vectors Γ, X, M and R and their stars) and then by the little co-groups of the wave vectors (Clifford’s theory), without dense bases of the whole cell, and the wave vectors of each irrep (the patterns that double the period) |
S |
3b |
FR-H27 |
The material files of Z-mat (Z-set) read and translated (3b): gen_evp behaviours (elasticity, thermal strain, potentials with their criterion, flow, isotropic and kinematic hardening) on morphoGen’s kernels when they are von Mises elasto-(visco)plasticity, otherwise as MFront behaviours of the brick StandardElastoViscoPlasticity (Hill’s criterion, user-defined viscoplastic flows, power-law hardening, softening, Burlet-Cailletaud, several potentials); linear elastic behaviours of any symmetry; in configurations ( |
S |
3b |
FR-H28 |
Cohesive zone elements (3b: the interfaces of composites and fracture): bilinear mixed-mode (Benzeggagh-Kenane) and exponential (Ortiz-Pandolfi) traction-separation laws, irreversible, with contact in compression; zero-thickness interface elements between linear tetrahedra, in small and finite strains (the frame of the current mid-surface; a neo-Hookean bulk); interfaces inserted between phases or along chosen faces by duplicating nodes (crack fronts kept closed); a quasi-static Newton solver with step divisions and viscous regularization; the length of the cohesive zone, the strength of coarse meshes and the double cantilever beam against the corrected beam theory (Linke & Lammering 2023) |
S |
3b |
FR-H29 |
Crack propagation in 3D (3b: by remeshing as Z-cracks, and by XFEM): planar cracks described by two level sets (straight and circular fronts); conforming meshes (MMG through the level set of the plane, or faces on it) with the crack faces opened by duplicated nodes and the body remeshed at each step; XFEM on linear tetrahedra with jump and branch enrichments and the integration of cut elements on sub-tetrahedra; the energy release rate by the compliance of the uniform advance of the front; propagation by Paris’ law or Griffith’s criterion; checked against the handbook factors of an edge crack (small strains, mode I) |
S |
3b |
FR-H30 |
Mixed-mode cracks in 3D, in small and finite strains (3b): the energy release rate along the front by the G-θ method (Eshelby’s energy-momentum tensor of the reference configuration, exact for a neo-Hookean body; its mean or its profile at stations along the front); the stress intensity factors of modes I, II and III by interaction integrals (the plane-strain and antiplane fields of Williams; the mean rotation removed; the work of the tractions of lips in contact; the curvature terms of curved fronts), turned back by the polar rotation in finite strains (objective); frictionless contact of the lips; dead loads; kinked cracks (polylines extruded along a straight front) remeshed by MMG with their front on edges, kinking by the largest hoop stress (Erdogan & Sih) and fatigue propagation by Paris’ law; checked against the handbook (mode I), the exact antiplane strip (mode III), a penny crack in shear (Kassir & Sih: the three modes along a curved front), the energy of the body (each mode, finite strains, kinked cracks), the superposition of modes, a superposed rotation and the local symmetry of kinked paths |
S |
3b |
FR-H31 |
Porous elasto-(visco)plasticity, the |
S |
3b |
FR-H32 |
Micromorphic continua (3b: the microfoam model of Forest’s article, and nonlocal models to crack with, in finite strains): mixed tetrahedra (quadratic displacements, linear generalized degrees of freedom) with a Newton solver (optionally from the increment that the last tangent predicts); the microfoam model of Dillard, Forest & Ienny (2006: the anisotropic compressible plasticity of nickel foams with the article’s parameters, a full micromorphic microdeformation) in small and finite strains (total Lagrangian: the plasticity in the logarithmic strains, the objective measures |
S |
3b |
FR-H33 |
Cracks in inelastic solids, in small and finite strains (3b): the behaviours of morphoGen’s points as the bulk of the crack solvers (porous plasticity GTN, Rousselier, elliptic; von Mises elasto-viscoplasticity with Hencky’s logarithmic strains in finite strains, crystal plasticity with the orientations of the grains, MFront laws; internal variables committed at the converged steps, consistent tangents; with cohesive zones, the contact of the lips and dead loads); the works of the loads, the bulk and the interfaces; the driving forces of dissipative solids: the J of the deformation theory (the work density), the configurational force of the free energy and the driving force at the tip with the configurational forces of the internal variables; checked against the elastic bulks (points that never yield), the release of the work of the loads (Begley & Landes) and the independence of the tip value from the domain; the R-curve of a cohesive crack in an elasto-viscoplastic plate and the intergranular cracking of a polycrystal in crystal plasticity; remeshed propagation in inelastic bodies: the state of the points transferred between the meshes of successive cracks (the nearest element, or a projection on the nodes; the lips apart; the |
S |
3b |
FR-H34 |
Identification of the parameters of a behaviour on a reference response, as Zopt for Zsim (3b, with the review of the sequence of the modules): the elastic constants and the parameters of von Mises plasticity (yield stress, linear, isotropic and kinematic hardenings, Norton’s flow) or of porous plasticity (its matrix, the initial porosity, Gurson’s q1 and q2, the coalescence, Rousselier’s and the elliptic coefficients, the nucleation: the Gurson model of a porous morphology under several triaxialities) such that the material point under the path of the reference gives its stresses over time in the least-squares sense (the parameters positive); the reference the macroscopic response of a loading path of a morphology, a material point or the points of a test; several references followed together, each by its weight whatever its number of points (a tension and a cycle in shear tell the isotropic hardening from the kinematic one); in the interface, the behaviour identified kept in the workspace |
S |
3b |
5.9 Cellular automata and lattice growth¶
Id |
Requirement |
Prio. |
Phase |
|---|---|---|---|
FR-A1 |
Binary cellular automata on 2D and 3D lattices: von Neumann, Moore, edge and Euclidean neighbourhoods of any radius; periodic or fixed boundaries; Life-like B/S rules with ranges, majority, annealing (Vichniac), majority at conserved volume fraction, probabilistic and activator–inhibitor (Young) rules |
M |
3a |
FR-A2 |
Synchronous, asynchronous and sequential updates; histories of the volume fraction, changes and interface density |
M |
3a |
FR-A3 |
Reaction–diffusion (Gray–Scott) with pattern presets |
S |
3a |
FR-A4 |
Nucleation and growth with Johnson–Mehl–Avrami–Kolmogorov kinetics: site saturation and continuous nucleation, isotropic or faceted oriented growth, partial transformations; Avrami theory (exponent, transformed fraction, grain density) |
M |
3a |
FR-A5 |
Normal grain growth (Monte Carlo Potts model), reproducible in parallel |
S |
3a |
FR-A6 |
Aggregation: diffusion-limited, Eden and ballistic, clusters and deposits, with sticking probability; fractal dimension (theory and box counting) |
S |
3a |
FR-A7 |
Lattice microstructures usable like the other models: any resolution, level set for conforming meshes, grain labels and orientations, JSON storage, unbiased non-periodic windows |
M |
3a |
FR-A8 |
Formation histories (frames) of the automaton and growth models |
S |
3a |
5.10 Combinatorial design¶
Id |
Requirement |
Prio. |
Phase |
|---|---|---|---|
FR-D1 |
Tile sets with labelled faces (equal or opposite matching), rotations, voxel geometry of assemblies; polarized blocks of combinatorial metamaterials (after Coulais et al. 2016) and pipe networks with controlled node degrees |
M |
3a |
FR-D2 |
Compatible assemblies by wave function collapse with backtracking, with boundary labels and per-cell restrictions; proof of infeasibility when the search is exhausted |
M |
3a |
FR-D3 |
Exact counting and exact uniform sampling of compatible assemblies (transfer matrices); exact count of polarized-block assemblies for larger boxes |
S |
3a |
FR-D4 |
Strut lattices with defects (random dilution to a mean coordination, node perturbation) and the rigidity of their pin-jointed frameworks (mechanisms, self-stresses, floppy macroscopic strains; Maxwell–Calladine) |
M |
3a |
FR-D5 |
Generic search algorithms (simulated annealing, genetic algorithm) and the inverse design of automaton rules from target descriptors or an image ( |
S |
3a |
5.11 Topology optimization¶
Id |
Requirement |
Prio. |
Phase |
|---|---|---|---|
FR-O1 |
Homogenized stiffness and conductivity tensors of periodic voxel cells with graded moduli, and their exact sensitivities, with the FFT solver |
M |
3a |
FR-O2 |
Objectives: bulk and shear moduli, Poisson’s ratio (auxetics), conductivity, target tensor; 3D and planar (prismatic) cells |
M |
3a |
FR-O3 |
Density filter, Heaviside projection with continuation, orthotropic and cubic symmetry |
M |
3a |
FR-O4 |
Methods: optimality criteria, method of moving asymptotes, BESO, hybrid cellular automaton |
M |
3a |
FR-O5 |
Designs exported as lattice microstructures (level set from the densities) for meshing and finite element validation; configuration files and |
M |
3a |
FR-O6 |
Validation against exact solutions, finite differences and Hashin–Shtrikman bounds; black-and-white designs checked for hinges (voxels touching only along an edge or at a corner) and re-evaluated on a finer grid |
M |
3a |
5.12 Results database and Ashby charts¶
Id |
Requirement |
Prio. |
Phase |
|---|---|---|---|
FR-P1 |
A database (one file, no server) of every configuration tested and of its results per realization, filled by runs or afterwards, exported to CSV |
M |
2c |
FR-P2 |
Selection of records by conditions on any configuration key or result (comparisons, lists, patterns) |
M |
2c |
FR-P3 |
Normalized Ashby charts (relative property against relative density, logarithmic axes, scaling laws of cellular solids), one family per value of a key, accessible to colour-blind readers, light and dark themes; from Python, the command line and the graphical interface |
M |
2c |
5.13 Laser-architectured sheets (§3.7)¶
ID |
Requirement |
Priority |
|---|---|---|
FR-L1 |
Thermal cycles of laser tracks on a sheet: moving Gaussian or top-hat beams on one face or on both faces, finite thickness, surface losses; closed forms checked; transient finite volumes of a blank |
M |
FR-L2 |
Metallurgical response: transformation hardening and tempering of C–Mn steels, phenomenological hardening of ferritic stainless steels, melt-pool carburizing, nitriding and alloying |
M |
FR-L3 |
Mechanical properties of each treated point (flow laws fitted to tensile properties, strength against hardness) and presets of the steels of the PIMM studies |
M |
FR-L4 |
Laser paths: parametric patterns (straight, corrugated, Fourier, crossed, honeycomb) and polylines, their process measures and G-code |
M |
FR-L5 |
Tensile test of the architectured specimen by finite elements (plane-stress membrane with large rotations, layers through the thickness), Considère’s necking |
M |
FR-L6 |
Optimization of the laser path for an objective under constraints (grid, Nelder–Mead, differential evolution, genetic, Bayesian), configuration files and the command |
M |
FR-L7 |
Fracture of brittle points (critical plastic strain, local or averaged over a radius) in the tensile test, the failure strain among the measures; the phases and samples of Wang et al. (2023) reproduced |
M |
FR-L8 |
Cellular design of the treated sheet: phases on a grid of cells, their sensitivities by replays of the recorded deformation history, cellular automata (BESO, neighbour exchanges, HCA) and density-based topology optimization under a treatment budget, symmetries, periods and a minimum width |
M |
FR-L9 |
Designs of cells turned into laser tracks and treated by the process model |
S |
FR-L10 |
Structures of a treated sheet beyond the tensile test: a compact tension specimen (the initiation of a crack, its blunting or shielding by the tracks) and an L-shaped plate (the limit load), with cellular designs over any region |
M |
FR-L11 |
The plastic anisotropy of a treated sheet: Lankford’s coefficients and Hill’s 1948 criterion from tests at 0°, 45° and 90°, isotropy objectives |
M |
FR-L12 |
Alternative materials: boron steel hardened, age-hardened aluminium alloys softened by the laser |
S |
FR-L13 |
The compensation of the rolling texture of a sheet by the treatment: Hill’s 1948 criterion of the textured sheet, the anisotropy of the sheet treated all over on its periodic cell |
M |
FR-L14 |
Yld2000-2d for a rolled sheet whose yield stresses and Lankford coefficients both vary; the growth of a crack (CT) through the treated sheet, guided or bridged by the tracks; the anisotropy set by an architecture |
M |
6. Non-functional requirements¶
NFR-1 Portability. Windows 10/11 x86-64, macOS ≥ 12 on Apple Silicon, Linux x86-64 (and aarch64), with Python 3.12–3.14. Installation with pip, uv or conda from binary wheels only, without compilers. Intel Macs are not supported by current Numba releases.
NFR-2 Performance (targets, laptop with 4–8 cores). 256³ voxels take seconds to a few tens of seconds for every phase-1 model at typical densities. 512³ voxels (134 M; 0.13 GB per uint8 field) fit in 16 GB of RAM. Measured figures are in the README.
NFR-3 Memory. uint8 phases, int32 labels, float32 fields; no per-voxel coordinate arrays; large tessellations processed in slabs.
NFR-4 Correctness. Each model is validated against its theory, with statistical tests whose tolerances come from that theory. Each export is validated by a round trip, and by an independent reader (VTK, Gmsh) when one is installed.
NFR-5 Reproducibility. The same inputs and seed give the same output on a given platform and dependency set. Results files record the configuration, seeds and versions.
NFR-6 Licences. morphoGen is distributed under the GNU GPL, version 3 or later. No commercial dependency. Required dependencies use permissive licences (BSD, MIT), compatible with the GPL. Copyleft tools (gmsh, MMG, Neper) remain optional external programs; their licences are compatible with GPL-3.0-or-later. MMG is installed from the
pymmgwheel and run as a separate program.NFR-7 Quality. Tests (pytest) run in continuous integration on the three systems for every pull request (locally with
tools/ci_local.shwhen GitHub Actions is not available, D18), in parallel (pytest-xdist), the slowest under one Python version only; linting and formatting use ruff. Changes reachmainthrough pull requests.NFR-8 Documentation. English throughout: README (installation, usage, examples), this specification, architecture and theory notes, docstrings, change log, and a documentation site built from them (Sphinx: the pages of
docs/, the README in parts and the API reference from the docstrings), without warnings. The tutorials, the recipes, the landing page and the guide to the physics are written in snippets that the tests run; the figures of the pages are written by scripts, not by hand (§3.8).NFR-10 Stability. From version 1.0, semantic versioning of the public interface (
docs/stability.md): the names of the__all__of the packages and of the modules of the API reference, the commands, the configuration keys and the files written; an incompatible change warns for a minor version before a major one. A test keeps the list of the public names and parameters (tests/public_api.txt).NFR-9 Usability. Explicit error messages, sensible defaults, an example configuration for each model, and ASCII-only console output (Windows consoles).
7. Technical choices¶
7.1 Language: Python with compiled kernels (Numba)¶
Python is slow only for loops executed by the interpreter. NumPy and SciPy run compiled C/C++/Fortran code, and the remaining loops are compiled to multithreaded machine code by Numba (LLVM), at speeds comparable to C. The heart of the code stays in a language that the group reads and extends.
A Rust, C++ or Fortran core would require either building and distributing binaries for each system, or a compiler on every machine. It would also put the core out of reach of most group members. This cost is not justified at this stage.
The kernels live in morphogen.kernels with array-in, array-out signatures, so a later
port (Rust through PyO3, or GPU) would not change the rest of the code.
7.2 Dependencies¶
Package |
Use |
Licence |
Status |
|---|---|---|---|
NumPy |
arrays |
BSD-3 |
required |
SciPy |
k-d trees, FFT, image labelling, special functions, quadrature |
BSD-3 |
required |
Numba (llvmlite) |
compiled kernels |
BSD-2 |
required |
PyYAML |
configuration files |
MIT |
required |
scikit-image |
marching cubes (surfaces) |
BSD-3 |
optional |
tifffile |
TIFF stacks |
BSD-3 |
optional |
meshio |
other mesh formats |
MIT |
optional |
matplotlib (with Pillow) |
plots of RVE studies, figures and animations ( |
PSF-based, HPND (BSD-compatible) |
optional |
pymmg |
the |
LGPL-3.0-or-later |
optional |
CuPy |
GPU backend of the FFT solvers (FR-B3) |
MIT |
optional |
CUDA runtime, NVRTC and cuFFT (NVIDIA |
libraries loaded by CuPy |
NVIDIA licence (proprietary, free of charge; D3) |
optional |
dolfinx, dolfinx_mpc (FEniCSx), petsc4py |
the FEniCSx solver of finite element problems (FR-H23) |
LGPL-3.0-or-later (dolfinx), MIT (dolfinx_mpc), BSD-2 (PETSc) |
optional, from conda-forge, Linux and WSL (D21) |
MGIS (MFrontGenericInterfaceSupport) |
MFront behaviours in the nonlinear solvers (FR-H21) |
LGPL-3.0-or-later and CeCILL-C |
optional, from conda-forge (not on PyPI; D20) |
pytest, ruff |
tests, linting |
MIT |
development |
scikit-fem |
independent finite element reference in the tests |
BSD-3 |
development |
The finite element and FFT solvers, the algebraic multigrid preconditioner, the topology optimization (including the method of moving asymptotes) and the graphical interface (a local web server of the standard library, PNG images written without dependencies) are part of morphoGen (NumPy, SciPy, Numba). pyamg was evaluated: it has no wheels for Python 3.14, and the internal multigrid is as fast on these problems.
External programs, never imported or linked: gmsh (GPL-2.0-or-later), MMG (LGPL-3.0-or-later, run as a program), Neper (GPL-3.0), ParaView (BSD-3), FEniCSx (LGPL-3.0), CalculiX (GPL-2.0), FFT solvers (AMITEX_FFTP, DAMASK, in-house codes), MFront (TFEL, GPL or CeCILL-A: run to compile behaviours, whose libraries MGIS loads).
7.3 Building on existing tools¶
Tool |
Assessment |
Decision |
|---|---|---|
VTK / vtkSim |
VTK is excellent for visualization and file formats, and vtkSim proved the “vector framework then discretization” approach. Building on VTK would make the core heavy, though, and its implicit-function machinery is slow for 10⁵ primitives. |
Same approach, own kernels; VTK file formats written natively (no dependency); VTK/ParaView for visualization. |
PuMA (NASA) |
Strong on property solvers for porous media. Its generators are voxel-based and not built on stochastic-geometry models with known theory. Licence NOSA 1.3; installation through conda. |
Do not build on it; interoperability through TIFF/NumPy volumes. |
PoreSpy |
MIT; voxel generators and metrics for porous media. |
Possible complementary analysis of morphoGen images. |
gmsh |
Conforming meshing; OpenCASCADE booleans struggle with dense random fibre networks, and the classification of discrete surfaces took minutes for fibre networks in phase-2 trials; GPL. |
|
MMG |
Level-set discretization and remeshing in one program, adaptive to the curvature of the interface, robust on dense fibre networks, wheels for the three systems (pymmg); LGPL. |
Conforming meshes (phase 2). |
Z-set |
The FE code of the earlier workflow; not free software. |
Not used; morphoGen solves the same problems (§3.1) and exports meshes in open formats. |
Neper |
Reference for polycrystal generation and meshing (GPL). |
Interoperability through germs and weights (phase 2). |
7.4 GPU (phase 3b)¶
Decided (D3): CuPy, for NVIDIA GPUs. With device: gpu (or auto), the FFT solvers of
voxel images, linear and along loading paths, run their conjugate gradients on the GPU in
double precision: the stiffness and tangent operators of the voxels are CUDA kernels
applied without assembly, and the Fourier preconditioner uses cuFFT. Along loading paths
the integration points stay on the GPU: their measures, the integration of their
behaviours (CUDA ports of the Numba kernels), the conjugate stresses of B-bar and F-bar
and the nodal forces. Measured on a laptop (Intel i9-13900H; NVIDIA RTX 3000
Ada, 8 GB): linear solves 5 to 7 times faster from 64³ to 192³ voxels, 3.5 times at
256³; crystal plasticity paths 1.6 to 2.8 times faster from 24³ to 48³ voxels (1.4 to 1.9
before the faster crystal kernel of 2026-10-29), the integration of the crystals being
bound by the double precision of this GPU (1/64 of its single precision; theory notes,
§35); porous paths 2.4 to 3.5 times faster from 32³ to 64³ voxels. Finite elements, Macs and machines without an
NVIDIA GPU keep the CPU kernels.
7.5 Conventions¶
Coordinates are in a unit chosen by the user (stored as metadata).
Arrays are indexed
[i, j, k]along (x, y, z), and voxel (i, j, k) is centred atorigin + (i + ½, j + ½, k + ½) h.Files are written with x varying fastest.
Phase 0 is the matrix (pores, void) and phase 1 the inclusions, fibres or solid.
Tessellation labels are the 0-based germ indices.
Details are in architecture.md.
8. Architecture (summary)¶
Model (parameters, theory) --generate(domain, seed)--> Microstructure (vector geometry)
| | voxelize / level_set / contains
v v
config files, CLI, GUI (web) VoxelImage --> analysis (measures)
--> homogenization: FFT (periodic)
--> mesh (voxel hexahedra, STL)
--> io (VTK, MHD, NPZ, TIFF...)
level set --> conforming mesh (MMG) --> TetMesh
tessellation --> exact cells --> polycrystal mesh (MMG) --> TetMesh
--> homogenization: finite elements
--> io.solvers (equations, DAMASK,
Neper, FEniCSx)
pipeline: batches and RVE studies (ensemble / windows) --> rve (statistics, fits, sizes)
parallel: realizations in processes, tasks, MPI; job scripts for the schedulers
automata (rules, growth) --> lattice models --> LatticeField (a Microstructure)
design (tiles, frameworks, search) --> tile_assembly, random_lattice models
optimization (graded cells, FFT) --> CellDesign --> LatticeField
viz (figures, PNG), gui (local web server)
Packages: models, kernels, analysis, rve, mesh, homogenization, io,
config, pipeline, cli, in phase 3a automata, design, optimization, viz,
gui, and in phase 2b parallel. See architecture.md.
9. Validation and tests (summary)¶
Unit tests compare the kernels with brute-force references.
Statistical tests compare each model with its closed-form results. Seeds are fixed and tolerances are a few standard deviations derived from the theory: volume fraction, covariance, specific surface, integral range, Voronoi cell statistics, Rice formula for Gaussian fields, closed-form lattice densities, TPMS symmetries.
Published values are reproduced: RVE sizes of Dirrenberger et al. (2014, Table 10) and Yang et al. (2019, Tables 4–5).
Every file format is round-tripped, and checked with VTK and Gmsh when they are installed.
Homogenization: exact homogeneous media and laminates (both solvers, every boundary condition, 4- and 10-node elements), agreement with scikit-fem, the ordering SUBC ≤ PBC ≤ KUBC and MBC between SUBC and KUBC, bounds, iterative against direct solvers, Hill’s lemma; conforming meshes with matching periodic faces.
Automata and growth: brute-force neighbour sums, the glider and blinker of Life, conservation of the volume fraction, the Avrami law and Johnson–Mehl grain densities, exact growth distances, fractal dimensions of DLA (1.71 in 2D, 2.5 in 3D).
Design: brute force, transfer matrices and the gauge formula of polarized blocks agree; uniform sampling (chi-square); rigidity of cubic, bcc and octet lattices and Maxwell’s transition under dilution.
Optimization: exact laminates, finite-difference sensitivities, MMA against SLSQP, designs within the Hashin–Shtrikman bounds and close to them, without hinges and confirmed on finer grids, auxetic cells.
Polycrystals (2b): exact cells against Voronoi volumes and lattices; regularized complexes stay closed and valid; meshes reproduce the cells (without regularization, to 10⁻⁶), keep every grain and match on periodic faces; the face meshing succeeds on hundreds of tessellations; the bulk modulus of cubic polycrystals, (C11 + 2 C12) / 3, is exact for every boundary condition, on meshes and voxels; crystal tensors are checked against rotations and the Hashin–Shtrikman bounds.
Parallel runs (2b): the same results whether serial, in processes, split into tasks and merged, or under MPI; job scripts parse in a shell.
Exports (2b): periodic equations satisfied by every affine displacement; the quaternions of DAMASK against its own conversion; Neper weights; XDMF round trips and chunked volumes equal to direct voxelizations.
Measures (2b): chords of Boolean models against theory, Euler characteristics of known shapes, granulometries of slabs and balls, tortuosity of straight and diagonal paths.
Nonlinear behaviours (2c): closed forms of the material point (hardening, creep); consistent tangents against finite differences; homogeneous elements equal to their material point and exact laminates; Schmid’s law of single crystals along [001] and [111]; the polycrystal flow stress between the Sachs and Taylor estimates; in finite strains, Hencky’s closed forms in tension and simple shear, objectivity, the small strain curve recovered in the logarithmic strain space, a uniaxial Cauchy stress in tension.
Models (2b): set operations against their components and theory; grain-boundary distances against brute force; the renewal variance of laminates; the covariance of dead leaves; Kelvin cells (24 struts and 12 four-fold nodes per cell).
Phase 2c: whole periodic grains fill the box and link node to node (sweep of 210 tessellations); mixed loadings against direct solutions and compliances; thermal expansion against Levin’s exact relation (10⁻⁹) and its bounds; engineering constants and anisotropy indices of known tensors; database filters and Ashby charts (light and dark, palette validated for colour-blind readers); Cox spheres against the intensity and fraction of the process; coatings and shells exact for unions of spheres; frames of regular octahedra; fractal sponges against (N/k³)^level and box counting; nacre and honeycomb fractions exact; rays of wood exact (their cells and share of the volume) and stiffening the radial direction more than the tangential one (FFT); Bouligand fibre families periodic and fractions exact; osteon phases against the dead-leaves fractions; foam edges against Meijering’s constants; Murray’s law at every branching; the out-of-plane modulus of prismatic walls, E₃ = φ E_s, by FFT. Nonlinear paths: the material point against the closed forms of uniaxial tension, creep and hardening, the consistent tangent against finite differences, a homogeneous volume element against its material point and a periodic laminate against its exact layer solution along cyclic, mixed and thermal paths; linear behaviours against the condensation. On voxels (FFT): the tangent of B-bar and F-bar against finite differences and its symmetry, homogeneous images against the material point, the linear FFT solution with full integration, an exact laminate, the convergence of a plastic composite under refinement with B-bar and F-bar (and the locking of full integration) towards the quadratic tetrahedra of the same geometry.
RVE statistics of loading paths: the quantities of the paths equal to their curves at the ends of the steps, analysed as the apparent properties in the reports of the runs and by
morphogen fit.GPU backend (3b): the linear FFT solutions of the GPU equal those of the CPU (10⁻¹⁰) with the same iterations; the tangent operators of the voxels (B-bar, F-bar, full integration; small and finite strains) and their coupling columns agree to round-off; crystal plasticity paths give the same curves; the behaviours of the points equal those of the Numba kernels (every behaviour, small and finite strains, substeps), and the paths of a viscoplastic composite their curves, phase averages and fields; the choice of the device and its errors in the API, the configurations and the command line. These tests are skipped where no GPU is usable.
Models (3b): hard-core fibres never closer than their gap (brute force over the periodic images; the closest points of segments against a fine sampling) and their fraction; curved fibres: the tangent correlations and the mean square end-to-end distance of the discrete worm-like chain, the fraction of the Boolean model; rotated lattices along their turned axes and graded lattices with interpolated radii, their mean and local fractions against the theory.
AMITEX workflows (3b): the formats of the inputs (ten-line VTK headers and big-endian integers, read back by VTK; binary zone files; the native laws and the order of their constants), the stiffness of every crystal voxel rebuilt from the exported axes of its zone against morphoGen’s, the loadings and paths; the results (cell, materials, zones; small and finite strains; numbers written by Fortran without the letter of their exponent) in morphoGen’s orders, the apparent stiffness of the unit strains. AMITEX itself does not run in the tests (it is not installed on the development machine).
MFront behaviours (3b): the conventions of MGIS (TFEL’s order 12, 13, 23 of the shear components, with their factors √2, against morphoGen’s usual 23, 31, 12, checked on an orthotropic law whose three shear moduli differ; the energy; the order of the components in finite strains; tangents and rotations against morphoGen’s matrices); MFront twins of morphoGen’s behaviours (von Mises elasto-viscoplasticity in small strains and in the logarithmic strain space, Méric–Cailletaud crystal plasticity, isotropic elasticity with material properties) against morphoGen’s kernels at a material point, by finite elements (periodic and kinematic conditions) and on voxels (B-bar, F-bar; a polycrystal), in small and finite strains, on the CPU and the GPU: the same curves to 10⁻⁹ (10⁻¹⁰ to 10⁻¹⁶ measured) with the same Newton iterations; the errors (kinematics, material properties, parameters, sources that do not compile) and the command line. These tests are skipped without MGIS and MFront; they run in WSL on the development machine.
MFront exports (3b): the sources (the brick of von Mises plasticity, the slip systems of crystals in TFEL’s components, the orthotropic constants in MFront’s order), their internal variables and errors; compiled by MFront, the exported behaviours against morphoGen’s kernels through MGIS (von Mises viscous, rate-independent and perfect, in small and finite strains; crystals with Franciosi’s interactions, two families of their own parameters, bcc systems with isotropic elasticity, turned), to 10⁻⁸ (10⁻¹⁰ to 10⁻¹³ measured); AMITEX exports of nonlinear materials: the coefficients and internal variables of the material file against MFront’s example of Cast3M, and the laws called as AMITEX calls the umat interface against morphoGen’s kernels, along a path of the six components and for each zone of a polycrystal.
Abaqus inputs (3b): the 21 anisotropic constants in Abaqus’s order (11, 22, 33, 12, 13, 23); CalculiX under a homogeneous strain gives morphoGen’s stresses in an isotropic grain and in a turned grain of 21 distinct constants; the MFront laws of an input, compiled with the abaqus interface, called as Abaqus calls them in the axes of the orientations of the sections, give morphoGen’s curves. These tests are skipped without CalculiX and MFront; they run in WSL on the development machine.
Open points (3b): the voxel meshes in Abaqus inputs (CalculiX, 8 integration points, a turned grain of 21 distinct constants); crystals in finite strains as MFront sources (morphoGen’s kernel in them) against the kernel at a material point, with the same Newton iterations; the user’s MFront laws in AMITEX and Abaqus inputs, their coefficients and internal variables against MFront’s examples (glossary names merged by umat), called as the codes call them against morphoGen’s integration through MGIS, their parameters read from the directory of the runs.
Finite strains in the exports (3b): AMITEX exports (Small_Perturbations false, the nine components of the paths, every phase an MFront law, the functions of the strain measures of the umat interface) and Abaqus inputs (no orientation in the sections, the axes of the orthotropic laws in their first six state variables from *INITIAL CONDITIONS) of finite strains; their laws, compiled, called as AMITEX and Abaqus call them in finite strains (the deformation gradients, the Cauchy stress) against morphoGen’s finite strains along a path whose principal axes turn, to 10⁻⁸ (10⁻¹⁵ to 3·10⁻¹¹ measured: Hencky’s elasticity, isotropic and cubic, von Mises with kinematic hardening, crystals); the user’s laws of finite strains (Hencky’s strain measure, the deformation gradient, an orthotropic law with three distinct shear moduli) against their integration through MGIS.
Dead leaves and Torquato’s approaches (3b): the proportions of the families of leaves, the probability of the same leaf (isotropic and aligned spheroids, along each axis), the background of a finite coverage and its centred covariance against the bivariate laws, their limits; packings grown beyond the RSA limit without overlap (all the pairs), jamming near 0.64; the two limits of the cherry-pit model and its bounds; the reconstruction of a Debye medium and of a Boolean model (its lineal path with and without its weight), from an image; the lineal path and the pore sizes of the Boolean model against their closed forms, the two-point cluster function, the radial distribution function and the structure factor of Poisson points, hard spheres and a lattice; the field of transparent dead leaves (mean, variance, covariance, the fraction of its excursion over realizations, opaque leaves as the dead leaves); stealthy hyperuniform germs (S(k) zero on the constrained wave vectors) and the regularity of their Voronoi cells.
End-to-end tests cover the command line, split cluster runs and the interface server.
Continuous integration runs on Linux, Windows and macOS (Apple Silicon) with Python 3.12 and 3.14.
10. Roadmap¶
Phase |
Version |
Content |
Acceptance |
|---|---|---|---|
1 |
0.1 |
Nine models (FR-G1–G8, G10–G11); vector, implicit and voxel representations; measurements; RVE statistics (ensemble and window methods, external tables); exports FR-E1–E4; CLI and configuration files; cluster task splitting; test suite and CI |
this specification validated; |
2a |
0.2 |
Homogenization (FR-H1–H9): finite elements on conforming meshes, FFT solver on voxels; conforming tetrahedral meshes (FR-E5); statistical analysis after Dirrenberger et al. 2014 (FR-M4, FR-V6 bootstrap) |
the boundary conditions and outputs of the earlier FE workflow (§3.1) reproduced with free tools; validation cases of FR-H6 |
3a |
0.3 |
Requirements of §3.2: cellular automata and lattice growth (FR-A1–A8), combinatorial design (FR-D1–D5), topology optimization (FR-O1–O6), visualization and graphical interface (FR-I4, FR-I6) |
validations of §9; the interface covers every model |
2b |
0.4 |
Requirements of §3.3: conforming meshes and finite elements of polycrystals (FR-H10, FR-H11); parallel and cluster runs (FR-B5); XDMF, FEniCSx, Neper and DAMASK exports, periodic constraint equations (FR-E6); extra measures (FR-M3); model combinations (FR-G12); extra models (FR-G9); chunked large volumes (FR-R4) |
validations of §9; the bulk modulus of cubic polycrystals exact on meshes and voxels; results independent of the parallel splitting |
2c |
0.5 |
Requirements of §3.4: whole periodic grains (FR-H12), periodic element and mixed loadings (FR-H13), thermo-elasticity (FR-H14), post-processing (FR-H15), nonlinear behaviours along loading paths (FR-H16, FR-H17), crystal plasticity (FR-H18) and finite strains (FR-H19), the nonlinear FFT solver of voxel images (FR-H20) and RVE statistics of loading paths (FR-V7), database and Ashby charts (FR-P1–P3), nested and bio-inspired models (FR-G13, FR-G14) |
validations of §9: Levin’s relation, Meijering’s constants, dead-leaves fractions, E₃ = φ E_s of prismatic cells, closed forms of the material point, exact laminates, Schmid’s law, Hencky’s closed forms; voxels without locking (B-bar, F-bar) against quadratic tetrahedra; templates run end to end |
3b |
0.6 |
GPU backend (FR-B3); remaining models of FR-G9; AMITEX workflows; MFront behaviours (FR-H21) and sources (FR-E7); 3D interactive views in the interface |
GPU speed-up measured (§7.4); MFront twins of morphoGen’s behaviours |
4 |
1.0 |
Stable API; documentation site; PyPI/conda-forge release; software paper (e.g. JOSS); DOI (prepared on 2026-10-28, §3.6: the steps left are the author’s, |
public release |
11. Decisions¶
D1 — Licence. Decided on 2026-10-21: GNU General Public License, version 3 or (at your option) any later version (SPDX
GPL-3.0-or-later; full text inLICENSE). CC-BY-NC had first been considered, which Creative Commons recommends against for software and which is not open source. The copyleft keeps morphoGen and its derivatives open source, and every dependency and external tool of §7.2 is compatible with it (the CUDA libraries of the optional GPU backend: see D3). Confirmed on 2026-11-17: the author holds the rights, and the institution confirmed it (in France the economic rights to software written by employees in the course of their duties belong to the employer — Code de la propriété intellectuelle, art. L113-9, extended to people with research missions —, which is why the question had been left open). The copyright holder of the licence notices is the author. Points that remain:Documentation and data may use CC-BY 4.0.
Until the public release (phase 4) the package keeps the
Private :: Do Not Uploadclassifier, which makes PyPI refuse any accidental upload.
D2 — GUI technology. Decided in phase 3a: a web interface served locally by the Python standard library (
morphogen gui), with PNG images written without dependencies: nothing to install beyond morphoGen, the same on the three systems, usable from a cluster front end through an SSH tunnel. Figures and animations use matplotlib (morphogen view). Interactive 3D views (trame, PyVista) or a napari plugin remain possible later (phase 3b).D3 — GPU backend. Decided in phase 3b (§3.5): CuPy, for NVIDIA GPUs. The solvers need double precision, which the Metal backend of PyTorch (MPS) does not offer, so that PyTorch would not bring the GPUs of Apple Silicon either. CuPy follows the NumPy and SciPy API (FFTs, element-wise and reduction kernels, CUDA C kernels compiled at run time): the Numba kernels are ported one by one, and the CPU code stays the reference. It needs only the CUDA runtime, NVRTC and cuFFT (about 270 MB of wheels, no CUDA toolkit or compiler), where PyTorch brings a deep-learning framework of several gigabytes. The backend is optional (
[gpu]) and chosen per problem (device: cpu | gpu | auto); the CPU kernels remain the default, and the only backend of finite elements, of Macs and of machines without an NVIDIA GPU. The CUDA libraries are proprietary (NVIDIA’s licence, free of charge): morphoGen neither ships nor requires them, the user installs them with the extra. Whether this optional use agrees with the GPL is to be confirmed before the public release. The behaviours of the loading paths are ported to CUDA C (behaviours.cu), line by line from the Numba kernels, which stay the reference, and tests compare the two point by point: numba-cuda, which would compile the Numba kernels themselves for the GPU, was tried, but its release 0.30.4 does not run with NumPy 2.5 (it usesnumpy.row_stack, which NumPy removed).D4 — FFT solver. Decided in phase 2: an FFT solver in morphoGen, for voxel images under periodic conditions (elasticity and conduction). It uses the trilinear finite element discretization of the voxels with a Fourier preconditioner (Schneider, Merkert & Kabel 2017): no ringing artefacts, and pores without an ersatz material. External FFT codes remain usable through the voxel exports.
D5 — Conforming meshes. Decided in phase 2: MMG (
mmg3d -ls, installed by thepymmgwheel), after trials of gmsh. Opposite faces match for periodic media.D6 — Statistical post-analysis code. Answered in phase 2: there is no existing code; the analysis is written from Dirrenberger et al. (2014) (FR-M4).
D7 — Validation files. Received in phase 2: Z-set input files (KUBC, MBC and periodic conditions; bulk and shear loadings; averages, volume and second moments). As free codes are preferred (§3.1), morphoGen solves these problems itself (FR-H1–H3) rather than writing Z-set files.
D8 — Finite elements of tessellations. Decided in phase 2b (§3.3): conforming meshes of polycrystals. morphoGen computes the exact cells of Voronoi and Laguerre tessellations (power diagrams clipped to the box, or on the torus), removes the features smaller than a chosen length (short edges, thin caps on the faces of the box), splits the cells into tetrahedra and lets MMG remesh them as subdomains (
mmg3d, the grain boundaries kept); periodic faces are triangulated in the plane and remeshed bymmg2d, the same triangles on opposite faces. Neper is not needed (its files are written for those who use it). The crystals are anisotropic (FR-H11).D9 — Topology optimization. Periodic cells are optimized on voxels with the FFT solver (inverse homogenization, SIMP); the designs can then be meshed conformingly and checked by finite elements. Structural optimization of whole parts (compliance under loads and supports) is out of scope; to be confirmed.
D10 — Building blocks of combinatorial metamaterials. The polarized blocks model the compatibility rules of Coulais et al. (2016) with a generic block geometry (a block pierced along its axis). Users may provide the geometry (or the deformation modes) of the blocks of interest; any block set with labelled faces can be used.
D11 — Parallel and cluster runs. Decided in phase 2b: each realization writes its own record, so that runs can be split into any number of tasks, resumed and merged; processes rather than threads run the realizations of one machine (the kernels are multithreaded inside, within a thread budget); job scripts are written for the usual schedulers rather than depending on a workflow manager; MPI (mpi4py) is optional.
D12 — Large volumes. Decided in phase 2b: raw binary files with XDMF (ParaView, VisIt) or MetaImage headers rather than HDF5 or Zarr, which would add a compiled dependency; slabs are written through memory maps.
D13 — Periodic element. Decided in phase 2c: the macroscopic strain and stress components are the unknowns of mixed loadings, as in the periodic element of Z-set, but solved by condensation (§25 of the theory notes): the linear systems keep their form and solvers, the unit solutions are reused by every loading, and the results are those of the extra degrees of freedom. For nonlinear behaviours see D16.
D16 — Nonlinear periodic element. Decided (§3.4): for nonlinear behaviours the macroscopic strain components are degrees of freedom of the Newton iterations, with their residuals
int sigma dV - V Sigma; each linearized system is condensed on them (a Schur complement of at most six unknowns, §31 of the theory notes). Linear problems keep the condensation of D13, which gives the same solutions. The behaviours are von Mises elasto-(visco)plasticity and crystal plasticity (FR-H18), in small or finite strains (D17); the FFT solver of voxel images solves the same iterations (FR-H20, D19).D17 — Finite strains. Decided (§3.4): a total Lagrangian formulation (first Piola–Kirchhoff stress, its tangent); elasticity and von Mises plasticity in the logarithmic strain space (Miehe, Apel & Lambrecht 2002), which reuses the small strain integration and reduces to it for small strains; crystal plasticity multiplicative, with the slip systems fixed in the intermediate configuration. The macroscopic gradient is upper triangular (the rotation removed by its QR decomposition): its six components keep the Voigt order and the meaning of the small strains (shears are simple shears), its conjugates are nominal stresses, and a tension with free faces is a uniaxial Cauchy stress whatever the anisotropy (§33 of the theory notes).
D18 — Continuous integration without GitHub Actions. Decided (§3.4): while the Actions minutes of the account are exhausted,
tools/ci_local.shruns the jobs of the workflow for the system of the development machine (lint and format, the wheel installed in fresh environments for Python 3.12 and 3.14, the tests against it, the command-line smoke test) before each push: the Windows job on the development machine (Git Bash), the Linux or macOS jobs elsewhere. uv is optional (venv and pip otherwise). On the development machine the environments also get VTK and Gmsh (CI_LOCAL_PACKAGES), whose checks of the exported files the GitHub workflow skips. The jobs of the other systems run again when Actions is available. Since 2026-10-28 (§3.6) the Python versions run at once, each on its share of the cores, their tests in parallel (pytest-xdist, one file per process, the longest files first), and the documentation site is built with its warnings as errors; an environment is kept whilepyproject.tomland the extra packages do not change, for a week at most, and only the wheel is then reinstalled, the disk caches of Numba of the package cleared (they are keyed on the contents of each source file: a kernel whose file did not change kept the compiled code of the kernels it calls in other files). On the development laptop the tests of one Python take about 10 minutes on 10 processes instead of about 50 in one, and the whole CI 20 minutes instead of 70 to 110. Since 2026-10-29 the slowest tests (markerslow, two thirds of the time) run under the last Python version only (CI_LOCAL_SLOW), which gets three times the cores of each other version; the GitHub workflow runs them in its job Ubuntu with Python 3.14, the fast tier elsewhere. Since the repository is public (2026-11-18), the GitHub workflow runs again at each push, beside the local CI.D19 — Nonlinear FFT solver. Decided (§3.4): the iterations of D16 on the voxels of the linear FFT solver (D4): Newton–Krylov, each correction solved by conjugate gradients with the Fourier preconditioner of a homogeneous elastic reference medium, the tangent applied matrix-free from the consistent tangents of the Gauss points (nothing assembled), rather than the fixed-point scheme of Moulinec and Suquet, whose iterations grow with the contrast of the tangents. Fully integrated trilinear voxels lock under isochoric plastic flow (the flow stress of elastic cubes in a plastic matrix twice too high on 10³ voxels): the volumetric part of the measures is averaged over each voxel by default (B-bar in small strains, F-bar in finite strains), in variational form so that the tangent stays symmetric for the conjugate gradients;
integration: fullkeeps the discretization of the linear solver.D21 — FEniCSx. Decided (§3.5): FEniCSx solves morphoGen’s own finite element problems (subclasses that replace the solution of the fields) rather than a separate set of problems: the constraints and every post-processing stay those of morphoGen, which makes the two solvers interchangeable and checks FEniCSx against the reference of the project. dolfinx and dolfinx_mpc are optional dependencies from conda-forge, on Linux or WSL only (no Windows builds); their forms are compiled at run time (a C compiler in the environment).
D20 — MFront behaviours. Decided (§3.5): through MGIS and the
genericinterface of MFront, the library that TFEL provides for solvers, rather than a port of the generated C++: MGIS integrates the points of a material in batches, with its own threads, from states that morphoGen keeps in its own arrays, so that the solvers, their Newton iterations and their divided steps are unchanged; on the GPU the MFront points are integrated on the CPU. MGIS and MFront are optional dependencies from conda-forge (they are not on PyPI): without them a material with anmfrontkey raises an error that gives the command, and their tests are skipped. A material keeps its elastic constants (the linear problems, the reference medium of the FFT solver). The validation compares MFront twins of morphoGen’s behaviours with its own kernels. The exports of morphoGen’s laws (FR-E7) are MFront sources with the values of the material as constants, the slip systems written out by morphoGen rather than taken from MFront’s crystallography, so that the same source serves every interface; for AMITEX, the umat interface, whose coefficients carry the axes of each grain. Crystal plasticity in finite strains is exported with morphoGen’s own kernel in the source (the C port of the GPU, compiled for the host) rather than MFront’s brick of finite strain single crystals, whose update of the elastic deformation differs from morphoGen’s at the second order of the slips: the source gives morphoGen’s integration and tangent. The user’s own MFront laws go to AMITEX and Abaqus inputs with their sources, compiled for the interface of each code. In finite strains, the exports take every phase but the voids as an MFront law (the native elasticities of AMITEX and Abaqus in finite strains are not Hencky’s), and the interfaces of the codes handle the strain measures of the laws: the umat interface by functions of its own (_mallsfor Hencky’s logarithmic strain,_frstfor Green-Lagrange’s), the abaqus interface with the axes of the orthotropic laws in their state variables (its only orthotropy in finite strains), which morphoGen’s sources declare for Abaqus only.D14 — Results database. Decided in phase 2c: SQLite from Python’s standard library, one file per study (or shared), records stored as JSON of flattened keys so that any configuration or result can be filtered without a fixed schema.
D15 — Nested and bio-inspired models. Model parameters may be models (a mapping with a
type), so that any model can fill or decorate another; the bio-inspired models are morphological (geometry and closed-form characteristics), their mechanics coming from the homogenization of their realizations. Other organisms or tissues can be added on request.
12. Glossary and notation¶
Symbol |
Meaning |
|---|---|
p, q = 1 − p |
volume fraction of phase 1, and of its complement |
θ |
intensity of a Poisson process (germs per unit volume; for Poisson lines in Jeulin’s notation θ = L_V / π) |
L_V |
mean fibre length per unit volume |
C(h) |
covariance: P(x ∈ A, x + h ∈ A) |
A₃, A₃* |
integral range, generalized integral range |
D_Z², D_Z²(V) |
point variance of Z, variance of its mean over V |
K, γ |
coefficient and exponent of D_Z²(V) = K V^-γ |
ε_rel, n |
relative error on the mean, number of realizations |
S_V |
specific surface area (interface area per unit volume) |
13. Change log¶
Version |
Date |
Change |
|---|---|---|
1.0 |
2026-10-21 |
First version, for validation |
1.1 |
2026-10-21 |
Validated; licence decided (D1): GPL-3.0-or-later |
1.2 |
2026-10-21 |
Phase 2: requirements (§3.1); homogenization in scope (§4, §5.8, FR-H1–H10); FR-M4, FR-V6, FR-E5 updated; dependencies (pymmg, scikit-fem); decisions D4–D7 settled, D8 added; roadmap: phase 2 split into 2a (0.2) and 2b (0.3) |
1.3 |
2026-10-21 |
Phase 3a (§3.2): cellular automata and growth (§5.9), combinatorial design (§5.10), topology optimization (§5.11), graphical interface and figures (FR-I4, FR-I6); decision D2 settled, D9 and D10 added; roadmap: 3a (0.3) before 2b (0.4) and 3b (0.5) |
1.4 |
2026-10-21 |
Phase 2b (§3.3): D8 settled (conforming meshes of polycrystals, FR-H10 raised to M), anisotropic crystals (FR-H11), parallel and cluster runs (FR-B5), FR-E6, FR-M3, FR-R4, FR-G12 and part of FR-G9 delivered; decisions D11 and D12; scope (§4) and roadmap updated |
1.5 |
2026-10-22 |
Phase 2c (§3.4): whole periodic grains (FR-H12), periodic element and mixed loadings (FR-H13), thermo-elasticity (FR-H14), post-processing (FR-H15), results database and Ashby charts (§5.12), nested and bio-inspired models (FR-G13, FR-G14); decisions D13–D15; roadmap: 2c (0.5), 3b moved to 0.6 |
1.6 |
2026-10-22 |
Rays of wood (§3.4, FR-G14); nonlinear behaviours (FR-H16) and loading paths solved with the macroscopic strains as degrees of freedom of the periodic element (FR-H17); decision D16 |
1.7 |
2026-10-22 |
Crystal plasticity of Méric and Cailletaud for polycrystals (§3.4, FR-H18), finite strains for every nonlinear behaviour (FR-H19); decisions D17 (finite strain formulation) and D18 (local continuous integration); D16 updated |
1.8 |
2026-10-22 |
The nonlinear FFT solver of voxel images (§3.4, FR-H20), decision D19; D16 updated |
1.9 |
2026-10-23 |
RVE statistics of the curves of loading paths (FR-V7), the next step of the nonlinear FFT solver (§3.4) |
1.10 |
2026-10-23 |
Phase 3b (§3.5): the GPU backend of the FFT solvers (FR-B3) and its benchmarks (§7.4); decision D3 settled (CuPy); optional dependencies CuPy and the CUDA libraries (§7.2); part of FR-G9 delivered: hard-core fibres, curved fibres, rotated and graded lattices |
1.11 |
2026-10-23 |
The behaviours of the loading paths integrated on the GPU (§3.5, FR-B3), their benchmarks (§7.4); D3 completed (the CUDA port of the behaviours, numba-cuda tried) |
1.12 |
2026-10-23 |
The AMITEX_FFTP workflows, exports and results (§3.5, FR-E6) |
1.13 |
2026-10-23 |
MFront behaviours through MGIS in every nonlinear solver (§3.5, FR-H21), decision D20; MGIS and MFront as optional dependencies (§7.2); the scope (§4) updated for the nonlinear behaviours of phases 2c and 3b |
1.14 |
2026-10-23 |
MFront sources of morphoGen’s behaviours (§3.5, FR-E7), AMITEX runs of nonlinear materials through them (FR-E6); D20 completed |
1.15 |
2026-10-23 |
The materials of Abaqus inputs, elastic and MFront laws (§3.5, FR-E6, FR-E7) |
1.16 |
2026-10-23 |
Voxel meshes in Abaqus inputs, crystal plasticity in finite strains as MFront sources, the user’s MFront laws in AMITEX and Abaqus inputs (§3.5, FR-E6, FR-E7); D20 completed |
1.17 |
2026-10-23 |
Finite strains in the AMITEX and Abaqus exports, every phase an MFront law (Hencky’s elasticity for the elastic ones), the user’s laws of finite strains (§3.5, FR-E6, FR-E7); D20 completed |
1.18 |
2026-10-24 |
Dead leaves of families, spheroids and finite coverage, dense packings by the Lubachevsky–Stillinger algorithm, the cherry-pit model (§3.5, FR-G9), the stochastic reconstruction (FR-G15), Torquato’s descriptors (FR-M3) |
1.19 |
2026-10-24 |
Transparent dead leaves, Voronoi tessellations of stealthy hyperuniform germs (§3.5, FR-G9) |
1.20 |
2026-10-24 |
The measures of mathematical morphology of the appendix of the author’s thesis (§3.5): Choquet capacities, dilations, erosions, openings and closings by balls, segments, pairs and cubes, contact distributions, the morphological covariance of grey-level images, the integral of mean curvature and the Minkowski curves of excursion sets, Betti numbers and connectivity density (FR-M3) |
1.21 |
2026-10-24 |
Curved fibres as in PuMA (§3.5): circular arcs of distributed radii of curvature, helices (crimp), and curved fibres without overlap by random sequential addition (FR-G9) |
1.22 |
2026-10-24 |
Couplings of diffusion, chemistry and mechanics (§3.5): transient diffusion, thermal oxidation by the closed-loop scheme, ageing laws and graded phases, hydrolysis of cellulose, hygromorph multilayers (FR-H22) |
1.23 |
2026-10-24 |
FEniCSx as the solver of finite element problems (§3.5, FR-H23, decision D21) |
1.24 |
2026-10-24 |
Foams as level sets of distance fields, after the paper of N. Degdeg and J. Dirrenberger (§3.5, FR-G16) |
1.25 |
2026-10-24 |
The nonuniform transformation field analysis (§3.5, FR-H24) |
1.26 |
2026-10-24 |
The NTFA in configurations and the pipeline, with the mean fields of the phases (FR-H24); hollow fibres as in PuMA (FR-G9) |
1.27 |
2026-10-24 |
Kinematic hardening in the NTFA (FR-H24); transient diffusion in configurations and the pipeline (FR-H22) |
1.28 |
2026-10-24 |
Diffusion and free swelling of tetrahedral meshes with FEniCSx, bending of strips (FR-H22, FR-H23) |
1.29 |
2026-10-24 |
The stresses of oxidized samples with FEniCSx, the method of Ernault et al. (2019) (FR-H22) |
1.30 |
2026-10-24 |
Orthotropic hygromorph layers, layers from microstructures by homogenization (FR-H22); the mean intercept length and the MIL fabric tensor (FR-M3) |
1.31 |
2026-10-24 |
The first minima of the covariance (hole effect), the second anisotropy measure of Degdeg & Dirrenberger (FR-M3) |
1.32 |
2026-10-24 |
Stereology, the sections of the grid planes and the recovery of size distributions of spheres and oriented ellipsoids (Saltykov), as Degdeg & Dirrenberger (FR-M3) |
1.33 |
2026-10-24 |
The seeds of level-set foams calibrated on the mean radii of the sections of their pores (FR-G16) |
1.34 |
2026-10-24 |
Bloch waves, the band structures and band gaps of periodic cells (FR-H25) |
1.35 |
2026-10-24 |
Post-bifurcated patterns by group theory in the manner of R. Azulay, and periodic frames of beams (FR-H26) |
1.36 |
2026-10-24 |
The post-bifurcation analysis extended to continuum meshes: tetrahedral meshes and voxel images, the initial-stress matrix of the periodic prestress, the symmetries detected on the mesh (FR-H26) |
1.37 |
2026-10-25 |
Raw data and figure exports, TikZ, videos, one export entry point (FR-E8, FR-I7) |
1.38 |
2026-10-25 |
Every module connected in one workflow (model, image, mesh, fields, exports, figures and videos; FR-I8), |
1.39 |
2026-10-25 |
Post-bifurcation of frames of struts in space, Schoenflies symbols (FR-H26) |
1.40 |
2026-10-25 |
Z-mat material files (the behaviour bricks of Z-set reused), their translation and the coverage of Z-mat (FR-H27) |
1.41 |
2026-10-25 |
Cohesive zone elements in 3D, in small and finite strains (FR-H28) |
1.42 |
2026-10-25 |
Crack propagation on remeshed conforming meshes and by XFEM in 3D (FR-H29) |
1.43 |
2026-10-25 |
Mixed-mode cracks (I, II, III) in 3D, in finite strains (FR-H30) |
1.44 |
2026-10-25 |
The post-bifurcation along nonlinear loading paths in finite strains with nonlinear behaviours, the switch of branch (FR-H26) |
1.45 |
2026-10-25 |
Porous elasto-(visco)plasticity, GTN, Rousselier, Abouaf’s elliptic criterion, and the porous_plastic files of Z-mat, beyond gen_evp (FR-H31) |
1.46 |
2026-10-25 |
The microfoam model of Forest’s article on micromorphic continua, and a micromorphic damage model to crack with (FR-H32) |
1.47 |
2026-10-25 |
Cracks in elasto-viscoplastic and crystalline solids in finite strains (FR-H33) |
1.48 |
2026-10-25 |
Conforming meshes from level sets rather than voxels: mirrored conforming meshes of symmetric cells, exact symmetries for the analyses by group theory, matching faces along chosen axes, implicit bodies (FR-E5, FR-H26) |
1.49 |
2026-10-25 |
Finite strains and nonlocal models to crack with: the microfoam model in finite strains, micromorphic ductile damage of von Mises elasto-(visco)plasticity in small and finite strains (FR-H32) |
1.50 |
2026-10-25 |
Remeshed crack propagation in inelastic bodies, the transfer of the state of the points between meshes, ductile growth and its resistance curve (FR-H33) |
1.51 |
2026-10-25 |
Diagonal mirrors of square and cubic cells in the mirrored conforming meshes (the groups 4/mmm and m-3m), equibiaxial compression of square arrays of holes and cubic cells in the post-bifurcation analyses (FR-E5, FR-H26) |
1.52 |
2026-10-25 |
The buckling of a cubic cell of 2 x 2 x 2: the linear post-bifurcation of cells of several primitive cells split by their translations and the little co-groups of their wave vectors, the wave vectors of the irreps (FR-H26) |
1.53 |
2026-10-25 |
Crack growth in a remeshed polycrystal of crystal plasticity, the grains carried by the crack meshes and the state transferred grain by grain (FR-H33) |
1.54 |
2026-10-25 |
The micromorphic ductile damage driven by the plastic strain weighted by the stress triaxiality (FR-H32) |
1.55 |
2026-10-25 |
The interface: its workflow through the workspace of the session, the views and measures of the level sets, voxel images up to 2048 per edge, optimizations from a morphology or a simulation, the videos of a load colouring the fields as they grow (FR-I4) |
1.56 |
2026-10-26 |
Every function in the interface: tools built from a registry, the tab Statistics, tabs without numbers (FR-I4) |
1.57 |
2026-10-26 |
The tabs Mechanics, Fracture, Nonlocal damage, Stability, Couplings, Design and Solvers & formats; FFT simulations on the GPU; the workspace saved and opened (FR-I4) |
1.58 |
2026-10-27 |
A review of the interface: its menus in four sections, the items sent on to the forms that take them; cracks through any morphology (FR-H33, FR-I4) |
1.59 |
2026-10-27 |
The forms of the interface in boxes, the runs of the tools kept in the workspace, the models by family, the items offered by their traits, the 3D view of the items of the workspace (FR-I4); the toughness of the phases and of their interfaces in crack growth (FR-H33) |
1.60 |
2026-10-27 |
The long computations of the interface stopped from the page; the behaviours of materials kept in its workspace and taken by its tools; the tab Comparisons; the identification of a behaviour (FR-H34, FR-I4) |
1.61 |
2026-10-27 |
The identification of a behaviour on several references followed together, each by its weight, of porous behaviours too, from the values of the form or of a behaviour of the workspace, in the library and the interface (FR-H34, FR-I4); the materials written as Z-mat files (FR-H27) |
1.62 |
2026-10-28 |
Phase 4 prepared (§3.6): the local CI with the tests in parallel and the Python versions at once (D18, NFR-7); the documentation site (NFR-8); the stability of the public interface and its test (NFR-10); the citation file, a draft paper for JOSS, a conda-forge recipe and the steps of a release (§10) |
1.63 |
2026-10-29 |
Two tiers of tests (§3.6): the slowest under one Python version in the CIs, the fast tier under the others (D18, NFR-7); lighter tests of the interface |
1.64 |
2026-10-29 |
Hill’s anisotropic plasticity (§3.6, FR-H16): kernels, identification (FR-H34), Z-mat files (FR-H27), interface (FR-I4) |
1.65 |
2026-10-29 |
Hill’s criterion on the GPU (FR-B3) and in the MFront sources (FR-E7); the macroscopic law of a morphology in one go (FR-H34, FR-I4) |
1.66 |
2026-10-29 |
Faster kernels of Hill’s criterion and of porous plasticity; the cost of each behaviour of the points in the README (NFR-2) |
1.67 |
2026-10-29 |
The analytical Jacobian of the porous update, porous plasticity on the GPU (§3.6, FR-B3) |
1.68 |
2026-10-29 |
The tangent of finite strains from the six directions of dC (§3.6); the Numba caches of the kept environments of the local CI cleared (D18) |
1.69 |
2026-10-29 |
A faster crystal kernel; the porous paths in the benchmark of the GPU (§3.6, NFR-2) |
1.70 |
2026-10-29 |
MINRES for the indefinite tangents of softening points (§3.6, FR-B3) |
1.71 |
2026-10-29 |
The device of the FFT tools of the tab Mechanics (FR-I4, FR-B3) |
1.72 |
2026-10-30 |
Thermal expansion in the MFront sources of small strains (FR-E7) |
1.73 |
2026-10-30 |
Thermal expansion in the MFront sources of finite strains (FR-E7) |
1.74 |
2026-10-30 |
The initial temperature of the Abaqus inputs whose materials expand (FR-E7) |
1.75 |
2026-10-30 |
Porous plasticity in the MFront sources (FR-E7) |
1.76 |
2026-10-30 |
Kinematic hardening of porous plasticity (FR-H31) |
1.77 |
2026-10-30 |
The percolation threshold of a family of microstructures (FR-M2) |
1.78 |
2026-10-30 |
The percolation threshold in the interface and the CLI (FR-M2, FR-I2, FR-I4) |
1.79 |
2026-10-30 |
The forest-fire algorithm of percolation (FR-M2) |
1.80 |
2026-10-30 |
The finite-size scaling of percolation thresholds (FR-M2) |
1.81 |
2026-10-30 |
Every porous behaviour in the MFront sources, morphoGen’s kernel where the brick differs (FR-E7, FR-H31) |
1.82 |
2026-10-30 |
The anisotropy of percolation, in 2-D and 3-D (FR-M2) |
1.83 |
2026-10-30 |
Cellular automata on other lattices (FR-A1) |
1.84 |
2026-10-30 |
Bending fibres packed by forces, Altendorf and Jeulin’s model (FR-G3) |
1.85 |
2026-10-30 |
Anisotropic versions of the morphological models (FR-G1 to FR-G9) |
1.86 |
2026-10-30 |
Fibres drawn into contact and entangled cross-linked fibres (FR-G3) |
1.87 |
2026-10-30 |
Behaviours learned from data, the module learning (FR-H21, FR-H34) |
1.88 |
2026-10-31 |
Covariances of oriented fibres, initial placement of least overlap, Delaunay fibre networks (FR-G3) |
1.89 |
2026-10-31 |
Quasi-periodic tilings in 2-D and 3-D, reaction-diffusion on any tiling (FR-A1) |
1.90 |
2026-10-31 |
Learned behaviours: a tool of the interface, laws turned with their material, thermal strains (FR-H21, FR-H34) |
1.91 |
2026-10-31 |
Thermodynamically consistent learned laws, a learned generalized standard material (FR-H21, FR-H34) |
1.92 |
2026-10-31 |
Stiffness of random fibre networks and open foams by periodic frames of beams, softening of non-identical beams (FR-G3, FR-H26) |
1.93 |
2026-10-31 |
Periodic approximants of the quasi-periodic tilings (FR-A1) |
1.94 |
2026-10-31 |
Timoshenko beams in the periodic frames, Ban et al.’s cases of thin sections (FR-G3, FR-H26) |
1.95 |
2026-10-31 |
Thermodynamically consistent learned laws in finite strains, in the logarithmic or Green-Lagrange space (FR-H21, FR-H34) |
1.96 |
2026-10-31 |
The beam frames against the FFT solver, rigid joints, Ban et al.’s case 9 examined (FR-G3, FR-H26) |
1.97 |
2026-10-31 |
The stiffness of the frames of beams in the interface and the command line (FR-G3, FR-H26) |
1.98 |
2026-10-31 |
The perceptron, the potential and the recurrent network in the logarithmic strain (FR-H21, FR-H34) |
1.99 |
2026-10-31 |
The thermal strain of the learned laws aligned on the Hencky points (FR-H21, FR-H34) |
1.100 |
2026-10-31 |
Ban et al.’s replicas and a drawing of the frame in the interface and the command line (FR-G3, FR-H26) |
1.101 |
2026-10-31 |
A gallery of the templates and a tutorial of a whole study in the documentation |
1.102 |
2026-10-31 |
The thin networks of the gallery seen in 3D |
1.103 |
2026-11-01 |
The learned laws as MFront behaviours (FR-H21, FR-H34, FR-E7) |
1.104 |
2026-11-01 |
The critical exponent of the conductivity at the percolation threshold (FR-M2) |
1.105 |
2026-11-01 |
The stiffness C_ij and the compliance S_ij in every elastic output (FR-H15) |
1.106 |
2026-11-01 |
Phase 4: the JOSS draft, the conda-forge recipe and the citation brought up to 0.6 |
1.107 |
2026-11-01 |
The mean stiffness C_ij and compliance S_ij of each volume in RVE studies (FR-V6, FR-H15) |
1.108 |
2026-11-01 |
The stiffness, compliance and conductivity tensors of RVE studies by windows (FR-V4, FR-H15) |
1.109 |
2026-11-01 |
The rigidity threshold from the moduli and the elastic exponent f at percolation (FR-M2) |
1.110 |
2026-11-01 |
Nonsymmetric consistent tangents: the full tangents and GMRES in the nonlinear solvers (FR-H17, FR-H20, FR-H21) |
1.111 |
2026-11-01 |
Shifted tilings of the window method and the edges of planar windows (FR-V4) |
1.112 |
2026-11-01 |
The voxels factorized near the rigidity threshold, and the elastic exponent f in 2D and 3D (FR-M2) |
1.113 |
2026-11-01 |
Deflated restarts of GMRES and an automatic choice of the tangent by its measured asymmetry (FR-H17, FR-H20) |
1.114 |
2026-11-01 |
The rigidity decided by the energies, the voxels that bear, the 3D threshold again, discs and spheres (FR-M2) |
1.115 |
2026-11-01 |
The shifts of the window method in the interface, and areas on the axes of planar windows (FR-V4) |
1.116 |
2026-11-02 |
GMRES recycled from its first restart, stagnating solves stopped, and auto by phase (FR-H17, FR-H20) |
1.117 |
2026-11-02 |
The rigidity confirmed at the floor of the residual, and the 2D and 3D sites again (FR-M2) |
1.118 |
2026-11-07 |
Laser-architectured sheets (§3.7, §5.13: FR-L1–L6) |
1.119 |
2026-11-07 |
The fracture of the martensite, the samples of Wang et al. 2023, cellular automata and topology optimization of the treated sheet, designs to laser tracks (§3.7, §5.13: FR-L7–L9) |
1.120 |
2026-11-07 |
Compact tension, L-shaped plate, plastic anisotropy and alternative materials of laser-architectured sheets (§3.7, §5.13: FR-L10–L12) |
1.121 |
2026-11-07 |
The rolling texture of a laser-architectured sheet compensated by the treatment, on the periodic cell of the sheet (FR-L13) |
1.122 |
2026-11-07 |
Yld2000-2d, crack growth along spirals of tracks, the anisotropy of sine architectures (FR-L14) |
1.123 |
2026-11-13 |
Multiphysics homogenization, viscoelasticity, hyperelasticity and damage in every solver, extended finite elements, the phase field of fracture, RVE statistics of every result (§3.8) |
1.124 |
2026-11-13 |
The flow through the pores and the acoustics of porous media; the new physics in the interface and on the command line (§3.8) |
1.125 |
2026-11-13 |
Three dimensions wherever a module worked only in the plane (§3.8) |
1.126 |
2026-11-13 |
Implicit geometry of every model, finite strains in every case, more hyperelastic laws, the menus of the interface (§3.8) |
1.127 |
2026-11-14 |
Tutorials, recipes, questions, glossary, gallery and site (§3.8, NFR-8) |
1.128 |
2026-11-14 |
Quadratic elements for the finite element analyses: isoparametric 10-node tetrahedra, curved interfaces, the default of the analyses (§3.8) |
1.129 |
2026-11-14 |
Selective reduced integration of the 10-node tetrahedra (mean dilatation: B-bar, F-bar) for nearly incompressible phases (§3.8) |
1.130 |
2026-11-14 |
Isogeometric analysis (NURBS patches, elasticity, conduction, periodic cells) and isogeometric shape optimization (§3.8) |
1.131 |
2026-11-14 |
Isogeometric cells of any lattice, the auxetic sheet with alternating holes, variables linked by symmetry, a tutorial (§3.8) |
1.132 |
2026-11-14 |
The conforming mesher follows the sharp edges of unions of spheres and segments and of their coatings (§3.8) |
1.133 |
2026-11-14 |
Coulomb’s friction of cohesive interfaces and of the lips of cracks (§3.8) |
1.134 |
2026-11-14 |
Contact, self-contact and friction of surfaces, rigid obstacles: |
1.135 |
2026-11-14 |
Self-contact in periodic cells along loading paths: |
1.136 |
2026-11-15 |
The contact of the walls of the pores in configurations and on the command line; the template |
1.137 |
2026-11-15 |
Ready-made tests of contact (compression between platens, indentation): functions, the commands |
1.138 |
2026-11-15 |
Damage laws: coupled to plasticity (Lemaitre, Kachanov-Rabotnov), of concrete (Mazars), the unilateral effect; a delayed damage; the template |
1.139 |
2026-11-15 |
A tutorial of contact and damage, whose snippets the tests run (§3.8) |
1.140 |
2026-11-15 |
Interfaces that debond in periodic cells along loading paths: |
1.141 |
2026-11-15 |
Multiaxial high-cycle fatigue of the points of a cell along a cycle: |
1.142 |
2026-11-15 |
The damage coupled to plasticity with Hill’s criterion (§3.8) |
1.143 |
2026-11-15 |
Interfaces that debond: a law per pair of phases, the fields of their damage and opening, the grain boundaries of polycrystals; the template |
1.144 |
2026-11-15 |
The graphical interface: interfaces that debond and the fatigue of a cycle in the tool of the loading paths (§3.8) |
1.145 |
2026-11-15 |
Twinning and cleavage in the crystal plasticity of the grains, hexagonal crystals, fibre textures; cracks between the grains and through them; the templates |
1.146 |
2026-11-15 |
The criterion of cleavage of Beremin on the fields of a loading path: |
1.147 |
2026-11-15 |
The tutorial How a microstructure breaks; the fatigue of a cycle on voxel images with pores (§3.8) |
1.148 |
2026-11-15 |
The criterion of Beremin in the graphical interface; the revision of the compiled kernels of the crystals (§3.8) |
1.149 |
2026-11-15 |
Contact points at the nodes of the faces: the corners and the edges of a body that touch (§3.8) |
1.150 |
2026-11-15 |
Cleavage cracks that close (the unilateral condition, friction), twins that shear back and turn the lattice of the crystal (§3.8) |
1.151 |
2026-11-15 |
Lattices turned grain by grain (the turned volume follows the twinned volume), twins and planes that go back at a share of their resistance, the cleavage planes of the turned lattices (§3.8) |
1.152 |
2026-11-15 |
Cleavage that the slip nucleates: the coupling of the cleavage planes with the slip of the crystal (§3.8) |
1.153 |
2026-11-16 |
Cleavage planes regularized by their microdamage: a damage band of a given width, the equation of the microdamage in the loading paths (§3.8) |
1.154 |
2026-11-16 |
The alternate scheme of the microdamage: its options in the configurations, its acceleration (§3.8) |
1.155 |
2026-11-16 |
The integration of the points two to three times faster for the crystals, with the same results to the bit (§3.8) |
1.156 |
2026-11-17 |
Loading paths in fewer Newton and linear iterations: the second-order prediction of a step, the secant of the condensed block of the macroscopic unknowns (§3.8) |
1.157 |
2026-11-17 |
The finite element solvers on several threads: Gauss–Seidel sweeps in the order of the colours of the unknowns, the products of the Krylov iterations, the reduced tangent of a path by the places of its stored values (§3.8) |
1.158 |
2026-11-17 |
The sweeps by nodes (3 × 3 blocks), the assembly of the paths by colours of elements, the BLAS on one thread while the compiled kernels run (§3.8) |
1.159 |
2026-11-17 |
The products of the Krylov iterations by blocks of nodes; along a path, the sweeps of each tangent and the coarse levels of the preconditioner kept while they serve (§3.8) |
1.160 |
2026-11-17 |
Crystallographic textures and orientation maps: symmetries, disorientations, pole figures; EBSD maps read and written ( |
1.161 |
2026-11-17 |
The command |
1.162 |
2026-11-17 |
The lattices along a loading path: the orientation of a material point at each step, the texture of a volume element at a time, from its fields and from their files; single slip against Schmid and Boas, the fibres of Taylor’s polycrystal (§3.8) |
1.163 |
2026-11-17 |
A tutorial (from an orientation map to a textured polycrystal) and the tool Orientation map (EBSD) of the interface (§3.8) |
1.164 |
2026-11-17 |
Scale-rich networks in two and three dimensions (FR-G17, FR-G18) and exact meshes without a background grid (FR-E9), developed apart from §3.8 and merged with it: |
1.165 |
2026-11-18 |
One interface of the implicit functions on grids and at points; |
14. References¶
The references of the phase-3 methods (automata, growth, aggregation, frameworks, topology optimization) are listed in theory.md.
Bironeau, A., Dirrenberger, J., Sollogoub, C., Miquelard-Garnier, G., Roland, S. (2016). Evaluation of morphological representative sample sizes for nanolayered polymer blends. J. Microscopy 264, 48–58.
Quey, R., Dawson, P. R., Barbe, F. (2011). Large-scale 3D random polycrystals for the finite element method: generation, meshing and remeshing. Comput. Methods Appl. Mech. Eng. 200, 1729–1745.
Roters, F. et al. (2019). DAMASK — The Düsseldorf Advanced Material Simulation Kit for modeling multi-physics crystal plasticity, thermal, and damage phenomena from the single crystal up to the component scale. Comput. Mater. Sci. 158, 420–478.
Chiu, S. N., Stoyan, D., Kendall, W. S., Mecke, J. (2013). Stochastic Geometry and its Applications, 3rd ed. Wiley.
Coulais, C., Teomy, E., de Reus, K., Shokef, Y., van Hecke, M. (2016). Combinatorial design of textured mechanical metamaterials. Nature 535, 529–532.
Dapogny, C., Dobrzynski, C., Frey, P. (2014). Three-dimensional adaptive domain remeshing, implicit domain meshing, and applications to free and moving boundary problems. J. Comput. Phys. 262, 358–378.
Dirrenberger, J., Forest, S., Jeulin, D. (2014). Towards gigantic RVE sizes for 3D stochastic fibrous networks. Int. J. Solids Struct. 51, 359–376.
Gilbert, E. N. (1962). Random subdivisions of space into crystals. Ann. Math. Stat. 33, 958–972.
Helfer, T., Michel, B., Proix, J.-M., Salvo, M., Sercombe, J., Casella, M. (2015). Introducing the open-source mfront code generator: application to mechanical behaviours and material knowledge management within the PLEIADES fuel element modelling platform. Comput. Math. Appl. 70, 994–1023.
Helfer, T., Bleyer, J., Frondelius, T., Yashchuk, I., Nagel, T., Naumov, D. (2020). The MFrontGenericInterfaceSupport project. J. Open Source Softw. 5(48), 2003.
Jeulin, D. (2011). Variance scaling of Boolean random varieties. Technical report, Centre de Morphologie Mathématique, hal-00618967.
Kanit, T., Forest, S., Galliet, I., Mounoury, V., Jeulin, D. (2003). Determination of the size of the representative volume element for random composites. Int. J. Solids Struct. 40, 3647–3679.
Lantuéjoul, C. (1991). Ergodicity and integral range. J. Microscopy 161, 387–403.
Matheron, G. (1971). The Theory of Regionalized Variables and its Applications. École des Mines de Paris.
Ohser, J., Schladitz, K. (2009). 3D Images of Materials Structures. Wiley-VCH.
Schneider, M., Merkert, D., Kabel, M. (2017). FFT-based homogenization for microstructures discretized by linear hexahedral elements. Int. J. Numer. Methods Eng. 109, 1461–1489.
Sigmund, O. (1994). Materials with prescribed constitutive parameters: an inverse homogenization problem. Int. J. Solids Struct. 31, 2313–2329.
Torquato, S. (2002). Random Heterogeneous Materials. Springer.
Lubachevsky, B. D., Stillinger, F. H. (1990). Geometric properties of random disk packings. J. Stat. Phys. 60, 561–583.
Yeong, C. L. Y., Torquato, S. (1998). Reconstructing random media. Phys. Rev. E 57, 495–506.
Tovar, A., Patel, N. M., Niebur, G. L., Sen, M., Renaud, J. E. (2006). Topology optimization using a hybrid cellular automaton method with local control rules. J. Mech. Des. 128, 1205–1216.
Vaněk, P., Mandel, J., Brezina, M. (1996). Algebraic multigrid by smoothed aggregation for second and fourth order elliptic problems. Computing 56, 179–196.
Yang, S., Dirrenberger, J., Monteiro, E., Ranc, N. (2019). Representative volume element size determination for viscoplastic properties in polycrystalline materials. Int. J. Solids Struct. 158, 210–219.