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,384 @@
1
+ """Affine anisotropy of morphological models.
2
+
3
+ A model given an ``anisotropy`` generates the image by the linear map ``x = A y`` of a
4
+ realization of its isotropic version: ``A = g^T diag(s) g`` stretches by ``s`` along
5
+ principal axes, the rows of the Bunge rotation ``g`` of the angles ``euler`` (degrees, the
6
+ convention of :func:`morphogen.orientations.euler_to_matrix`). The stretches are normalized
7
+ to a unit product, so that ``A`` preserves volumes: volume fractions, numbers of objects
8
+ per unit volume, object volumes, integral ranges, Euler densities and other topological
9
+ numbers keep their values and meaning, and only shapes change. A sphere of radius ``r``
10
+ becomes an ellipsoid of semi-axes ``s_i r`` (and of the same volume), a hard-core packing
11
+ of spheres a hard-core packing of aligned ellipsoids, a Voronoi or Laguerre tessellation
12
+ the tessellation computed in the stretched space and mapped back (cells elongated along
13
+ the axes of the largest stretches), an excursion of a Gaussian field the excursion of a
14
+ field of covariance ``rho(|A^-1 h|)``. The mean intercept length along a unit direction
15
+ ``d`` becomes ``MIL_iso / |A^-1 d|``: its fabric tensor (:func:`morphogen.analysis.
16
+ fabric_tensor`) has the principal axes of ``A`` and principal MILs in the ratios of ``s``.
17
+
18
+ Configuration, the same for every model::
19
+
20
+ anisotropy: {stretch: [1, 1, 2], euler: [0, 0, 0]} # elongated twice as much along z
21
+ anisotropy: [1, 1, 2] # the same: 3 stretches, or 6
22
+ # numbers with the Euler angles
23
+ anisotropy: 2 # an elongation 2 along z
24
+
25
+ Periodicity. The image of a periodic box by ``A`` is periodic in the same box only when
26
+ ``A`` is diagonal in the axes of the box: principal axes along the box axes (Euler angles
27
+ multiples of 90 degrees, or turning about the axis of two equal stretches). The isotropic
28
+ model is then generated in the box of edges ``L_i / t_i`` (``t = diag A``), periodic like
29
+ the domain, and its voxel images on the grid of the same shape are those of the
30
+ anisotropic structure (an exact map of grids). Other principal axes need a non-periodic
31
+ domain (an error otherwise): the isotropic model is generated in the bounding box of the
32
+ preimage of the domain (numbers of cells or objects then refer to that box). Two-phase
33
+ structures are voxelized exactly, by point queries at the preimages of the voxel centres;
34
+ labels, several phases and level sets by sampling at those preimages a grid of that box of
35
+ spacing the voxel size over the largest stretch (nearest voxel; trilinear for level sets
36
+ and partial volume fractions: interfaces within half a voxel). Models that apply the
37
+ metric themselves (the Gaussian field) accept any rotation in periodic boxes.
38
+ """
39
+
40
+ from __future__ import annotations
41
+
42
+ import dataclasses
43
+ import functools
44
+ import itertools
45
+ import math
46
+ import re
47
+
48
+ import numpy as np
49
+ from scipy import ndimage
50
+
51
+ from morphogen.domain import Domain, Grid
52
+ from morphogen.image import VoxelImage
53
+ from morphogen.models.base import Microstructure, register_kind
54
+ from morphogen.orientations import euler_to_matrix
55
+
56
+ #: Relative size of the off-diagonal entries of ``A`` below which its principal axes are
57
+ #: taken along the box axes.
58
+ ALIGNED = 1e-12
59
+
60
+
61
+ @dataclasses.dataclass(frozen=True)
62
+ class Anisotropy:
63
+ """Stretches ``stretch`` along the principal axes turned by the Bunge angles ``euler``
64
+ (degrees); ``elongation``: the number it was given as (an elongation along z)."""
65
+
66
+ stretch: tuple[float, float, float] = (1.0, 1.0, 1.0)
67
+ euler: tuple[float, float, float] = (0.0, 0.0, 0.0)
68
+ elongation: float | None = None
69
+
70
+ def __post_init__(self) -> None:
71
+ s = tuple(float(v) for v in np.ravel(self.stretch))
72
+ e = tuple(float(v) for v in np.ravel(self.euler))
73
+ if len(s) != 3 or not all(math.isfinite(v) and v > 0.0 for v in s):
74
+ raise ValueError(f"anisotropy: stretch: three positive numbers, got {self.stretch}")
75
+ if len(e) != 3 or not all(math.isfinite(v) for v in e):
76
+ raise ValueError(f"anisotropy: euler: three Bunge angles (degrees), got {self.euler}")
77
+ object.__setattr__(self, "stretch", s)
78
+ object.__setattr__(self, "euler", e)
79
+
80
+ @property
81
+ def principal(self) -> np.ndarray:
82
+ """The stretches normalized to a unit product (a map preserving volumes)."""
83
+ s = np.asarray(self.stretch)
84
+ return s / math.prod(self.stretch) ** (1.0 / 3.0)
85
+
86
+ @property
87
+ def axes(self) -> np.ndarray:
88
+ """The principal axes (columns) in the axes of the sample."""
89
+ return euler_to_matrix(self.euler)[0].T
90
+
91
+ @property
92
+ def matrix(self) -> np.ndarray:
93
+ """``A = g^T diag(s) g``: the image of a point ``y`` of the isotropic structure."""
94
+ g = euler_to_matrix(self.euler)[0]
95
+ return g.T @ np.diag(self.principal) @ g
96
+
97
+ @property
98
+ def is_identity(self) -> bool:
99
+ return bool(np.all(np.abs(self.principal - 1.0) <= 1e-12))
100
+
101
+ def box_stretch(self) -> np.ndarray | None:
102
+ """The stretches ``t`` along x, y and z when ``A`` is diagonal in the box axes, else
103
+ None."""
104
+ a = self.matrix
105
+ if np.abs(a - np.diag(np.diag(a))).max() > ALIGNED * np.abs(a).max():
106
+ return None
107
+ if not np.any(self.euler):
108
+ return self.principal # the exact diagonal
109
+ return np.diag(a).copy()
110
+
111
+ def to_config(self):
112
+ if self.elongation is not None:
113
+ return self.elongation
114
+ out: dict = {"stretch": list(self.stretch)}
115
+ if any(self.euler):
116
+ out["euler"] = list(self.euler)
117
+ return out
118
+
119
+
120
+ def anisotropy_from_config(value, name: str = "anisotropy") -> Anisotropy | None:
121
+ """An :class:`Anisotropy` from a configuration value: None (isotropic), a mapping with
122
+ ``stretch`` and ``euler``, a list of 3 stretches or of 6 numbers (stretches, then
123
+ angles), or a number (an elongation along z)."""
124
+ if value is None or isinstance(value, Anisotropy):
125
+ return value
126
+ try:
127
+ if isinstance(value, bool):
128
+ raise TypeError("expected numbers")
129
+ if isinstance(value, (int, float)):
130
+ return Anisotropy(stretch=(1.0, 1.0, float(value)), elongation=float(value))
131
+ if isinstance(value, dict):
132
+ unknown = sorted(set(value) - {"stretch", "euler"})
133
+ if unknown:
134
+ raise ValueError(f"unknown keys {unknown} (stretch, euler)")
135
+ return Anisotropy(
136
+ stretch=value.get("stretch", (1.0, 1.0, 1.0)),
137
+ euler=value.get("euler", (0.0, 0.0, 0.0)),
138
+ )
139
+ numbers = [float(v) for v in value]
140
+ if len(numbers) not in (3, 6):
141
+ raise ValueError("3 stretches, or 3 stretches and 3 Euler angles")
142
+ return Anisotropy(stretch=numbers[:3], euler=numbers[3:] or (0.0, 0.0, 0.0))
143
+ except (TypeError, ValueError) as exc:
144
+ raise ValueError(
145
+ f"{name}: expected a mapping {{stretch: [sx, sy, sz], euler: [phi1, Phi, phi2]}}, "
146
+ f"3 or 6 numbers, or an elongation along z, got {value!r} ({exc})"
147
+ ) from None
148
+
149
+
150
+ #: The documentation of the ``anisotropy`` field of the models that accept it (declared
151
+ #: ``param(None, doc=ANISOTROPY, kind="anisotropy", kw_only=True)``; None: isotropic).
152
+ ANISOTROPY = (
153
+ "Affine anisotropy: stretches along principal axes turned by Bunge angles, "
154
+ "{stretch: [sx, sy, sz], euler: [phi1, Phi, phi2]} (degrees), or 3 or 6 numbers, or an "
155
+ "elongation along z; normalized to preserve volumes; periodic boxes: principal axes "
156
+ "along the box axes (none: isotropic)"
157
+ )
158
+
159
+
160
+ #: Theoretical characteristics changed by a map preserving volumes (lengths, areas and
161
+ #: curvatures); volumes, fractions, numbers per unit volume and topological numbers stay.
162
+ _NOT_INVARIANT = re.compile(r"surface|curvature|radius|length|chord|thickness|diameter|size")
163
+
164
+
165
+ def invariant_theory(values: dict[str, float]) -> dict[str, float]:
166
+ """The characteristics of :meth:`Model.theory` that a volume-preserving map keeps."""
167
+ return {k: v for k, v in values.items() if not _NOT_INVARIANT.search(k)}
168
+
169
+
170
+ def _corners(domain: Domain) -> np.ndarray:
171
+ lo, hi = domain.lower, domain.upper
172
+ return np.array([np.where(c, hi, lo) for c in itertools.product((0, 1), repeat=3)])
173
+
174
+
175
+ def _preimage_box(domain: Domain, t: np.ndarray) -> Domain:
176
+ """The box mapped onto ``domain`` by ``diag(t)``, periodic like it."""
177
+ return Domain(
178
+ size=tuple(domain.lengths / t),
179
+ origin=tuple(domain.lower / t),
180
+ periodic=domain.periodic,
181
+ unit=domain.unit,
182
+ )
183
+
184
+
185
+ def reference_domain(anisotropy: Anisotropy, domain: Domain, name: str = "model") -> Domain:
186
+ """The domain where the isotropic model is generated (see the module)."""
187
+ t = anisotropy.box_stretch()
188
+ if t is not None:
189
+ return _preimage_box(domain, t)
190
+ if domain.periodic:
191
+ raise ValueError(
192
+ f"{name}: anisotropy: principal axes other than the box axes break the "
193
+ "periodicity of the box; use a non-periodic domain (periodic: false), or Euler "
194
+ "angles that keep the principal axes along the box axes (multiples of 90 degrees)"
195
+ )
196
+ y = _corners(domain) @ np.linalg.inv(anisotropy.matrix).T
197
+ lo, hi = y.min(axis=0), y.max(axis=0)
198
+ return Domain(size=tuple(hi - lo), origin=tuple(lo), periodic=False, unit=domain.unit)
199
+
200
+
201
+ def anisotropic(cls):
202
+ """Class decorator of a model with an ``anisotropy`` field: its realizations are those
203
+ of its isotropic version, generated in the preimage of the domain and mapped
204
+ (:class:`AffineStructure`), and its theoretical characteristics those the map keeps.
205
+ Without anisotropy the model is unchanged."""
206
+ generate, theory = cls.generate, cls.theory
207
+
208
+ @functools.wraps(generate)
209
+ def generate_mapped(self, domain, seed=None):
210
+ a = self.anisotropy
211
+ if a is None or a.is_identity:
212
+ return generate(self, domain, seed)
213
+ self._check_domain(domain)
214
+ iso = dataclasses.replace(self, anisotropy=None)
215
+ ref = reference_domain(a, domain, self.name)
216
+ try:
217
+ inner = generate(iso, ref, seed)
218
+ except ValueError as exc:
219
+ lengths = ", ".join(f"{v:.6g}" for v in ref.lengths)
220
+ raise ValueError(
221
+ f"{exc} (in the box of edges {lengths}, the preimage of the domain by the "
222
+ "anisotropy, where the isotropic model is generated)"
223
+ ) from None
224
+ return AffineStructure(
225
+ domain, inner, a, model=self, seed=inner.seed, metadata=dict(inner.metadata)
226
+ )
227
+
228
+ @functools.wraps(theory)
229
+ def theory_mapped(self, domain=None):
230
+ a = self.anisotropy
231
+ if a is None or a.is_identity:
232
+ return theory(self, domain)
233
+ iso = dataclasses.replace(self, anisotropy=None)
234
+ if domain is None or (domain.periodic and a.box_stretch() is None):
235
+ ref = None # (no realization in such a domain)
236
+ else:
237
+ ref = reference_domain(a, domain, self.name)
238
+ return invariant_theory(theory(iso, ref))
239
+
240
+ cls.generate, cls.theory = generate_mapped, theory_mapped
241
+ return cls
242
+
243
+
244
+ @register_kind
245
+ class AffineStructure(Microstructure):
246
+ """The image by ``x = A y`` (:class:`Anisotropy`) of a realization ``inner`` of the
247
+ isotropic model, generated in the preimage of ``domain``."""
248
+
249
+ kind = "affine"
250
+
251
+ #: Attributes of the inner realization that do not depend on positions (data of its
252
+ #: cells and grains), forwarded.
253
+ FORWARDED = ("orientations", "cell_phases")
254
+
255
+ def __init__(self, domain: Domain, inner: Microstructure, anisotropy: Anisotropy, **kwargs):
256
+ super().__init__(domain, **kwargs)
257
+ self.inner = inner
258
+ self.anisotropy = anisotropy
259
+ self.matrix = anisotropy.matrix
260
+ self.box_stretch = anisotropy.box_stretch()
261
+
262
+ def __getattr__(self, name):
263
+ if name in AffineStructure.FORWARDED and "inner" in self.__dict__:
264
+ return getattr(self.inner, name)
265
+ raise AttributeError(f"{type(self).__name__} has no attribute {name!r}")
266
+
267
+ @property
268
+ def has_labels(self) -> bool:
269
+ return self.inner.has_labels
270
+
271
+ def summary(self) -> dict:
272
+ return self.inner.summary()
273
+
274
+ # -- discretization ------------------------------------------------------------
275
+ def _image(self, method: str, grid: Grid, order: int, **kwargs) -> VoxelImage:
276
+ """``inner.<method>`` on the preimage of ``grid``, as an image of ``grid``."""
277
+ if self.box_stretch is not None:
278
+ ref = Grid(_preimage_box(grid.domain, self.box_stretch), grid.shape)
279
+ image = getattr(self.inner, method)(grid=ref, **kwargs)
280
+ data = image.data
281
+ else:
282
+ box = self.inner.domain
283
+ h = float(np.min(grid.spacing)) / float(self.anisotropy.principal.max())
284
+ ref = Grid.for_domain(box, voxel_size=np.minimum(h, box.lengths))
285
+ image = getattr(self.inner, method)(grid=ref, **kwargs)
286
+ inverse = np.linalg.inv(self.matrix)
287
+ nx, ny, nz = grid.shape
288
+ data = np.empty(grid.shape, dtype=image.data.dtype)
289
+ k_step = max(1, 2**21 // (nx * ny))
290
+ for k0 in range(0, nz, k_step):
291
+ k1 = min(nz, k0 + k_step)
292
+ y = grid.center_points(k0, k1) @ inverse.T
293
+ index = (y - ref.origin) / ref.spacing - 0.5
294
+ values = ndimage.map_coordinates(image.data, index.T, order=order, mode="nearest")
295
+ data[:, :, k0:k1] = values.reshape(nx, ny, k1 - k0)
296
+ return VoxelImage.from_grid(data, grid, name=image.name, metadata=self.image_metadata())
297
+
298
+ def _exact(self, grid: Grid, supersampling: int) -> VoxelImage:
299
+ """Phases 0 and 1 by point queries at the preimages of the voxel centres (and of
300
+ ``supersampling**3`` sub-voxel points)."""
301
+ ss = int(supersampling)
302
+ if not 1 <= ss <= 6:
303
+ raise ValueError("supersampling must be an integer between 1 and 6")
304
+ fine = grid if ss == 1 else Grid(grid.domain, tuple(n * ss for n in grid.shape))
305
+ inverse = np.linalg.inv(self.matrix)
306
+ nx, ny, nz = fine.shape
307
+ inside = np.empty(fine.shape, dtype=bool)
308
+ k_step = max(1, 2**20 // (nx * ny))
309
+ for k0 in range(0, nz, k_step):
310
+ k1 = min(nz, k0 + k_step)
311
+ y = fine.center_points(k0, k1) @ inverse.T
312
+ inside[:, :, k0:k1] = self.inner.contains(y).reshape(nx, ny, k1 - k0)
313
+ if ss == 1:
314
+ data, name = inside.astype(np.uint8), "phase"
315
+ else:
316
+ n = grid.shape
317
+ data = inside.reshape(n[0], ss, n[1], ss, n[2], ss).mean(
318
+ axis=(1, 3, 5), dtype=np.float32
319
+ )
320
+ name = "fraction"
321
+ return VoxelImage.from_grid(data, grid, name=name, metadata=self.image_metadata())
322
+
323
+ def voxelize(
324
+ self, shape=None, *, voxel_size=None, grid: Grid | None = None, supersampling: int = 1
325
+ ) -> VoxelImage:
326
+ grid = self.grid(shape, voxel_size=voxel_size, grid=grid)
327
+ two_phases = self.model is not None and set(self.model.active_phases()) <= {0, 1}
328
+ if self.box_stretch is None and two_phases and not self.inner.has_labels:
329
+ try:
330
+ return self._exact(grid, supersampling)
331
+ except NotImplementedError:
332
+ pass
333
+ order = 0 if int(supersampling) == 1 else 1
334
+ return self._image("voxelize", grid, order, supersampling=supersampling)
335
+
336
+ def labels(self, shape=None, *, voxel_size=None, grid: Grid | None = None) -> VoxelImage:
337
+ return self._image("labels", self.grid(shape, voxel_size=voxel_size, grid=grid), 0)
338
+
339
+ def level_set(self, shape=None, *, voxel_size=None, grid: Grid | None = None) -> VoxelImage:
340
+ """The level set of the inner realization at the preimages (its zero set is the
341
+ boundary; its values are distances in the isotropic space)."""
342
+ return self._image("level_set", self.grid(shape, voxel_size=voxel_size, grid=grid), 1)
343
+
344
+ def implicit_phases(self) -> list[int]:
345
+ return self.inner.implicit_phases()
346
+
347
+ def phase_level_set(
348
+ self, phase: int, shape=None, *, voxel_size=None, grid: Grid | None = None
349
+ ) -> VoxelImage:
350
+ """The implicit function of a phase of the inner realization at the preimages."""
351
+ grid = self.grid(shape, voxel_size=voxel_size, grid=grid)
352
+ return self._image("phase_level_set", grid, 1, phase=int(phase))
353
+
354
+ def contains(self, points) -> np.ndarray:
355
+ y = np.asarray(points, dtype=float).reshape(-1, 3) @ np.linalg.inv(self.matrix).T
356
+ return self.inner.contains(y)
357
+
358
+ @property
359
+ def lipschitz(self) -> float:
360
+ """That of the inner realization, times the largest stretch of the inverse map."""
361
+ stretch = float(np.linalg.norm(np.linalg.inv(self.matrix), 2))
362
+ return float(getattr(self.inner, "lipschitz", 1.0)) * stretch
363
+
364
+ def level_set_at(self, points, reach: float = np.inf) -> np.ndarray:
365
+ """The level set of the inner realization at the preimages of the points (its zero
366
+ set is the boundary; distances of the isotropic space, within the stretch ratios of
367
+ those of the mapped one)."""
368
+ y = np.asarray(points, dtype=float).reshape(-1, 3) @ np.linalg.inv(self.matrix).T
369
+ return self.inner.level_set_at(y, reach)
370
+
371
+ def phase_level_sets_at(self, points, reach: float = np.inf) -> dict[int, np.ndarray]:
372
+ """The functions of the phases of the inner realization at the preimages of the
373
+ points (:meth:`phase_level_set` at any point)."""
374
+ y = np.asarray(points, dtype=float).reshape(-1, 3) @ np.linalg.inv(self.matrix).T
375
+ return self.inner.phase_level_sets_at(y, reach)
376
+
377
+ # -- serialization -------------------------------------------------------------
378
+ def _geometry(self) -> dict:
379
+ return {"anisotropy": self.anisotropy.to_config(), "inner": self.inner.to_dict()}
380
+
381
+ @classmethod
382
+ def _from_geometry(cls, domain, geometry, **kwargs):
383
+ inner = Microstructure.from_dict(geometry["inner"])
384
+ return cls(domain, inner, anisotropy_from_config(geometry["anisotropy"]), **kwargs)