morphogen 1.0.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (381) hide show
  1. morphogen/__init__.py +60 -0
  2. morphogen/__main__.py +7 -0
  3. morphogen/_platform.py +55 -0
  4. morphogen/_public.py +153 -0
  5. morphogen/_utils.py +80 -0
  6. morphogen/_version.py +1 -0
  7. morphogen/analysis/__init__.py +174 -0
  8. morphogen/analysis/anisotropy.py +135 -0
  9. morphogen/analysis/basic.py +38 -0
  10. morphogen/analysis/cells.py +54 -0
  11. morphogen/analysis/connectivity.py +156 -0
  12. morphogen/analysis/correlation.py +195 -0
  13. morphogen/analysis/covariance.py +80 -0
  14. morphogen/analysis/fractal.py +54 -0
  15. morphogen/analysis/measures.py +188 -0
  16. morphogen/analysis/morphology.py +265 -0
  17. morphogen/analysis/particles.py +160 -0
  18. morphogen/analysis/percolation.py +2034 -0
  19. morphogen/analysis/power_laws.py +143 -0
  20. morphogen/analysis/random_sets.py +351 -0
  21. morphogen/analysis/stereology.py +289 -0
  22. morphogen/analysis/surface.py +107 -0
  23. morphogen/analysis/topology.py +92 -0
  24. morphogen/automata/__init__.py +74 -0
  25. morphogen/automata/engine.py +211 -0
  26. morphogen/automata/growth.py +686 -0
  27. morphogen/automata/lattice.py +143 -0
  28. morphogen/automata/reaction.py +255 -0
  29. morphogen/automata/rules.py +353 -0
  30. morphogen/automata/tilings.py +1715 -0
  31. morphogen/cli.py +3526 -0
  32. morphogen/config.py +2167 -0
  33. morphogen/contact/__init__.py +113 -0
  34. morphogen/contact/experiments.py +368 -0
  35. morphogen/contact/hertz.py +104 -0
  36. morphogen/contact/kernels.py +827 -0
  37. morphogen/contact/periodic.py +278 -0
  38. morphogen/contact/problem.py +578 -0
  39. morphogen/contact/surfaces.py +310 -0
  40. morphogen/coupling/__init__.py +43 -0
  41. morphogen/coupling/ageing.py +143 -0
  42. morphogen/coupling/diffusion.py +226 -0
  43. morphogen/coupling/fenicsx.py +484 -0
  44. morphogen/coupling/oxidation.py +447 -0
  45. morphogen/coupling/plates.py +247 -0
  46. morphogen/design/__init__.py +51 -0
  47. morphogen/design/csp.py +616 -0
  48. morphogen/design/frames.py +277 -0
  49. morphogen/design/search.py +287 -0
  50. morphogen/design/tiles.py +336 -0
  51. morphogen/distributions.py +312 -0
  52. morphogen/domain.py +203 -0
  53. morphogen/dynamics/__init__.py +179 -0
  54. morphogen/dynamics/model.py +638 -0
  55. morphogen/dynamics/openradioss.py +643 -0
  56. morphogen/dynamics/results.py +515 -0
  57. morphogen/fracture/__init__.py +170 -0
  58. morphogen/fracture/bulk.py +349 -0
  59. morphogen/fracture/cohesive.py +1614 -0
  60. morphogen/fracture/ductile.py +557 -0
  61. morphogen/fracture/lefm.py +1168 -0
  62. morphogen/fracture/mixed.py +1178 -0
  63. morphogen/fracture/periodic.py +733 -0
  64. morphogen/fracture/phasefield.py +714 -0
  65. morphogen/fracture/phasefield_finite.py +368 -0
  66. morphogen/fracture/surface.py +572 -0
  67. morphogen/fracture/toughness.py +566 -0
  68. morphogen/gpu.py +108 -0
  69. morphogen/gui/__init__.py +8 -0
  70. morphogen/gui/api.py +1927 -0
  71. morphogen/gui/desktop.py +387 -0
  72. morphogen/gui/icon.png +0 -0
  73. morphogen/gui/index.html +1909 -0
  74. morphogen/gui/server.py +229 -0
  75. morphogen/gui/tools/__init__.py +629 -0
  76. morphogen/gui/tools/compare.py +149 -0
  77. morphogen/gui/tools/contact.py +391 -0
  78. morphogen/gui/tools/couplings.py +1085 -0
  79. morphogen/gui/tools/crackfront.py +245 -0
  80. morphogen/gui/tools/design.py +224 -0
  81. morphogen/gui/tools/dynamics.py +824 -0
  82. morphogen/gui/tools/fracture.py +2586 -0
  83. morphogen/gui/tools/interop.py +1654 -0
  84. morphogen/gui/tools/learning.py +595 -0
  85. morphogen/gui/tools/mechanics.py +3881 -0
  86. morphogen/gui/tools/nonlocal_damage.py +1321 -0
  87. morphogen/gui/tools/phasefield.py +215 -0
  88. morphogen/gui/tools/physics.py +597 -0
  89. morphogen/gui/tools/stability.py +1756 -0
  90. morphogen/gui/tools/statistics.py +1408 -0
  91. morphogen/gui/viewer.js +1100 -0
  92. morphogen/homogenization/__init__.py +210 -0
  93. morphogen/homogenization/acoustics.py +566 -0
  94. morphogen/homogenization/amg.py +1005 -0
  95. morphogen/homogenization/apparent.py +1046 -0
  96. morphogen/homogenization/behaviours.cu +2285 -0
  97. morphogen/homogenization/behaviours.py +944 -0
  98. morphogen/homogenization/beremin.py +263 -0
  99. morphogen/homogenization/bifurcation.py +1085 -0
  100. morphogen/homogenization/bloch.py +507 -0
  101. morphogen/homogenization/bounds.py +226 -0
  102. morphogen/homogenization/core.py +458 -0
  103. morphogen/homogenization/coupled.py +1135 -0
  104. morphogen/homogenization/crystal.py +2967 -0
  105. morphogen/homogenization/dilatation.py +454 -0
  106. morphogen/homogenization/elements.py +157 -0
  107. morphogen/homogenization/fatigue.py +768 -0
  108. morphogen/homogenization/fe.py +1739 -0
  109. morphogen/homogenization/fenicsx.py +307 -0
  110. morphogen/homogenization/fft.py +499 -0
  111. morphogen/homogenization/fft_nonlinear.py +391 -0
  112. morphogen/homogenization/finite.py +613 -0
  113. morphogen/homogenization/flow.py +361 -0
  114. morphogen/homogenization/frames.py +1125 -0
  115. morphogen/homogenization/gpu.py +1241 -0
  116. morphogen/homogenization/harmonic.py +427 -0
  117. morphogen/homogenization/identification.py +579 -0
  118. morphogen/homogenization/kernels.py +760 -0
  119. morphogen/homogenization/laws.py +2061 -0
  120. morphogen/homogenization/materials.py +1080 -0
  121. morphogen/homogenization/mfront.py +589 -0
  122. morphogen/homogenization/networks.py +880 -0
  123. morphogen/homogenization/nonlinear.py +2612 -0
  124. morphogen/homogenization/ntfa.py +577 -0
  125. morphogen/homogenization/paths.py +476 -0
  126. morphogen/homogenization/photonic.py +467 -0
  127. morphogen/homogenization/poroelastic.py +212 -0
  128. morphogen/homogenization/porous.py +1120 -0
  129. morphogen/homogenization/postprocess.py +290 -0
  130. morphogen/homogenization/solvers.py +1140 -0
  131. morphogen/homogenization/tensors.py +240 -0
  132. morphogen/homogenization/voxel_fe.py +457 -0
  133. morphogen/homogenization/xfem.py +1016 -0
  134. morphogen/homogenization/zmat.py +1258 -0
  135. morphogen/iga/__init__.py +48 -0
  136. morphogen/iga/analysis.py +508 -0
  137. morphogen/iga/basis.py +214 -0
  138. morphogen/iga/geometry.py +501 -0
  139. morphogen/iga/homogenization.py +219 -0
  140. morphogen/iga/optimization.py +700 -0
  141. morphogen/iga/shapes.py +331 -0
  142. morphogen/image.py +128 -0
  143. morphogen/io/__init__.py +246 -0
  144. morphogen/io/amitex.py +741 -0
  145. morphogen/io/ebsd.py +881 -0
  146. morphogen/io/export.py +196 -0
  147. morphogen/io/geometry.py +158 -0
  148. morphogen/io/medit.py +147 -0
  149. morphogen/io/meshes.py +844 -0
  150. morphogen/io/metaimage.py +97 -0
  151. morphogen/io/mfront.py +1104 -0
  152. morphogen/io/native.py +57 -0
  153. morphogen/io/radioss.py +764 -0
  154. morphogen/io/solvers.py +371 -0
  155. morphogen/io/tables.py +278 -0
  156. morphogen/io/tiff.py +66 -0
  157. morphogen/io/vtk.py +701 -0
  158. morphogen/io/xdmf.py +200 -0
  159. morphogen/kernels/__init__.py +5 -0
  160. morphogen/kernels/annealing.py +192 -0
  161. morphogen/kernels/cells.py +69 -0
  162. morphogen/kernels/collective.py +87 -0
  163. morphogen/kernels/force_biased.py +595 -0
  164. morphogen/kernels/implicit.py +145 -0
  165. morphogen/kernels/leaves.py +132 -0
  166. morphogen/kernels/packing.py +304 -0
  167. morphogen/kernels/raster.py +279 -0
  168. morphogen/kernels/rsa.py +371 -0
  169. morphogen/kernels/union.py +135 -0
  170. morphogen/kernels/watershed.py +190 -0
  171. morphogen/laser/__init__.py +234 -0
  172. morphogen/laser/architectures.py +375 -0
  173. morphogen/laser/bending.py +216 -0
  174. morphogen/laser/cells.py +1694 -0
  175. morphogen/laser/design.py +940 -0
  176. morphogen/laser/figures.py +227 -0
  177. morphogen/laser/heat.py +804 -0
  178. morphogen/laser/materials.py +691 -0
  179. morphogen/laser/mechanics.py +1670 -0
  180. morphogen/laser/metallurgy.py +615 -0
  181. morphogen/laser/patterns.py +828 -0
  182. morphogen/laser/periodic.py +392 -0
  183. morphogen/laser/process.py +362 -0
  184. morphogen/laser/run.py +534 -0
  185. morphogen/laser/solid.py +216 -0
  186. morphogen/laser/specimen.py +200 -0
  187. morphogen/laser/structures.py +708 -0
  188. morphogen/learning/__init__.py +81 -0
  189. morphogen/learning/behaviour.py +398 -0
  190. morphogen/learning/data.py +328 -0
  191. morphogen/learning/learned.cpp +668 -0
  192. morphogen/learning/logarithmic.py +202 -0
  193. morphogen/learning/mfront.py +409 -0
  194. morphogen/learning/networks.py +767 -0
  195. morphogen/learning/run.py +212 -0
  196. morphogen/learning/standard.py +814 -0
  197. morphogen/learning/training.py +235 -0
  198. morphogen/mesh/__init__.py +29 -0
  199. morphogen/mesh/conforming.py +1423 -0
  200. morphogen/mesh/curved.py +600 -0
  201. morphogen/mesh/exact.py +1717 -0
  202. morphogen/mesh/octree.py +350 -0
  203. morphogen/mesh/polycrystal.py +1041 -0
  204. morphogen/mesh/polyhedra.py +677 -0
  205. morphogen/mesh/regularize.py +570 -0
  206. morphogen/mesh/surface.py +97 -0
  207. morphogen/mesh/tetra.py +512 -0
  208. morphogen/mesh/voxel.py +124 -0
  209. morphogen/micromorphic/__init__.py +31 -0
  210. morphogen/micromorphic/damage.py +359 -0
  211. morphogen/micromorphic/ductile.py +534 -0
  212. morphogen/micromorphic/finite.py +220 -0
  213. morphogen/micromorphic/microfoam.py +787 -0
  214. morphogen/micromorphic/space.py +341 -0
  215. morphogen/models/__init__.py +195 -0
  216. morphogen/models/affine.py +384 -0
  217. morphogen/models/automata.py +592 -0
  218. morphogen/models/base.py +500 -0
  219. morphogen/models/boolean.py +310 -0
  220. morphogen/models/bouligand.py +331 -0
  221. morphogen/models/branching.py +241 -0
  222. morphogen/models/combination.py +430 -0
  223. morphogen/models/deadleaves.py +766 -0
  224. morphogen/models/design.py +289 -0
  225. morphogen/models/ebsd.py +206 -0
  226. morphogen/models/fibers.py +1476 -0
  227. morphogen/models/foam.py +594 -0
  228. morphogen/models/gaussian.py +314 -0
  229. morphogen/models/growth.py +459 -0
  230. morphogen/models/hardcore.py +317 -0
  231. morphogen/models/hierarchical.py +269 -0
  232. morphogen/models/honeycomb.py +749 -0
  233. morphogen/models/implicit.py +177 -0
  234. morphogen/models/laminate.py +470 -0
  235. morphogen/models/lattice.py +351 -0
  236. morphogen/models/lattice_field.py +345 -0
  237. morphogen/models/levelset_foam.py +563 -0
  238. morphogen/models/nacre.py +411 -0
  239. morphogen/models/nested.py +924 -0
  240. morphogen/models/osteons.py +374 -0
  241. morphogen/models/pieces.py +167 -0
  242. morphogen/models/planar.py +126 -0
  243. morphogen/models/reconstruction.py +203 -0
  244. morphogen/models/scale_rich.py +1409 -0
  245. morphogen/models/scale_rich_3d.py +1616 -0
  246. morphogen/models/tessellation.py +735 -0
  247. morphogen/models/tiling_field.py +302 -0
  248. morphogen/models/tpms.py +197 -0
  249. morphogen/models/transparent.py +406 -0
  250. morphogen/models/union.py +141 -0
  251. morphogen/optimization/__init__.py +43 -0
  252. morphogen/optimization/cell.py +295 -0
  253. morphogen/optimization/filters.py +115 -0
  254. morphogen/optimization/mma.py +226 -0
  255. morphogen/optimization/run.py +219 -0
  256. morphogen/optimization/topology.py +632 -0
  257. morphogen/orientations.py +568 -0
  258. morphogen/parallel.py +599 -0
  259. morphogen/pipeline.py +978 -0
  260. morphogen/primitives.py +188 -0
  261. morphogen/results.py +564 -0
  262. morphogen/rve/__init__.py +73 -0
  263. morphogen/rve/report.py +627 -0
  264. morphogen/rve/scaling.py +363 -0
  265. morphogen/rve/study.py +1054 -0
  266. morphogen/rve/windows.py +345 -0
  267. morphogen/seeding.py +51 -0
  268. morphogen/settings.py +118 -0
  269. morphogen/stopping.py +48 -0
  270. morphogen/symmetry.py +384 -0
  271. morphogen/templates/activator_inhibitor.yaml +22 -0
  272. morphogen/templates/aggregation.yaml +23 -0
  273. morphogen/templates/boolean_cylinders.yaml +20 -0
  274. morphogen/templates/boolean_spheres.yaml +22 -0
  275. morphogen/templates/bouligand.yaml +28 -0
  276. morphogen/templates/cellular_automaton.yaml +25 -0
  277. morphogen/templates/coated_spheres.yaml +26 -0
  278. morphogen/templates/contact_fibers.yaml +27 -0
  279. morphogen/templates/cox_nanocomposite.yaml +22 -0
  280. morphogen/templates/cross_linked_fibers.yaml +26 -0
  281. morphogen/templates/curved_arcs.yaml +28 -0
  282. morphogen/templates/curved_fibers.yaml +24 -0
  283. morphogen/templates/dead_leaves.yaml +22 -0
  284. morphogen/templates/delaunay_network.yaml +22 -0
  285. morphogen/templates/dense_packing.yaml +22 -0
  286. morphogen/templates/diffusion.yaml +33 -0
  287. morphogen/templates/ebsd.yaml +34 -0
  288. morphogen/templates/ebsd_map.ctf +3087 -0
  289. morphogen/templates/fracture_composite.yaml +42 -0
  290. morphogen/templates/fracture_rubber.yaml +47 -0
  291. morphogen/templates/gaussian_excursion.yaml +17 -0
  292. morphogen/templates/graded_lattice.yaml +24 -0
  293. morphogen/templates/hardcore_fibers.yaml +22 -0
  294. morphogen/templates/hardcore_spheres.yaml +22 -0
  295. morphogen/templates/hierarchical_lattice.yaml +22 -0
  296. morphogen/templates/homogenization_acoustic_foam.yaml +36 -0
  297. morphogen/templates/homogenization_beremin.yaml +50 -0
  298. morphogen/templates/homogenization_cleavage.yaml +51 -0
  299. morphogen/templates/homogenization_cleavage_band.yaml +55 -0
  300. morphogen/templates/homogenization_contact.yaml +43 -0
  301. morphogen/templates/homogenization_crack_closure.yaml +49 -0
  302. morphogen/templates/homogenization_crystal_plasticity.yaml +50 -0
  303. morphogen/templates/homogenization_crystal_plasticity_fft.yaml +52 -0
  304. morphogen/templates/homogenization_crystallization.yaml +30 -0
  305. morphogen/templates/homogenization_debonding.yaml +43 -0
  306. morphogen/templates/homogenization_detwinning.yaml +58 -0
  307. morphogen/templates/homogenization_ductile_damage.yaml +47 -0
  308. morphogen/templates/homogenization_fatigue.yaml +40 -0
  309. morphogen/templates/homogenization_grain_fracture.yaml +56 -0
  310. morphogen/templates/homogenization_gyroid.yaml +30 -0
  311. morphogen/templates/homogenization_intergranular.yaml +43 -0
  312. morphogen/templates/homogenization_interphase.yaml +42 -0
  313. morphogen/templates/homogenization_mixed_loading.yaml +33 -0
  314. morphogen/templates/homogenization_ntfa.yaml +56 -0
  315. morphogen/templates/homogenization_piezoelectric.yaml +27 -0
  316. morphogen/templates/homogenization_polycrystal.yaml +30 -0
  317. morphogen/templates/homogenization_polycrystal_inclusions.yaml +30 -0
  318. morphogen/templates/homogenization_poroelastic.yaml +26 -0
  319. morphogen/templates/homogenization_rubber.yaml +40 -0
  320. morphogen/templates/homogenization_slip_cleavage.yaml +50 -0
  321. morphogen/templates/homogenization_spheres.yaml +31 -0
  322. morphogen/templates/homogenization_transport.yaml +29 -0
  323. morphogen/templates/homogenization_twinning.yaml +54 -0
  324. morphogen/templates/homogenization_viscoelastic.yaml +34 -0
  325. morphogen/templates/homogenization_viscoplastic.yaml +42 -0
  326. morphogen/templates/homogenization_voronoi.yaml +26 -0
  327. morphogen/templates/homogenization_xfem.yaml +23 -0
  328. morphogen/templates/hyperuniform_cells.yaml +24 -0
  329. morphogen/templates/laguerre.yaml +18 -0
  330. morphogen/templates/laser_bending.yaml +35 -0
  331. morphogen/templates/laser_cells.yaml +38 -0
  332. morphogen/templates/laser_corrugated.yaml +36 -0
  333. morphogen/templates/level_set_foam.yaml +29 -0
  334. morphogen/templates/menger_sponge.yaml +17 -0
  335. morphogen/templates/nacre.yaml +25 -0
  336. morphogen/templates/nucleation_growth.yaml +25 -0
  337. morphogen/templates/optimize_auxetic.yaml +29 -0
  338. morphogen/templates/optimize_auxetic_3d.yaml +27 -0
  339. morphogen/templates/optimize_bulk.yaml +23 -0
  340. morphogen/templates/optimize_conductivity.yaml +20 -0
  341. morphogen/templates/osteons.yaml +28 -0
  342. morphogen/templates/penetrable_spheres.yaml +21 -0
  343. morphogen/templates/poisson_fibers.yaml +21 -0
  344. morphogen/templates/random_laminate.yaml +26 -0
  345. morphogen/templates/random_lattice.yaml +27 -0
  346. morphogen/templates/random_walk_fibers.yaml +26 -0
  347. morphogen/templates/reaction_diffusion.yaml +22 -0
  348. morphogen/templates/reconstruction.yaml +22 -0
  349. morphogen/templates/rve_cellular_automaton.yaml +23 -0
  350. morphogen/templates/rve_crystal_plasticity_fft.yaml +51 -0
  351. morphogen/templates/rve_multiphysics.yaml +43 -0
  352. morphogen/templates/rve_poisson_fibers.yaml +22 -0
  353. morphogen/templates/rve_poisson_fibers_fe.yaml +33 -0
  354. morphogen/templates/rve_voronoi_windows.yaml +20 -0
  355. morphogen/templates/scale_rich_network.yaml +29 -0
  356. morphogen/templates/scale_rich_plates.yaml +30 -0
  357. morphogen/templates/sequential_dead_leaves.yaml +25 -0
  358. morphogen/templates/strut_lattice.yaml +21 -0
  359. morphogen/templates/tile_assembly.yaml +28 -0
  360. morphogen/templates/tpms.yaml +19 -0
  361. morphogen/templates/trabecular_bone.yaml +29 -0
  362. morphogen/templates/transparent_dead_leaves.yaml +23 -0
  363. morphogen/templates/vascular_tree.yaml +23 -0
  364. morphogen/templates/voronoi.yaml +20 -0
  365. morphogen/templates/wood.yaml +34 -0
  366. morphogen/templates/workflow.yaml +56 -0
  367. morphogen/texture.py +665 -0
  368. morphogen/theory.py +162 -0
  369. morphogen/viz/__init__.py +12 -0
  370. morphogen/viz/export.py +244 -0
  371. morphogen/viz/figures.py +707 -0
  372. morphogen/viz/png.py +148 -0
  373. morphogen/viz/sections.py +696 -0
  374. morphogen/viz/surfaces.py +1352 -0
  375. morphogen/viz/video.py +904 -0
  376. morphogen/viz/workflow.py +488 -0
  377. morphogen-1.0.0.dist-info/METADATA +2316 -0
  378. morphogen-1.0.0.dist-info/RECORD +381 -0
  379. morphogen-1.0.0.dist-info/WHEEL +4 -0
  380. morphogen-1.0.0.dist-info/entry_points.txt +5 -0
  381. morphogen-1.0.0.dist-info/licenses/LICENSE +674 -0
