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,226 @@
1
+ """Transient diffusion in voxel images: moisture, oxygen, solvents.
2
+
3
+ The activity ``u`` of the mobile species (relative humidity, oxygen pressure over its
4
+ value outside) is continuous across interfaces; each phase holds the concentration
5
+ ``c = S u`` (``S`` its solubility, the concentration at equilibrium with the outside)
6
+ and lets it through with the permeability ``P = D S`` (``D`` its diffusivity):
7
+
8
+ S du/dt = div(P grad u) - k S u
9
+
10
+ (``k`` an optional first-order consumption). Finite volumes on the voxels: the flux
11
+ between two neighbours goes through the harmonic mean of their permeabilities (exact
12
+ for layers in series), the exposed faces hold ``u`` (a value or a function of time)
13
+ half a voxel from the centres of their voxels, the other faces are impermeable or, in
14
+ periodic images, periodic; implicit Euler steps. The analytic solutions of a slab
15
+ (Crank 1975, eq. 4.17 and 4.18) check it.
16
+ """
17
+
18
+ from __future__ import annotations
19
+
20
+ from collections.abc import Callable
21
+ from dataclasses import dataclass
22
+
23
+ import numpy as np
24
+ from scipy import sparse
25
+ from scipy.sparse import linalg as splinalg
26
+
27
+ from morphogen.analysis.basic import as_array
28
+ from morphogen.image import VoxelImage
29
+
30
+ FACES = ("x-", "x+", "y-", "y+", "z-", "z+")
31
+ #: Voxels up to which the steps are solved by sparse LU (one factorization per time step
32
+ #: length); preconditioned conjugate gradients beyond.
33
+ DIRECT_LIMIT = 4096
34
+
35
+
36
+ @dataclass
37
+ class DiffusionResult:
38
+ """Concentrations ``c = S u`` at the requested ``times`` and the uptake: the mean
39
+ concentration over the image at each time, and at equilibrium (``saturation``)."""
40
+
41
+ times: np.ndarray
42
+ fields: list[np.ndarray]
43
+ uptake: np.ndarray
44
+ saturation: float
45
+
46
+ @property
47
+ def relative_uptake(self) -> np.ndarray:
48
+ """``M(t) / M_inf``."""
49
+ return (
50
+ self.uptake / self.saturation if self.saturation else np.full_like(self.uptake, np.nan)
51
+ )
52
+
53
+
54
+ def _per_phase(labels: np.ndarray, values, name: str, default=None) -> np.ndarray:
55
+ phases = np.unique(labels)
56
+ if values is None:
57
+ if default is None:
58
+ raise ValueError(f"{name}: one value per phase")
59
+ values = dict.fromkeys(phases.tolist(), default)
60
+ elif np.isscalar(values):
61
+ values = dict.fromkeys(phases.tolist(), float(values))
62
+ missing = [int(p) for p in phases if int(p) not in values]
63
+ if missing:
64
+ raise ValueError(f"{name}: no value for the phases {missing}")
65
+ table = np.zeros(int(phases.max()) + 1)
66
+ for p, v in values.items():
67
+ if int(p) <= phases.max():
68
+ table[int(p)] = float(v)
69
+ if np.any(table[phases] < 0):
70
+ raise ValueError(f"{name}: non-negative values")
71
+ return table[labels]
72
+
73
+
74
+ def _harmonic(a, b):
75
+ s = a + b
76
+ return np.divide(2.0 * a * b, s, out=np.zeros_like(s), where=s > 0)
77
+
78
+
79
+ def _operator(perm, spacing, periodic_axes, exposed):
80
+ """Conductance matrix K (SPD) and the conductances g of the exposed faces."""
81
+ shape = perm.shape
82
+ n = perm.size
83
+ index = np.arange(n).reshape(shape)
84
+ rows, cols, vals = [], [], []
85
+ diag = np.zeros(n)
86
+ boundary = np.zeros(n)
87
+ for axis in range(3):
88
+ h = spacing[axis]
89
+ area = np.prod([spacing[a] for a in range(3) if a != axis])
90
+ if shape[axis] > 1 or axis in periodic_axes:
91
+ a = perm
92
+ b = np.roll(perm, -1, axis=axis)
93
+ g = _harmonic(a, b) * area / h
94
+ i = index
95
+ j = np.roll(index, -1, axis=axis)
96
+ if axis not in periodic_axes: # no link across the last face
97
+ sl = [slice(None)] * 3
98
+ sl[axis] = slice(0, shape[axis] - 1)
99
+ g, i, j = g[tuple(sl)], i[tuple(sl)], j[tuple(sl)]
100
+ if shape[axis] == 1 and axis in periodic_axes:
101
+ g = np.zeros_like(g) # a voxel and itself
102
+ g, i, j = g.ravel(), i.ravel(), j.ravel()
103
+ rows += [i, j]
104
+ cols += [j, i]
105
+ vals += [-g, -g]
106
+ np.add.at(diag, i, g)
107
+ np.add.at(diag, j, g)
108
+ for side, face in ((0, f"{'xyz'[axis]}-"), (-1, f"{'xyz'[axis]}+")):
109
+ if face in exposed:
110
+ sl = [slice(None)] * 3
111
+ sl[axis] = side
112
+ cells = index[tuple(sl)].ravel()
113
+ np.add.at(boundary, cells, perm.ravel()[cells] * area / (0.5 * h))
114
+ if vals:
115
+ data, ij = np.concatenate(vals), (np.concatenate(rows), np.concatenate(cols))
116
+ else:
117
+ data, ij = np.zeros(0), (np.zeros(0, int), np.zeros(0, int))
118
+ k = sparse.csr_matrix((data, ij), shape=(n, n))
119
+ k = k + sparse.diags(diag + boundary)
120
+ return k.tocsc(), boundary
121
+
122
+
123
+ def transient_diffusion(
124
+ image,
125
+ diffusivity,
126
+ times,
127
+ *,
128
+ solubility=None,
129
+ exposed=("x-", "x+"),
130
+ boundary: float | Callable[[float], float] = 1.0,
131
+ initial: float = 0.0,
132
+ consumption=None,
133
+ steps: int = 40,
134
+ periodic=None,
135
+ ) -> DiffusionResult:
136
+ """Diffusion of a species into the phases of ``image`` from its ``exposed`` faces,
137
+ held at the activity ``boundary`` (a number or a function of time), from a uniform
138
+ initial activity ``initial``.
139
+
140
+ ``diffusivity``, ``solubility`` (default 1) and ``consumption`` (first-order rate,
141
+ default 0): one number, or a mapping phase -> value. ``times``: the output times,
142
+ each interval split into ``steps`` implicit Euler steps (the first one into steps
143
+ growing geometrically, for the sqrt(t) start). Axes without exposed faces are
144
+ periodic in periodic images, impermeable otherwise.
145
+ """
146
+ labels = np.asarray(as_array(image)).astype(np.int64)
147
+ spacing = np.asarray(image.spacing if isinstance(image, VoxelImage) else (1.0, 1.0, 1.0), float)
148
+ per = (
149
+ bool(image.periodic)
150
+ if periodic is None and isinstance(image, VoxelImage)
151
+ else bool(periodic)
152
+ )
153
+ exposed = tuple(exposed)
154
+ for face in exposed:
155
+ if face not in FACES:
156
+ raise ValueError(f"exposed: faces among {', '.join(FACES)}")
157
+ d = _per_phase(labels, diffusivity, "diffusivity")
158
+ s = _per_phase(labels, solubility, "solubility", default=1.0)
159
+ k = _per_phase(labels, consumption, "consumption", default=0.0)
160
+ axes_exposed = {FACES.index(f) // 2 for f in exposed}
161
+ periodic_axes = {a for a in range(3) if per and a not in axes_exposed}
162
+ voxel = float(np.prod(spacing))
163
+ cap = (s * voxel).ravel()
164
+ big_k, g = _operator(d * s, spacing, periodic_axes, exposed)
165
+ big_k = big_k + sparse.diags((k * s).ravel() * voxel)
166
+ value = boundary if callable(boundary) else (lambda t, b=float(boundary): b)
167
+ times = np.asarray(times, dtype=float)
168
+ if np.any(np.diff(times) <= 0) or times[0] < 0:
169
+ raise ValueError("times: increasing and non-negative")
170
+ u = np.full(labels.size, float(initial))
171
+ t = 0.0
172
+ fields, uptake = [], []
173
+ cache: dict[float, object] = {}
174
+ for t_out in times:
175
+ span = t_out - t
176
+ if span > 0:
177
+ if t == 0.0: # geometric steps from about span / 10^4
178
+ r = 1.25
179
+ first = span * (r - 1.0) / (r**steps - 1.0)
180
+ dts = first * r ** np.arange(steps)
181
+ else:
182
+ dts = np.full(steps, span / steps)
183
+ for dt in dts:
184
+ key = float(dt)
185
+ if key not in cache:
186
+ a = (sparse.diags(cap / dt) + big_k).tocsc()
187
+ cache.clear()
188
+ cache[key] = splinalg.splu(a) if labels.size <= DIRECT_LIMIT else a
189
+ solver = cache[key]
190
+ t += dt
191
+ rhs = cap / dt * u + g * value(t)
192
+ if isinstance(solver, splinalg.SuperLU):
193
+ u = solver.solve(rhs)
194
+ else:
195
+ diag = solver.diagonal()
196
+ pre = splinalg.LinearOperator(solver.shape, matvec=lambda x, dg=diag: x / dg)
197
+ u, info = splinalg.cg(solver, rhs, x0=u, rtol=1e-11, maxiter=5000, M=pre)
198
+ if info:
199
+ raise RuntimeError(
200
+ "transient_diffusion: conjugate gradients did not converge"
201
+ )
202
+ t = float(t_out)
203
+ c = (s.ravel() * u).reshape(labels.shape)
204
+ fields.append(c)
205
+ uptake.append(float(c.mean()))
206
+ saturation = float(s.mean()) * float(value(times[-1]))
207
+ return DiffusionResult(times, fields, np.asarray(uptake), saturation)
208
+
209
+
210
+ def slab_uptake(t, thickness: float, diffusivity: float, terms: int = 400) -> np.ndarray:
211
+ """``M(t) / M_inf`` of a slab exposed on both faces (Crank 1975, eq. 4.18):
212
+ ``1 - sum 8 / ((2n + 1)^2 pi^2) exp(-D (2n + 1)^2 pi^2 t / L^2)``."""
213
+ t = np.asarray(t, dtype=float)
214
+ m = 2 * np.arange(terms) + 1
215
+ e = np.exp(-diffusivity * (m * np.pi / thickness) ** 2 * t[..., None])
216
+ return 1.0 - np.sum(8.0 / (m * np.pi) ** 2 * e, axis=-1)
217
+
218
+
219
+ def slab_profile(z, t: float, thickness: float, diffusivity: float, terms: int = 400) -> np.ndarray:
220
+ """``c / c_s`` at the distance ``z`` from the middle of the slab (Crank 1975, eq. 4.17)."""
221
+ z = np.asarray(z, dtype=float)
222
+ n = np.arange(terms)
223
+ m = 2 * n + 1
224
+ e = np.exp(-diffusivity * (m * np.pi / thickness) ** 2 * t)
225
+ series = np.sum((-1.0) ** n / m * e * np.cos(m * np.pi * z[..., None] / thickness), axis=-1)
226
+ return 1.0 - 4.0 / np.pi * series