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,345 @@
1
+ """Microstructures defined cell by cell on a regular lattice.
2
+
3
+ Cellular automata and lattice growth processes (nucleation and growth, aggregation)
4
+ produce a phase per cell, and sometimes a label per cell (grains). Such a realization
5
+ is resolution-independent like the other microstructures:
6
+
7
+ * on its own lattice, it voxelizes to its cells exactly;
8
+ * elsewhere, the indicator of phase 1 (or a continuous field, such as a concentration,
9
+ when the process has one) is interpolated trilinearly, after an optional Gaussian
10
+ smoothing of ``smoothing`` cells, and thresholded; labels are taken from the nearest
11
+ cell;
12
+ * its level set is smooth across the interface, so that conforming meshes (MMG)
13
+ follow the cells' boundaries, rounded at the corners.
14
+ """
15
+
16
+ from __future__ import annotations
17
+
18
+ import base64
19
+ import math
20
+ import zlib
21
+
22
+ import numpy as np
23
+ from numba import njit, prange
24
+ from scipy import ndimage
25
+
26
+ from morphogen.domain import Domain, Grid
27
+ from morphogen.image import VoxelImage
28
+ from morphogen.models.base import Microstructure, register_kind
29
+
30
+
31
+ @njit(parallel=True, cache=True)
32
+ def _trilinear(field, lower, h, points, periodic, out):
33
+ """Trilinear interpolation of a cell-centred field at points."""
34
+ nx, ny, nz = field.shape
35
+ n = (nx, ny, nz)
36
+ for p in prange(points.shape[0]):
37
+ idx0 = np.empty(3, dtype=np.int64)
38
+ idx1 = np.empty(3, dtype=np.int64)
39
+ t = np.empty(3)
40
+ for a in range(3):
41
+ u = (points[p, a] - lower[a]) / h[a] - 0.5
42
+ i0 = math.floor(u)
43
+ ta = u - i0
44
+ i1 = i0 + 1
45
+ if periodic:
46
+ i0 %= n[a]
47
+ i1 %= n[a]
48
+ else:
49
+ if i0 < 0:
50
+ i0 = 0
51
+ ta = 0.0
52
+ if i1 > n[a] - 1:
53
+ i1 = n[a] - 1
54
+ if i0 > n[a] - 1:
55
+ i0 = n[a] - 1
56
+ if i1 < 0:
57
+ i1 = 0
58
+ idx0[a] = i0
59
+ idx1[a] = i1
60
+ t[a] = ta
61
+ v = 0.0
62
+ for c in range(8):
63
+ w = 1.0
64
+ ii = idx1[0] if c & 1 else idx0[0]
65
+ w *= t[0] if c & 1 else 1.0 - t[0]
66
+ jj = idx1[1] if c & 2 else idx0[1]
67
+ w *= t[1] if c & 2 else 1.0 - t[1]
68
+ kk = idx1[2] if c & 4 else idx0[2]
69
+ w *= t[2] if c & 4 else 1.0 - t[2]
70
+ v += w * field[ii, jj, kk]
71
+ out[p] = v
72
+
73
+
74
+ def _encode(arr: np.ndarray) -> dict:
75
+ a = np.ascontiguousarray(arr)
76
+ return {
77
+ "dtype": a.dtype.str,
78
+ "shape": list(a.shape),
79
+ "data": base64.b64encode(zlib.compress(a.tobytes(), 6)).decode("ascii"),
80
+ }
81
+
82
+
83
+ def _decode(spec: dict) -> np.ndarray:
84
+ raw = zlib.decompress(base64.b64decode(spec["data"]))
85
+ return np.frombuffer(raw, dtype=np.dtype(spec["dtype"])).reshape(spec["shape"]).copy()
86
+
87
+
88
+ @register_kind
89
+ class LatticeField(Microstructure):
90
+ """A phase (and optionally a label) per cell of a regular lattice of the domain.
91
+
92
+ Parameters
93
+ ----------
94
+ phases
95
+ ``uint8`` array ``(nx, ny, nz)`` (``nz = 1`` for 2D structures, extruded
96
+ through the thickness of the domain).
97
+ labels
98
+ Optional ``int32`` array of the same shape: grain index per cell (``-1``:
99
+ none, e.g. untransformed matrix).
100
+ orientations
101
+ Optional crystal orientations of the labels (Bunge Euler angles, degrees).
102
+ smoothing
103
+ Gaussian smoothing, in cells, of the indicator of phase 1 before interpolation
104
+ (0: plain trilinear interpolation, which keeps one-cell features).
105
+ field, threshold
106
+ Optional continuous field per cell (e.g. a concentration) whose excursion
107
+ ``field > threshold`` is phase 1: it is interpolated instead of the indicator,
108
+ which gives smoother interfaces.
109
+ attributes
110
+ Per-label arrays (e.g. nucleation times) and other JSON-able data.
111
+ """
112
+
113
+ kind = "lattice_field"
114
+
115
+ def __init__(
116
+ self,
117
+ domain: Domain,
118
+ phases,
119
+ *,
120
+ labels=None,
121
+ orientations=None,
122
+ smoothing: float = 0.0,
123
+ field=None,
124
+ threshold: float = 0.0,
125
+ attributes: dict | None = None,
126
+ **kwargs,
127
+ ) -> None:
128
+ super().__init__(domain, **kwargs)
129
+ self.phases = np.ascontiguousarray(phases, dtype=np.uint8)
130
+ if self.phases.ndim != 3:
131
+ raise ValueError("phases: expected a 3D array (nx, ny, nz)")
132
+ self.cell_labels = None if labels is None else np.ascontiguousarray(labels, dtype=np.int32)
133
+ if self.cell_labels is not None and self.cell_labels.shape != self.phases.shape:
134
+ raise ValueError("labels: same shape as phases")
135
+ self.orientations = (
136
+ None if orientations is None else np.asarray(orientations, dtype=float).reshape(-1, 3)
137
+ )
138
+ self.smoothing = float(smoothing)
139
+ if self.smoothing < 0:
140
+ raise ValueError("smoothing: must be non-negative")
141
+ self.field = None if field is None else np.ascontiguousarray(field, dtype=np.float32)
142
+ if self.field is not None and self.field.shape != self.phases.shape:
143
+ raise ValueError("field: same shape as phases")
144
+ self.threshold = float(threshold)
145
+ self.attributes = dict(attributes or {})
146
+ self._smoothed = None
147
+
148
+ # -- lattice -----------------------------------------------------------------------
149
+
150
+ @property
151
+ def shape(self) -> tuple[int, int, int]:
152
+ return tuple(int(n) for n in self.phases.shape)
153
+
154
+ @property
155
+ def lattice(self) -> Grid:
156
+ return Grid(self.domain, self.shape)
157
+
158
+ @property
159
+ def cell_size(self) -> np.ndarray:
160
+ return self.lattice.spacing
161
+
162
+ @property
163
+ def binary(self) -> bool:
164
+ return bool(self.phases.max(initial=0) <= 1)
165
+
166
+ @property
167
+ def has_labels(self) -> bool:
168
+ return self.cell_labels is not None
169
+
170
+ def _level_cells(self) -> np.ndarray:
171
+ """Cell values of the level set: negative in phase 1."""
172
+ if self._smoothed is None:
173
+ if self.field is not None:
174
+ lev = self.threshold - self.field.astype(np.float64)
175
+ else:
176
+ lev = (self.phases == 1).astype(np.float64)
177
+ if self.smoothing > 0:
178
+ sigma = [self.smoothing if n > 1 else 0.0 for n in self.shape]
179
+ mode = "wrap" if self.domain.periodic else "nearest"
180
+ lev = ndimage.gaussian_filter(lev, sigma, mode=mode)
181
+ if self.field is None:
182
+ scale = float(np.mean(self.cell_size)) * max(
183
+ 1.0, math.sqrt(2 * math.pi) * self.smoothing
184
+ )
185
+ lev = (0.5 - lev) * scale # about the signed distance near the interface
186
+ self._smoothed = np.ascontiguousarray(lev)
187
+ return self._smoothed
188
+
189
+ @property
190
+ def lipschitz(self) -> float:
191
+ """The largest slope of the trilinear interpolant of the lattice values."""
192
+ lev = self._level_cells()
193
+ slopes = []
194
+ for a in range(3):
195
+ if lev.shape[a] > 1:
196
+ d = np.abs(np.diff(lev, axis=a))
197
+ slopes.append(float(d.max()) / float(self.cell_size[a]))
198
+ return float(np.sqrt(np.sum(np.square(slopes)))) if slopes else 1.0
199
+
200
+ def level_set_at(self, points, reach: float = np.inf) -> np.ndarray:
201
+ """:meth:`level_at`: the level set of the lattice interpolated at the points."""
202
+ return self.level_at(points)
203
+
204
+ def level_at(self, points) -> np.ndarray:
205
+ """Interpolated level set at points (negative in phase 1)."""
206
+ pts = np.ascontiguousarray(np.asarray(points, dtype=float).reshape(-1, 3))
207
+ out = np.empty(len(pts))
208
+ _trilinear(
209
+ self._level_cells(), self.domain.lower, self.cell_size, pts, self.domain.periodic, out
210
+ )
211
+ return out
212
+
213
+ def _nearest(self, points) -> tuple[np.ndarray, ...]:
214
+ pts = np.asarray(points, dtype=float).reshape(-1, 3)
215
+ u = (pts - self.domain.lower) / self.cell_size
216
+ idx = np.floor(u).astype(np.int64)
217
+ n = np.array(self.shape)
218
+ if self.domain.periodic:
219
+ idx %= n
220
+ else:
221
+ idx = np.clip(idx, 0, n - 1)
222
+ return idx[:, 0], idx[:, 1], idx[:, 2]
223
+
224
+ def _on_lattice(self, grid: Grid) -> bool:
225
+ return tuple(grid.shape) == self.shape and grid.domain == self.domain
226
+
227
+ def _sample(self, grid: Grid, values_of) -> np.ndarray:
228
+ """Evaluate ``values_of(points)`` slab by slab on the voxel centres of ``grid``."""
229
+ nx, ny, nz = grid.shape
230
+ out = None
231
+ step = max(1, (1 << 21) // max(1, nx * ny))
232
+ for k0 in range(0, nz, step):
233
+ k1 = min(nz, k0 + step)
234
+ vals = values_of(grid.center_points(k0, k1))
235
+ if out is None:
236
+ out = np.empty(grid.shape, dtype=vals.dtype)
237
+ out[:, :, k0:k1] = vals.reshape(nx, ny, k1 - k0)
238
+ return out
239
+
240
+ # -- discretization ----------------------------------------------------------------
241
+
242
+ def voxelize(self, shape=None, *, voxel_size=None, grid: Grid | None = None, supersampling=1):
243
+ if shape is None and voxel_size is None and grid is None:
244
+ grid = self.lattice
245
+ grid = self.grid(shape, voxel_size=voxel_size, grid=grid)
246
+ ss = int(supersampling)
247
+ if not 1 <= ss <= 6:
248
+ raise ValueError("supersampling must be an integer between 1 and 6")
249
+ meta = self.image_metadata()
250
+ if ss == 1 and self._on_lattice(grid):
251
+ return VoxelImage.from_grid(self.phases.copy(), grid, name="phase", metadata=meta)
252
+ if not self.binary:
253
+ if ss > 1:
254
+ raise ValueError("partial volumes are defined for two-phase structures")
255
+ data = self._sample(grid, lambda p: self.phases[self._nearest(p)])
256
+ return VoxelImage.from_grid(data, grid, name="phase", metadata=meta)
257
+ if ss == 1:
258
+ data = self._sample(grid, lambda p: (self.level_at(p) < 0).astype(np.uint8))
259
+ return VoxelImage.from_grid(data, grid, name="phase", metadata=meta)
260
+ fine = Grid(grid.domain, tuple(n * ss for n in grid.shape))
261
+ inside = self._sample(fine, lambda p: (self.level_at(p) < 0).astype(np.float32))
262
+ nx, ny, nz = grid.shape
263
+ data = inside.reshape(nx, ss, ny, ss, nz, ss).mean(axis=(1, 3, 5), dtype=np.float32)
264
+ return VoxelImage.from_grid(data, grid, name="fraction", metadata=meta)
265
+
266
+ def level_set(self, shape=None, *, voxel_size=None, grid: Grid | None = None) -> VoxelImage:
267
+ """Interpolated level set, negative in phase 1: ``threshold - field`` for
268
+ structures with a continuous field, otherwise ``(1/2 - indicator) * scale``,
269
+ about the signed distance to the interface near it (``scale`` is the cell size,
270
+ times ``sqrt(2 pi)`` times the smoothing when it exceeds one cell)."""
271
+ if not self.binary:
272
+ raise NotImplementedError("level sets are defined for two-phase structures")
273
+ if shape is None and voxel_size is None and grid is None:
274
+ grid = self.lattice
275
+ grid = self.grid(shape, voxel_size=voxel_size, grid=grid)
276
+ data = self._sample(grid, lambda p: self.level_at(p).astype(np.float32))
277
+ return VoxelImage.from_grid(data, grid, name="level_set", metadata=self.image_metadata())
278
+
279
+ def contains(self, points) -> np.ndarray:
280
+ if self.binary:
281
+ return self.level_at(points) < 0
282
+ return self.phases[self._nearest(points)] == 1
283
+
284
+ def labels(self, shape=None, *, voxel_size=None, grid: Grid | None = None) -> VoxelImage:
285
+ """Image of the cell labels (int32 grain indices; -1: no grain), sampled from
286
+ the nearest cell."""
287
+ if self.cell_labels is None:
288
+ raise ValueError("this structure has no labels")
289
+ if shape is None and voxel_size is None and grid is None:
290
+ grid = self.lattice
291
+ grid = self.grid(shape, voxel_size=voxel_size, grid=grid)
292
+ if self._on_lattice(grid):
293
+ data = self.cell_labels.copy()
294
+ else:
295
+ data = self._sample(grid, lambda p: self.cell_labels[self._nearest(p)])
296
+ return VoxelImage.from_grid(data, grid, name="cell", metadata=self.image_metadata())
297
+
298
+ # -- description ---------------------------------------------------------------------
299
+
300
+ def summary(self) -> dict:
301
+ out = {"lattice": "x".join(str(n) for n in self.shape)}
302
+ if self.cell_labels is not None:
303
+ labels = self.cell_labels
304
+ kind = self.attributes.get("label_kind", "grains")
305
+ out[f"n_{kind}"] = int(np.unique(labels[labels >= 0]).size)
306
+ for key in ("steps", "n_particles"):
307
+ if key in self.attributes:
308
+ out[key] = self.attributes[key]
309
+ return out
310
+
311
+ def _geometry(self) -> dict:
312
+ geo = {"phases": _encode(self.phases), "smoothing": self.smoothing}
313
+ if self.field is not None:
314
+ geo["field"] = _encode(self.field)
315
+ geo["threshold"] = self.threshold
316
+ if self.cell_labels is not None:
317
+ geo["labels"] = _encode(self.cell_labels)
318
+ if self.orientations is not None:
319
+ geo["orientations"] = self.orientations.tolist()
320
+ if self.attributes:
321
+ geo["attributes"] = self.attributes
322
+ return geo
323
+
324
+ @classmethod
325
+ def _from_geometry(cls, domain, geometry, **kwargs):
326
+ return cls(
327
+ domain,
328
+ _decode(geometry["phases"]),
329
+ labels=_decode(geometry["labels"]) if "labels" in geometry else None,
330
+ orientations=geometry.get("orientations"),
331
+ smoothing=geometry.get("smoothing", 0.0),
332
+ field=_decode(geometry["field"]) if "field" in geometry else None,
333
+ threshold=geometry.get("threshold", 0.0),
334
+ attributes=geometry.get("attributes"),
335
+ **kwargs,
336
+ )
337
+
338
+
339
+ def lattice_shape(domain: Domain, cell_size: float, dimension: int = 3) -> tuple[int, int, int]:
340
+ """Number of cells of edge about ``cell_size`` along each axis of the domain
341
+ (one cell through the thickness for 2D structures)."""
342
+ n = np.maximum(1, np.rint(domain.lengths / float(cell_size))).astype(int)
343
+ if dimension == 2:
344
+ n[2] = 1
345
+ return tuple(int(v) for v in n)