@@ -0,0 +1,459 @@
1
+ """Grain structures and aggregates grown on lattices.
2
+
3
+ ``nucleation_growth``
4
+ Johnson-Mehl-Avrami-Kolmogorov nucleation and growth: Voronoi (site saturation) or
5
+ Johnson-Mehl (continuous nucleation) polycrystals, partially transformed structures
6
+ (grains in an untransformed matrix), faceted grains, and normal grain growth
7
+ (Potts model) after the transformation.
8
+ ``aggregation``
9
+ Diffusion-limited (fractal), Eden (compact) or ballistic (porous) aggregates:
10
+ clusters grown from seeds, or deposits grown from a face of the domain.
11
+
12
+ See :mod:`morphogen.automata.growth` for the algorithms.
13
+ """
14
+
15
+ from __future__ import annotations
16
+
17
+ import math
18
+ from dataclasses import dataclass
19
+ from typing import ClassVar
20
+
21
+ import numpy as np
22
+
23
+ from morphogen._utils import check_fraction, check_positive
24
+ from morphogen.automata.growth import (
25
+ AGGREGATION_GEOMETRIES,
26
+ AGGREGATION_PROCESSES,
27
+ GROWTH_SHAPES,
28
+ aggregate,
29
+ grow_grains,
30
+ potts_coarsening,
31
+ shape_volume_coefficient,
32
+ )
33
+ from morphogen.domain import Domain
34
+ from morphogen.models.affine import ANISOTROPY, Anisotropy, anisotropic
35
+ from morphogen.models.automata import MAX_MARGIN, _LatticeModel
36
+ from morphogen.models.base import param, register
37
+ from morphogen.models.lattice_field import LatticeField, lattice_shape
38
+ from morphogen.orientations import euler_to_matrix, random_orientations
39
+ from morphogen.seeding import SeedLike, make_rng
40
+
41
+ NUCLEATION = ("site_saturation", "continuous")
42
+
43
+ #: Fractal dimensions of on-lattice aggregates (Meakin 1983; compact for Eden growth).
44
+ DLA_DIMENSION = {2: 1.71, 3: 2.50}
45
+
46
+
47
+ def _check_phase_fractions(p) -> None:
48
+ if p is None:
49
+ return
50
+ p = np.asarray(p, dtype=float)
51
+ if p.ndim != 1 or len(p) < 1 or np.any(p < 0) or abs(p.sum() - 1.0) > 1e-9:
52
+ raise ValueError("phase_fractions: non-negative probabilities summing to 1")
53
+ if len(p) > 255:
54
+ raise ValueError("phase_fractions: at most 255 phases")
55
+
56
+
57
+ @register
58
+ @anisotropic
59
+ @dataclass(frozen=True)
60
+ class NucleationGrowthModel(_LatticeModel):
61
+ """Nucleation and growth of grains until impingement (JMAK kinetics).
62
+
63
+ Grains nucleate at random and grow at constant velocity (Johnson-Mehl-Avrami-
64
+ Kolmogorov): Voronoi or Johnson-Mehl polycrystals, or grains in an untransformed
65
+ matrix when the transformation is stopped.
66
+ """
67
+
68
+ name = "nucleation_growth"
69
+ phases: ClassVar[dict[int, str]] = {0: "matrix", 1: "grains"}
70
+ count_label = "grains"
71
+
72
+ nucleation: str = param(
73
+ "site_saturation",
74
+ doc="site_saturation (every nucleus at t = 0: Voronoi grains) or continuous "
75
+ "(constant rate in the untransformed volume: Johnson-Mehl grains)",
76
+ kind="str",
77
+ )
78
+ nucleus_density: float | None = param(
79
+ None, doc="Nuclei per unit volume (site saturation)", unit="1/length^3"
80
+ )
81
+ nucleation_rate: float | None = param(
82
+ None,
83
+ doc="Nuclei per unit volume and unit time (continuous nucleation)",
84
+ unit="1/(length^3 time)",
85
+ )
86
+ growth_rate: float = param(
87
+ 1.0, doc="Radius gained by a grain per unit time", unit="length/time"
88
+ )
89
+ time: float | None = param(
90
+ None,
91
+ doc="Duration of the transformation (default: until it is complete)",
92
+ unit="time",
93
+ )
94
+ growth_shape: str = param(
95
+ "sphere",
96
+ doc="sphere (isotropic growth), cube or octahedron (faceted grains, oriented by "
97
+ "their crystal orientation when crystal_orientations is set)",
98
+ kind="str",
99
+ )
100
+ crystal_orientations: bool = param(
101
+ False, doc="Draw a uniformly random crystal orientation per grain", kind="bool"
102
+ )
103
+ phase_fractions: tuple[float, ...] | None = param(
104
+ None,
105
+ doc="Probabilities of phases 0, 1, ... for each grain (default: every grain is "
106
+ "phase 1; the untransformed matrix is phase 0)",
107
+ kind="floats",
108
+ )
109
+ coarsening_steps: int = param(
110
+ 0,
111
+ doc="Monte Carlo sweeps of normal grain growth (Potts model) after a complete "
112
+ "transformation",
113
+ kind="int",
114
+ )
115
+ coarsening_temperature: float = param(
116
+ 0.5, doc="Temperature of the Potts model (energy of a pair of unlike neighbours)"
117
+ )
118
+ anisotropy: Anisotropy | None = param(None, doc=ANISOTROPY, kind="anisotropy", kw_only=True)
119
+
120
+ def _validate(self) -> None:
121
+ self._validate_lattice()
122
+ if self.nucleation not in NUCLEATION:
123
+ raise ValueError(f"nucleation: one of {NUCLEATION}")
124
+ site = self.nucleation == "site_saturation"
125
+ if site and (self.nucleus_density is None or self.nucleation_rate is not None):
126
+ raise ValueError("site saturation needs 'nucleus_density' (not nucleation_rate)")
127
+ if not site and (self.nucleation_rate is None or self.nucleus_density is not None):
128
+ raise ValueError("continuous nucleation needs 'nucleation_rate' (not nucleus_density)")
129
+ check_positive(
130
+ self.nucleus_density if site else self.nucleation_rate,
131
+ "nucleus_density" if site else "nucleation_rate",
132
+ )
133
+ check_positive(self.growth_rate, "growth_rate")
134
+ if self.time is not None:
135
+ check_positive(self.time, "time")
136
+ if self.growth_shape not in GROWTH_SHAPES:
137
+ raise ValueError(f"growth_shape: one of {GROWTH_SHAPES}")
138
+ _check_phase_fractions(self.phase_fractions)
139
+ if self.coarsening_steps < 0:
140
+ raise ValueError("coarsening_steps: must be non-negative")
141
+ if self.coarsening_steps and self.time is not None:
142
+ raise ValueError(
143
+ "grain growth (coarsening_steps) follows a complete transformation: remove 'time'"
144
+ )
145
+ check_positive(self.coarsening_temperature, "coarsening_temperature", allow_zero=True)
146
+
147
+ # -- kinetics ------------------------------------------------------------------------
148
+
149
+ def _densities(self, domain: Domain | None) -> tuple[float, int]:
150
+ """Nucleus density (or rate) per unit volume in 3D, per unit area in 2D."""
151
+ value = (
152
+ self.nucleus_density if self.nucleation == "site_saturation" else self.nucleation_rate
153
+ )
154
+ if self.dimension == 3:
155
+ return float(value), 3
156
+ if domain is None:
157
+ raise ValueError("planar kinetics depend on the thickness of the domain")
158
+ return float(value) * float(domain.lengths[2]), 2
159
+
160
+ def extended_fraction(self, t, domain: Domain | None = None):
161
+ """Extended volume fraction X_ext(t): volume of the grains, overlaps counted."""
162
+ rho, d = self._densities(domain)
163
+ c = shape_volume_coefficient(self.growth_shape, d)
164
+ t = np.asarray(t, dtype=float)
165
+ if self.nucleation == "site_saturation":
166
+ return rho * c * (self.growth_rate * t) ** d
167
+ return rho * c * self.growth_rate**d * t ** (d + 1) / (d + 1)
168
+
169
+ def transformed_fraction(self, t, domain: Domain | None = None):
170
+ """Avrami's law X(t) = 1 - exp(-X_ext(t))."""
171
+ return 1.0 - np.exp(-self.extended_fraction(t, domain))
172
+
173
+ def _time_to_extended(self, value: float, domain: Domain | None) -> float:
174
+ """Time at which X_ext reaches ``value``."""
175
+ rho, d = self._densities(domain)
176
+ c = shape_volume_coefficient(self.growth_shape, d)
177
+ if self.nucleation == "site_saturation":
178
+ return (value / (rho * c)) ** (1.0 / d) / self.growth_rate
179
+ return (value * (d + 1) / (rho * c * self.growth_rate**d)) ** (1.0 / (d + 1))
180
+
181
+ def grain_density(self, domain: Domain | None = None) -> float:
182
+ """Grains per unit volume after a complete transformation."""
183
+ rho, d = self._densities(domain)
184
+ if self.nucleation == "site_saturation":
185
+ n = rho
186
+ else:
187
+ c = shape_volume_coefficient(self.growth_shape, d)
188
+ a = rho * c * self.growth_rate**d / (d + 1)
189
+ n = rho * math.gamma(1.0 + 1.0 / (d + 1)) * a ** (-1.0 / (d + 1))
190
+ return n if d == 3 else n / float(domain.lengths[2])
191
+
192
+ def theory(self, domain: Domain | None = None) -> dict[str, float]:
193
+ if self.dimension == 2 and domain is None:
194
+ return {}
195
+ d = self.dimension
196
+ site = self.nucleation == "site_saturation"
197
+ out = {
198
+ "avrami_exponent": float(d if site else d + 1),
199
+ "half_transformation_time": self._time_to_extended(math.log(2.0), domain),
200
+ }
201
+ if self.time is not None:
202
+ x = float(self.transformed_fraction(self.time, domain))
203
+ out["transformed_fraction"] = x
204
+ if self.phase_fractions is None:
205
+ out["volume_fraction"] = x
206
+ elif self.coarsening_steps == 0:
207
+ n = self.grain_density(domain)
208
+ out["grain_density"] = n
209
+ out["mean_grain_volume"] = 1.0 / n
210
+ return out
211
+
212
+ def expected_count(self, domain: Domain) -> float | None:
213
+ if self.time is not None or self.coarsening_steps:
214
+ return None
215
+ return self.grain_density(domain) * domain.volume
216
+
217
+ # -- generation ----------------------------------------------------------------------
218
+
219
+ def generate(self, domain: Domain, seed: SeedLike = None) -> LatticeField:
220
+ rng, seed_info = make_rng(seed)
221
+ fields, _ = self._simulate(domain, rng)
222
+ return LatticeField(domain, smoothing=self.smoothing, model=self, seed=seed_info, **fields)
223
+
224
+ def _simulate(self, domain: Domain, rng, frames: int = 0):
225
+ """Fields of the realization, and label images at evenly spaced times (frames)."""
226
+ d = self.dimension
227
+ shape = lattice_shape(domain, self.cell_size, d)
228
+ h = domain.lengths / np.array(shape)
229
+ # duration of the simulation: the given time, or completion (an expected
230
+ # untransformed volume of 1e-4 cells)
231
+ complete = self._time_to_extended(math.log(max(np.prod(shape), 2.0)) + 9.2, domain)
232
+ horizon = complete if self.time is None else min(float(self.time), complete)
233
+ _, sim, crop = self._window(domain, self.growth_rate * horizon / self.cell_size)
234
+ volume = float(np.prod(h)) * float(np.prod(sim))
235
+ if self.nucleation == "site_saturation":
236
+ n = int(rng.poisson(self.nucleus_density * volume))
237
+ times = np.zeros(n)
238
+ else:
239
+ n = int(rng.poisson(self.nucleation_rate * volume * horizon))
240
+ times = np.sort(rng.random(n) * horizon)
241
+ cells = np.stack([rng.integers(0, s, n) for s in sim], axis=1)
242
+ if self.crystal_orientations:
243
+ euler = random_orientations(rng, n)
244
+ if d == 2: # in-plane rotations
245
+ euler[:, 1:] = 0.0
246
+ else:
247
+ euler = None
248
+ grain_phase = (
249
+ np.ones(n, dtype=np.uint8)
250
+ if self.phase_fractions is None
251
+ else rng.choice(
252
+ len(self.phase_fractions),
253
+ size=n,
254
+ p=np.asarray(self.phase_fractions) / np.sum(self.phase_fractions),
255
+ ).astype(np.uint8)
256
+ )
257
+ faceted = self.growth_shape != "sphere" and euler is not None
258
+ labels, arrival, real = grow_grains(
259
+ sim,
260
+ h,
261
+ cells,
262
+ times,
263
+ growth_rate=self.growth_rate,
264
+ growth_shape=self.growth_shape,
265
+ rotations=euler_to_matrix(euler) if faceted else None,
266
+ periodic=True,
267
+ dims=d,
268
+ )
269
+ attributes: dict = {"n_nuclei": n, "n_phantom_nuclei": int(n - real.sum())}
270
+ if self.time is not None:
271
+ labels[arrival >= self.time] = -1 # transformed before the end (level set < 0)
272
+ elif self.coarsening_steps and real.any():
273
+ hist: dict[str, list] = {"step": [], "n_grains": []}
274
+
275
+ def record(step, lab):
276
+ if step % max(1, self.coarsening_steps // 20) == 0 or step == self.coarsening_steps:
277
+ hist["step"].append(step)
278
+ hist["n_grains"].append(int(np.unique(lab).size))
279
+
280
+ labels = potts_coarsening(
281
+ labels,
282
+ self.coarsening_steps,
283
+ temperature=self.coarsening_temperature,
284
+ seed=int(rng.integers(2**31 - 1)),
285
+ dims=d,
286
+ callback=record,
287
+ )
288
+ attributes["coarsening"] = hist
289
+ labels = labels[crop]
290
+ arrival = arrival[crop]
291
+ # grains of the window, numbered in order of nucleation
292
+ present = np.unique(labels[labels >= 0])
293
+ present = present[np.argsort(times[present], kind="stable")]
294
+ relabel = np.full(max(n, 1), -1, dtype=np.int32)
295
+ relabel[present] = np.arange(len(present), dtype=np.int32)
296
+ cell_labels = np.where(labels >= 0, relabel[np.maximum(labels, 0)], -1).astype(np.int32)
297
+ phases = np.where(labels >= 0, grain_phase[np.maximum(labels, 0)], 0).astype(np.uint8)
298
+ field = threshold = None
299
+ if (
300
+ self.time is not None
301
+ and self.phase_fractions is None
302
+ and len(present)
303
+ and np.all(np.isfinite(arrival))
304
+ ):
305
+ # smooth level set: growth distance minus the radius reached at the end
306
+ field = -self.growth_rate * arrival
307
+ threshold = -self.growth_rate * float(self.time)
308
+ finite = arrival[np.isfinite(arrival)]
309
+ t_max = (
310
+ float(self.time)
311
+ if self.time is not None
312
+ else (float(finite.max()) if finite.size else 0.0)
313
+ )
314
+ grid = np.linspace(0.0, t_max, 41)
315
+ attributes["kinetics"] = {
316
+ "time": grid.tolist(),
317
+ "transformed": [float(np.mean(arrival < t)) for t in grid],
318
+ }
319
+ attributes["nucleation_times"] = times[present].tolist()
320
+ record = [
321
+ np.where(arrival < tk, cell_labels, -1).astype(np.int32)
322
+ for tk in np.linspace(0.0, t_max, frames)
323
+ ]
324
+ if record:
325
+ record[-1] = cell_labels.copy() # the realization (after grain growth)
326
+ fields = {
327
+ "phases": phases,
328
+ "labels": cell_labels,
329
+ "orientations": None if euler is None else euler[present],
330
+ "field": field,
331
+ "threshold": 0.0 if threshold is None else threshold,
332
+ "attributes": attributes,
333
+ }
334
+ return fields, record
335
+
336
+
337
+ @register
338
+ @anisotropic
339
+ @dataclass(frozen=True)
340
+ class AggregationModel(_LatticeModel):
341
+ """Aggregates of particles: diffusion-limited, Eden or ballistic growth.
342
+
343
+ Fractal (diffusion-limited), compact (Eden) or porous (ballistic) clusters grown
344
+ from seeds, or deposits grown from a face of the domain.
345
+ """
346
+
347
+ name = "aggregation"
348
+ phases: ClassVar[dict[int, str]] = {0: "pores", 1: "aggregate"}
349
+
350
+ process: str = param(
351
+ "dla",
352
+ doc="dla (diffusion-limited: random walkers), eden (random perimeter cells) or "
353
+ "ballistic (straight trajectories)",
354
+ kind="str",
355
+ )
356
+ geometry: str = param(
357
+ "cluster",
358
+ doc="cluster (growth from seeds) or deposit (growth from the face z = 0, y = 0 in "
359
+ "2D, of a non-periodic domain)",
360
+ kind="str",
361
+ )
362
+ n_seeds: int = param(
363
+ 1, doc="Seeds of clusters in the domain (one: a centred cluster)", kind="int"
364
+ )
365
+ volume_fraction: float | None = param(
366
+ None,
367
+ doc="Fraction of the cells in the aggregate (default: 0.1 for clusters; deposits "
368
+ "grow until they reach the opposite face)",
369
+ kind="fraction",
370
+ )
371
+ sticking: float = param(
372
+ 1.0, doc="Probability of sticking at each contact (dla, ballistic)", kind="fraction"
373
+ )
374
+ anisotropy: Anisotropy | None = param(None, doc=ANISOTROPY, kind="anisotropy", kw_only=True)
375
+
376
+ def _validate(self) -> None:
377
+ self._validate_lattice()
378
+ if self.process not in AGGREGATION_PROCESSES:
379
+ raise ValueError(f"process: one of {AGGREGATION_PROCESSES}")
380
+ if self.geometry not in AGGREGATION_GEOMETRIES:
381
+ raise ValueError(f"geometry: one of {AGGREGATION_GEOMETRIES}")
382
+ if self.n_seeds < 1:
383
+ raise ValueError("n_seeds: at least 1")
384
+ if self.volume_fraction is not None:
385
+ check_fraction(self.volume_fraction, "volume_fraction")
386
+ if not 0.0 < self.sticking <= 1.0:
387
+ raise ValueError("sticking: must lie in (0, 1]")
388
+
389
+ def theory(self, domain: Domain | None = None) -> dict[str, float]:
390
+ d = self.dimension
391
+ dim = DLA_DIMENSION[d] if self.process == "dla" else float(d)
392
+ out = {"fractal_dimension": dim}
393
+ if self.geometry == "cluster":
394
+ out["volume_fraction"] = (
395
+ self.volume_fraction if self.volume_fraction is not None else 0.1
396
+ )
397
+ return out
398
+
399
+ def generate(self, domain: Domain, seed: SeedLike = None) -> LatticeField:
400
+ rng, seed_info = make_rng(seed)
401
+ fields, _ = self._simulate(domain, rng)
402
+ return LatticeField(domain, smoothing=self.smoothing, model=self, seed=seed_info, **fields)
403
+
404
+ def _simulate(self, domain: Domain, rng, frames: int = 0):
405
+ """Fields of the realization, and the aggregate after evenly spaced numbers of
406
+ particles (frames)."""
407
+ deposit = self.geometry == "deposit"
408
+ if deposit and domain.periodic:
409
+ raise ValueError(
410
+ "deposits grow on a face of the domain: use a non-periodic domain (periodic: false)"
411
+ )
412
+ d = self.dimension
413
+ if deposit or self.n_seeds == 1:
414
+ shape, sim, crop = self._window(domain, 0)
415
+ if not domain.periodic:
416
+ sim, crop = shape, (slice(None),) * 3
417
+ else:
418
+ spacing = (domain.volume / self.n_seeds) ** (1.0 / 3.0) / self.cell_size
419
+ shape, sim, crop = self._window(domain, min(MAX_MARGIN, 2.0 * spacing))
420
+ cells = float(np.prod(shape))
421
+ sim_cells = float(np.prod(sim))
422
+ seeds = 1 if self.n_seeds == 1 else max(1, round(self.n_seeds * sim_cells / cells))
423
+ fraction = self.volume_fraction
424
+ if fraction is None and not deposit:
425
+ fraction = 0.1
426
+ if fraction is None:
427
+ n_particles = None
428
+ else:
429
+ n_particles = max(0, round(fraction * sim_cells) - (0 if deposit else seeds))
430
+ occ, owner, order = aggregate(
431
+ sim,
432
+ rng,
433
+ process=self.process,
434
+ geometry=self.geometry,
435
+ n_seeds=seeds,
436
+ n_particles=n_particles,
437
+ sticking=self.sticking,
438
+ dims=d,
439
+ )
440
+ occ, owner, order = occ[crop], owner[crop], order[crop]
441
+ present = np.unique(owner[owner >= 0])
442
+ relabel = np.full(int(owner.max(initial=0)) + 1, -1, dtype=np.int32)
443
+ relabel[present] = np.arange(len(present), dtype=np.int32)
444
+ labels = np.where(owner >= 0, relabel[np.maximum(owner, 0)], -1).astype(np.int32)
445
+ last = int(order.max(initial=0))
446
+ record = [
447
+ ((order >= 0) & (order <= q)).astype(np.uint8) for q in np.linspace(0, last, frames)
448
+ ]
449
+ if record:
450
+ record[-1] = occ.copy()
451
+ fields = {
452
+ "phases": occ,
453
+ "labels": labels,
454
+ "attributes": {
455
+ "n_particles": int(np.count_nonzero(order > 0)),
456
+ "label_kind": "trees" if deposit else "clusters",
457
+ },
458
+ }
459
+ return fields, record