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,203 @@
1
+ """Stochastic reconstruction of two-phase microstructures from their statistical
2
+ descriptors (Yeong & Torquato 1998).
3
+
4
+ A realization is a periodic lattice of cells of edge ``cell_size`` covering the domain
5
+ (a :class:`~morphogen.models.lattice_field.LatticeField`), annealed from random cells of
6
+ the volume fraction (:mod:`morphogen.kernels.annealing`): the two-point probability
7
+ ``S_2`` of phase 1 along the axes of the lattice, and its lineal-path function ``L``
8
+ with the weight ``lineal_path``, approach their targets, those of
9
+
10
+ * a Debye random medium (``correlation_length`` ``a``, Debye, Anderson & Brumberger
11
+ 1957): ``S_2(r) = p^2 + p (1 - p) e^{-r/a}``, specific surface ``4 p (1 - p) / a``;
12
+ * a realization of another model (``reference``) on the same lattice, periodic;
13
+ * a phase image (``image``: a file), its descriptors measured at its own voxels and
14
+ interpolated at the lags of the lattice (``p^2`` and 0 beyond its half size).
15
+
16
+ ``S_2`` alone does not determine a microstructure: two microstructures with the same
17
+ ``S_2`` can differ in their connectivity, which ``L`` (and the chords) retains in part.
18
+ """
19
+
20
+ from __future__ import annotations
21
+
22
+ import dataclasses
23
+ import math
24
+ from dataclasses import dataclass
25
+ from typing import ClassVar
26
+
27
+ import numpy as np
28
+
29
+ from morphogen._utils import check_fraction, check_positive
30
+ from morphogen.domain import Domain, Grid
31
+ from morphogen.kernels.annealing import anneal
32
+ from morphogen.models.base import Model, param, register
33
+ from morphogen.models.lattice_field import LatticeField, lattice_shape
34
+ from morphogen.seeding import SeedLike, make_rng
35
+
36
+
37
+ def _measured(image, rmax: int, lags: np.ndarray, n_axes: int):
38
+ """``S_2`` and ``L`` of phase 1 of an image at the physical ``lags`` of each axis (rows),
39
+ interpolated from its own lags, and its volume fraction."""
40
+ from morphogen.analysis.correlation import lineal_path
41
+ from morphogen.analysis.covariance import covariance
42
+
43
+ cov = covariance(image, 1)
44
+ lp = lineal_path(image, 1)
45
+ p = cov.volume_fraction
46
+ s = np.full((3, rmax + 1), p * p)
47
+ line = np.zeros((3, rmax + 1))
48
+ for a, name in enumerate("xyz"[:n_axes]):
49
+ s[a] = np.interp(lags[a], cov.lags[name], cov.values[name], right=p * p)
50
+ line[a] = np.interp(lags[a], lp.lags[name], lp.values[name], right=0.0)
51
+ return s, line, p
52
+
53
+
54
+ @register
55
+ @dataclass(frozen=True)
56
+ class Reconstruction(Model):
57
+ """Two-phase microstructure annealed to the two-point probability (and the lineal-path
58
+ function) of a Debye medium, of a model or of an image (Yeong & Torquato 1998)."""
59
+
60
+ name = "reconstruction"
61
+ phases: ClassVar[dict[int, str]] = {0: "phase 0", 1: "phase 1"}
62
+
63
+ reference: Model | None = param(
64
+ None, doc="A model whose realization on the lattice gives the targets", kind="model"
65
+ )
66
+ image: str | None = param(
67
+ None, doc="A phase image (file) whose phase 1 gives the targets", kind="str"
68
+ )
69
+ correlation_length: float | None = param(
70
+ None,
71
+ doc="Debye random medium: S2(r) = p^2 + p (1 - p) exp(-r / a)",
72
+ unit="length",
73
+ )
74
+ volume_fraction: float | None = param(
75
+ None, doc="Fraction of phase 1 of the Debye medium", kind="fraction"
76
+ )
77
+ lineal_path: float = param(
78
+ 0.0, doc="Weight of the lineal-path function in the energy (0: S2 alone)"
79
+ )
80
+ max_lag: int | None = param(
81
+ None,
82
+ doc="Largest lag of the descriptors, in cells (default: a quarter of the lattice, "
83
+ "at most 32)",
84
+ kind="int",
85
+ )
86
+ sweeps: int = param(100, doc="Trial swaps per cell", kind="int")
87
+ cooling: float = param(
88
+ 0.98, doc="Factor of the temperature after every tenth of a sweep", kind="fraction"
89
+ )
90
+ tolerance: float = param(1e-10, doc="Energy at which the annealing stops")
91
+ cell_size: float = param(1.0, doc="Edge of the cells of the lattice", unit="length")
92
+ dimension: int = param(
93
+ 3, doc="3, or 2 for planar structures (one cell through the thickness)", kind="int"
94
+ )
95
+ smoothing: float = param(
96
+ 0.0,
97
+ doc="Gaussian smoothing (in cells) of the interface for other resolutions and "
98
+ "conforming meshes (0: trilinear interpolation of the cells)",
99
+ unit="cells",
100
+ )
101
+
102
+ def _validate(self) -> None:
103
+ given = [k for k in ("reference", "image", "correlation_length")
104
+ if getattr(self, k) is not None] # fmt: skip
105
+ if len(given) != 1:
106
+ raise ValueError(
107
+ "give one target: reference (a model), image (a file) or correlation_length "
108
+ "(a Debye medium)"
109
+ )
110
+ if self.correlation_length is not None:
111
+ check_positive(self.correlation_length, "correlation_length")
112
+ if self.volume_fraction is None:
113
+ raise ValueError("volume_fraction: the fraction of phase 1 of the Debye medium")
114
+ check_fraction(self.volume_fraction, "volume_fraction")
115
+ if self.lineal_path:
116
+ raise ValueError("lineal_path: unknown for a Debye medium (give a reference)")
117
+ elif self.volume_fraction is not None:
118
+ raise ValueError("volume_fraction: that of the reference or of the image")
119
+ check_positive(self.lineal_path, "lineal_path", allow_zero=True)
120
+ if self.max_lag is not None and self.max_lag < 1:
121
+ raise ValueError("max_lag: a positive number of cells")
122
+ if self.sweeps < 1:
123
+ raise ValueError("sweeps: a positive number of swaps per cell")
124
+ if not 0.0 < self.cooling <= 1.0:
125
+ raise ValueError("cooling: a factor in (0, 1]")
126
+ check_positive(self.tolerance, "tolerance", allow_zero=True)
127
+ check_positive(self.cell_size, "cell_size")
128
+ if self.dimension not in (2, 3):
129
+ raise ValueError("dimension: 2 or 3")
130
+ check_positive(self.smoothing, "smoothing", allow_zero=True)
131
+
132
+ def _lattice(self, domain: Domain) -> tuple[Grid, int, int]:
133
+ """The periodic lattice of the domain, its axes and the largest lag."""
134
+ shape = lattice_shape(domain, self.cell_size, self.dimension)
135
+ n_axes = 3 if self.dimension == 3 else 2
136
+ if self.max_lag is not None:
137
+ rmax = int(self.max_lag)
138
+ else:
139
+ rmax = min(32, max(1, min(shape[:n_axes]) // 4))
140
+ if rmax > min(shape[:n_axes]) // 2:
141
+ raise ValueError(f"max_lag: at most half the lattice ({min(shape[:n_axes]) // 2})")
142
+ return Grid(dataclasses.replace(domain, periodic=True), shape), n_axes, rmax
143
+
144
+ def targets(self, domain: Domain, seed: SeedLike = None):
145
+ """The target ``S_2`` and ``L`` along the axes (rows, lags 0..max_lag) and the
146
+ volume fraction, on the lattice of the domain."""
147
+ rng, _ = make_rng(seed)
148
+ return self._targets(domain, rng)
149
+
150
+ def _targets(self, domain: Domain, rng):
151
+ lattice, n_axes, rmax = self._lattice(domain)
152
+ lags = np.arange(rmax + 1)[None, :] * np.asarray(lattice.spacing, dtype=float)[:, None]
153
+ if self.correlation_length is not None:
154
+ p = float(self.volume_fraction)
155
+ s = p * p + p * (1.0 - p) * np.exp(-lags / self.correlation_length)
156
+ return s, np.zeros_like(s), p
157
+ if self.reference is not None:
158
+ ref = self.reference.generate(lattice.domain, seed=rng)
159
+ image = ref.voxelize(grid=lattice)
160
+ else:
161
+ from morphogen import io
162
+
163
+ image = io.load_image(self.image)
164
+ s, line, p = _measured(image, rmax, lags, n_axes)
165
+ return s, line, p
166
+
167
+ def generate(self, domain: Domain, seed: SeedLike = None) -> LatticeField:
168
+ rng, seed_info = make_rng(seed)
169
+ lattice, n_axes, rmax = self._lattice(domain)
170
+ target_s, target_l, p = self._targets(domain, rng)
171
+ cells = int(np.prod(lattice.shape))
172
+ img = np.zeros(cells, dtype=np.uint8)
173
+ img[rng.permutation(cells)[: round(p * cells)]] = 1
174
+ img = img.reshape(lattice.shape)
175
+ stage = max(1, cells // 10)
176
+ initial, energy, trials, accepted = anneal(
177
+ img,
178
+ np.ascontiguousarray(target_s),
179
+ np.ascontiguousarray(target_l),
180
+ float(self.lineal_path),
181
+ n_axes,
182
+ rmax,
183
+ int(self.sweeps) * cells,
184
+ float(self.cooling),
185
+ stage,
186
+ float(self.tolerance),
187
+ int(rng.integers(2**31 - 1)),
188
+ )
189
+ attributes = {"initial_energy": float(initial), "energy": float(energy),
190
+ "trials": int(trials), "accepted": int(accepted),
191
+ "max_lag": rmax} # fmt: skip
192
+ return LatticeField(domain, img, smoothing=self.smoothing, attributes=attributes,
193
+ model=self, seed=seed_info) # fmt: skip
194
+
195
+ def theory(self, domain: Domain | None = None) -> dict[str, float]:
196
+ if self.correlation_length is not None:
197
+ p, a = float(self.volume_fraction), float(self.correlation_length)
198
+ return {"volume_fraction": p, "specific_surface": 4.0 * p * (1.0 - p) / a,
199
+ "integral_range": 8.0 * math.pi * a**3} # fmt: skip
200
+ if self.reference is not None:
201
+ ref = self.reference.theory(domain)
202
+ return {k: ref[k] for k in ("volume_fraction",) if k in ref}
203
+ return {}