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,289 @@
1
+ """Microstructures from combinatorial design: tile assemblies and random strut lattices.
2
+
3
+ ``tile_assembly``
4
+ Compatible assemblies of building blocks (polarized blocks of combinatorial
5
+ metamaterials, pipe networks) drawn by wave function collapse or uniformly by
6
+ transfer matrices; their voxels form a lattice microstructure.
7
+ ``random_lattice``
8
+ Strut lattices with defects: struts removed at random down to a mean coordination,
9
+ nodes displaced at random; the rigidity of the pin-jointed framework (mechanisms,
10
+ self-stresses, floppy strains) is analysed.
11
+ """
12
+
13
+ from __future__ import annotations
14
+
15
+ from dataclasses import dataclass
16
+ from typing import ClassVar
17
+
18
+ import numpy as np
19
+
20
+ from morphogen._utils import check_fraction, check_positive
21
+ from morphogen.design.csp import sample_uniform, wave_function_collapse
22
+ from morphogen.design.frames import Framework
23
+ from morphogen.design.tiles import TILE_SETS, pipe_tiles, polarized_blocks
24
+ from morphogen.domain import Domain
25
+ from morphogen.models.affine import ANISOTROPY, Anisotropy, anisotropic
26
+ from morphogen.models.base import Model, param, register
27
+ from morphogen.models.foam import FRAME_STIFFNESS, frame_summary
28
+ from morphogen.models.lattice import CELLS
29
+ from morphogen.models.lattice_field import LatticeField, _encode
30
+ from morphogen.models.union import PrimitiveUnion
31
+ from morphogen.primitives import Segments
32
+ from morphogen.seeding import SeedLike, make_rng
33
+
34
+ ASSEMBLY_METHODS = ("wfc", "uniform", "random")
35
+
36
+ #: Mean coordination of the intact lattices.
37
+ PARENT_COORDINATION = {"cubic": 6.0, "bcc": 8.0, "fcc": 6.0, "octet": 12.0}
38
+
39
+ #: Largest framework (nodes) whose rigidity is analysed.
40
+ MAX_RIGIDITY_NODES = 1000
41
+
42
+
43
+ @register
44
+ @dataclass(frozen=True)
45
+ class TileAssembly(Model):
46
+ """Compatible assemblies of building blocks with matching faces.
47
+
48
+ ``polarized`` blocks (combinatorial metamaterials after Coulais et al. 2016) or
49
+ ``pipes`` (networks without dead ends at the tile boundaries).
50
+ """
51
+
52
+ name = "tile_assembly"
53
+ phases: ClassVar[dict[int, str]] = {0: "void", 1: "solid"}
54
+ count_label = "tiles"
55
+
56
+ tiles: str = param("polarized", doc="Tile set: polarized or pipes", kind="str")
57
+ tile_length: float = param(1.0, doc="Edge of a tile", unit="length")
58
+ tile_cells: int = param(8, doc="Lattice cells per tile edge", kind="int")
59
+ dimension: int = param(3, doc="3, or 2 for planar assemblies", kind="int")
60
+ method: str = param(
61
+ "wfc",
62
+ doc="wfc (wave function collapse), uniform (exact uniform sampling, narrow "
63
+ "boxes only) or random (independent tiles, ignoring compatibility)",
64
+ kind="str",
65
+ )
66
+ channel_radius: float = param(
67
+ 0.25, doc="polarized: radius of the channel along the block axis (tile edges)"
68
+ )
69
+ pipe_radius: float = param(0.2, doc="pipes: radius of the pipes (tile edges)")
70
+ open_probability: float = param(
71
+ 0.5, doc="pipes: probability that a face is open", kind="fraction"
72
+ )
73
+ degrees: tuple[float, ...] | None = param(
74
+ None, doc="pipes: allowed numbers of open faces per tile (default: all)", kind="floats"
75
+ )
76
+ boundary: int | None = param(
77
+ None,
78
+ doc="Label the outer faces of non-periodic boxes must match (pipes: 0 closes the network)",
79
+ kind="int",
80
+ )
81
+ smoothing: float = param(
82
+ 0.0, doc="Gaussian smoothing (in cells) of the interface off the lattice", unit="cells"
83
+ )
84
+
85
+ def _validate(self) -> None:
86
+ if self.tiles not in TILE_SETS:
87
+ raise ValueError(f"tiles: one of {list(TILE_SETS)}")
88
+ check_positive(self.tile_length, "tile_length")
89
+ if self.tile_cells < 2:
90
+ raise ValueError("tile_cells: at least 2")
91
+ if self.dimension not in (2, 3):
92
+ raise ValueError("dimension: 2 or 3")
93
+ if self.method not in ASSEMBLY_METHODS:
94
+ raise ValueError(f"method: one of {ASSEMBLY_METHODS}")
95
+ if not 0.0 <= self.channel_radius < 0.5:
96
+ raise ValueError("channel_radius: in [0, 0.5)")
97
+ if not 0.0 < self.pipe_radius < 0.5:
98
+ raise ValueError("pipe_radius: in (0, 0.5)")
99
+ check_fraction(self.open_probability, "open_probability")
100
+ if self.degrees is not None and any(
101
+ d != int(d) or not 0 <= d <= 2 * self.dimension for d in self.degrees
102
+ ):
103
+ raise ValueError(f"degrees: integers from 0 to {2 * self.dimension}")
104
+ check_positive(self.smoothing, "smoothing", allow_zero=True)
105
+
106
+ def tile_set(self):
107
+ if self.tiles == "polarized":
108
+ return polarized_blocks(self.tile_cells, self.channel_radius, self.dimension)
109
+ degrees = None if self.degrees is None else [int(d) for d in self.degrees]
110
+ return pipe_tiles(
111
+ self.tile_cells,
112
+ self.pipe_radius,
113
+ self.dimension,
114
+ open_probability=self.open_probability,
115
+ degrees=degrees,
116
+ )
117
+
118
+ def tile_grid(self, domain: Domain) -> tuple[int, int, int]:
119
+ n = np.maximum(1, np.rint(domain.lengths / self.tile_length)).astype(int)
120
+ if self.dimension == 2:
121
+ n[2] = 1
122
+ return tuple(int(v) for v in n)
123
+
124
+ def expected_count(self, domain: Domain) -> float:
125
+ return float(np.prod(self.tile_grid(domain)))
126
+
127
+ def generate(self, domain: Domain, seed: SeedLike = None) -> LatticeField:
128
+ rng, seed_info = make_rng(seed)
129
+ tiles = self.tile_set()
130
+ shape = self.tile_grid(domain)
131
+ periodic = domain.periodic
132
+ if self.tiles == "polarized" and periodic and any(n % 2 for n in shape[: self.dimension]):
133
+ raise ValueError(
134
+ "polarized blocks alternate along every line: a periodic domain needs an "
135
+ f"even number of tiles along each axis (got {shape[: self.dimension]})"
136
+ )
137
+ if self.method == "wfc":
138
+ assembly = wave_function_collapse(
139
+ tiles, shape, rng, periodic=periodic, boundary=self.boundary
140
+ )
141
+ elif self.method == "uniform":
142
+ if self.boundary is not None:
143
+ raise ValueError("boundary labels are only used by the wfc method")
144
+ assembly = sample_uniform(tiles, shape, rng, periodic=periodic)
145
+ else:
146
+ p = tiles.weights / tiles.weights.sum()
147
+ assembly = rng.choice(tiles.n_tiles, size=shape, p=p)
148
+ voxels = tiles.assemble(assembly)
149
+ return LatticeField(
150
+ domain,
151
+ voxels,
152
+ smoothing=self.smoothing,
153
+ model=self,
154
+ seed=seed_info,
155
+ attributes={
156
+ "tile_grid": list(shape),
157
+ "assembly": _encode(np.asarray(assembly, dtype=np.int16)),
158
+ "tile_names": list(tiles.names),
159
+ "mismatches": tiles.mismatches(assembly, periodic),
160
+ },
161
+ )
162
+
163
+
164
+ @register
165
+ @anisotropic
166
+ @dataclass(frozen=True)
167
+ class RandomLattice(Model):
168
+ """Strut lattices with defects: missing struts and displaced nodes.
169
+
170
+ Struts of a cubic, bcc, fcc or octet lattice are removed at random, down to a mean
171
+ coordination or by a fraction, and nodes are displaced at random. The rigidity of
172
+ the pin-jointed framework tells whether it is stretching-dominated (no floppy
173
+ macroscopic strain; Maxwell's count needs a coordination of at least 6), and with
174
+ ``frame_stiffness`` the stiffness of its frame of beams (rigid joints) is added to the
175
+ summary.
176
+ """
177
+
178
+ name = "random_lattice"
179
+ phases: ClassVar[dict[int, str]] = {0: "void", 1: "struts"}
180
+ count_label = "unit cells"
181
+
182
+ cell: str = param("octet", doc="Parent unit cell: cubic, bcc, fcc or octet", kind="str")
183
+ cell_size: float = param(1.0, doc="Edge of the cubic unit cell", unit="length")
184
+ strut_radius: float = param(0.08, doc="Strut radius", unit="length")
185
+ coordination: float | None = param(
186
+ None,
187
+ doc="Target mean number of struts per node: struts are removed at random, "
188
+ "keeping min_degree struts at every node",
189
+ )
190
+ removal_fraction: float | None = param(
191
+ None,
192
+ doc="Fraction of the struts removed at random (then dangling struts)",
193
+ kind="fraction",
194
+ )
195
+ min_degree: int = param(
196
+ 3, doc="Fewest struts per node when diluting to a coordination", kind="int"
197
+ )
198
+ perturbation: float = param(
199
+ 0.0, doc="Random displacement of the nodes, in cell sizes (uniform in a ball)"
200
+ )
201
+ rigidity: bool = param(
202
+ True,
203
+ doc=f"Analyse the rigidity of the pin-jointed framework (up to {MAX_RIGIDITY_NODES} nodes)",
204
+ kind="bool",
205
+ )
206
+ anisotropy: Anisotropy | None = param(None, doc=ANISOTROPY, kind="anisotropy", kw_only=True)
207
+ frame_stiffness: bool = param(False, doc=FRAME_STIFFNESS, kind="bool", kw_only=True)
208
+
209
+ def _validate(self) -> None:
210
+ if self.cell not in CELLS:
211
+ raise ValueError(f"cell: one of {list(CELLS)}")
212
+ check_positive(self.cell_size, "cell_size")
213
+ check_positive(self.strut_radius, "strut_radius")
214
+ if self.strut_radius >= 0.5 * self.cell_size:
215
+ raise ValueError("strut_radius: smaller than half the cell size")
216
+ if self.coordination is not None and self.removal_fraction is not None:
217
+ raise ValueError("give at most one of 'coordination' and 'removal_fraction'")
218
+ if self.coordination is not None:
219
+ check_positive(self.coordination, "coordination")
220
+ if self.removal_fraction is not None:
221
+ check_fraction(self.removal_fraction, "removal_fraction")
222
+ if self.min_degree < 1:
223
+ raise ValueError("min_degree: at least 1")
224
+ if not 0.0 <= self.perturbation < 0.5:
225
+ raise ValueError("perturbation: in [0, 0.5) cell sizes")
226
+
227
+ def theory(self, domain: Domain | None = None) -> dict[str, float]:
228
+ out = {"parent_coordination": PARENT_COORDINATION[self.cell], "isostatic_coordination": 6.0}
229
+ if self.coordination is not None:
230
+ out["coordination"] = float(self.coordination)
231
+ return out
232
+
233
+ def expected_count(self, domain: Domain) -> float:
234
+ return domain.volume / self.cell_size**3
235
+
236
+ def framework(self, n_cells, rng: np.random.Generator) -> Framework:
237
+ """The random framework of ``n_cells`` unit cells."""
238
+ frame = Framework.lattice(self.cell, n_cells, self.cell_size)
239
+ if self.coordination is not None:
240
+ frame = frame.diluted(rng, coordination=self.coordination, min_degree=self.min_degree)
241
+ elif self.removal_fraction is not None:
242
+ frame = frame.diluted(rng, fraction=self.removal_fraction)
243
+ if self.perturbation > 0:
244
+ frame = frame.perturbed(rng, self.perturbation * self.cell_size)
245
+ return frame
246
+
247
+ def generate(self, domain: Domain, seed: SeedLike = None) -> PrimitiveUnion:
248
+ rng, seed_info = make_rng(seed)
249
+ a = self.cell_size
250
+ ratio = domain.lengths / a
251
+ if domain.periodic:
252
+ if np.any(np.abs(ratio - np.rint(ratio)) > 1e-6 * np.maximum(ratio, 1.0)):
253
+ raise ValueError(
254
+ "random_lattice: a periodic domain must contain a whole number of cells"
255
+ )
256
+ n_cells = np.rint(ratio).astype(int)
257
+ origin = domain.lower
258
+ else: # a window of a larger periodic lattice
259
+ n_cells = np.ceil(ratio).astype(int) + 2
260
+ origin = domain.lower - a
261
+ frame = self.framework(n_cells, rng)
262
+ segments = frame.segments(self.strut_radius, origin)
263
+ if not domain.periodic:
264
+ lo, hi = segments.bounds()
265
+ keep = np.all((hi >= domain.lower) & (lo <= domain.upper), axis=1)
266
+ segments = Segments(
267
+ segments.start[keep], segments.end[keep], segments.radii[keep], round_caps=True
268
+ )
269
+ summary = {
270
+ "n_nodes": frame.n_nodes,
271
+ "n_struts": frame.n_bars,
272
+ "coordination": round(frame.coordination(), 6),
273
+ }
274
+ if self.rigidity and domain.periodic and frame.n_nodes <= MAX_RIGIDITY_NODES:
275
+ r = frame.rigidity()
276
+ summary.update(
277
+ mechanisms=r["mechanisms"],
278
+ self_stresses=r["self_stresses"],
279
+ floppy_strains=r["floppy_strains"],
280
+ )
281
+ if self.frame_stiffness: # the periodic lattice (larger than a window)
282
+ summary.update(frame_summary(frame, self.strut_radius))
283
+ return PrimitiveUnion(
284
+ domain,
285
+ segments=segments,
286
+ model=self,
287
+ seed=seed_info,
288
+ metadata={"summary": summary, "framework": frame.to_dict()},
289
+ )
@@ -0,0 +1,206 @@
1
+ """Polycrystals of measured orientation maps (EBSD).
2
+
3
+ The model ``ebsd`` reads an orientation map (:mod:`morphogen.io.ebsd`: an ``.ang`` or a
4
+ ``.ctf`` file), finds its grains, and gives a window of it as a microstructure: a lattice
5
+ of one cell through the thickness of the domain, each cell with the phase, the label and
6
+ the mean orientation of its grain — a columnar polycrystal whose section is the map, for
7
+ the solvers of the homogenization (crystal elasticity and plasticity turned by the
8
+ orientations of the grains).
9
+
10
+ The window has the size of the domain in the plane of the map: its first rows and
11
+ columns (the top left corner of its image), or a window drawn at random in it for each
12
+ realization (``window: random``) — the realizations of an RVE study are then windows of
13
+ the measured microstructure.
14
+
15
+ The axes of the domain are those of the image of the map: the first to the right, the
16
+ second upwards, the third towards the viewer; the orientations of the file are brought
17
+ into them (``axes: map``; ``setting``: that of the system of an ``.ang`` file; see
18
+ :mod:`morphogen.io.ebsd`).
19
+ """
20
+
21
+ from __future__ import annotations
22
+
23
+ import functools
24
+ import os
25
+ from dataclasses import dataclass
26
+ from typing import ClassVar
27
+
28
+ import numpy as np
29
+
30
+ from morphogen._utils import check_positive
31
+ from morphogen.domain import Domain
32
+ from morphogen.models.base import Model, param, register
33
+ from morphogen.models.lattice_field import LatticeField
34
+ from morphogen.orientations import euler_to_matrix
35
+ from morphogen.seeding import SeedLike, make_rng
36
+
37
+ #: Where the window of a realization is taken in the map
38
+ WINDOWS = ("origin", "random")
39
+
40
+
41
+ @functools.lru_cache(maxsize=4)
42
+ def _grains_of(path: str, modified: float, threshold: float, min_size: int, axes: str,
43
+ setting: int, turn: tuple | None): # fmt: skip
44
+ """The grains of the map of a file (kept for the realizations that follow)."""
45
+ from morphogen.io.ebsd import read_ebsd
46
+
47
+ ebsd = read_ebsd(path, axes=axes, setting=setting)
48
+ if turn is not None:
49
+ ebsd = ebsd.turned(euler_to_matrix(np.array(turn))[0])
50
+ return ebsd.grains(threshold, min_size=min_size)
51
+
52
+
53
+ @register
54
+ @dataclass(frozen=True)
55
+ class EBSD(Model):
56
+ """Polycrystal of a measured orientation map (EBSD): the grains of the map, with
57
+ their orientations, in a window of the size of the domain."""
58
+
59
+ name = "ebsd"
60
+ phases: ClassVar[dict[int, str]] = {1: "crystals"}
61
+ supports_periodic: ClassVar[bool] = False
62
+ has_level_set: ClassVar[bool] = False
63
+ count_label = "grains"
64
+ #: The grains carry orientations (those of the map)
65
+ crystal_orientations: ClassVar[bool] = True
66
+ #: The parameters that are files: a configuration file gives them from its folder
67
+ path_parameters: ClassVar[tuple[str, ...]] = ("file",)
68
+
69
+ file: str = param(
70
+ doc="Orientation map: an .ang (EDAX/TSL) or a .ctf (Oxford Instruments/HKL) file "
71
+ "(from the folder of the configuration file), or the name of a map that comes "
72
+ "with morphoGen (ebsd_map.ctf)",
73
+ kind="str",
74
+ )
75
+ threshold: float = param(
76
+ 5.0,
77
+ doc="Disorientation below which two neighbouring points belong to one grain",
78
+ unit="degrees",
79
+ )
80
+ min_size: int = param(
81
+ 5,
82
+ doc="Grains of fewer points are dropped: their points, and those that were not "
83
+ "indexed, take the grain of the nearest point",
84
+ kind="int",
85
+ )
86
+ window: str = param(
87
+ "origin",
88
+ doc="origin (the window of the size of the domain at the first rows and columns "
89
+ "of the map: the top left corner of its image) or random (a window drawn in the "
90
+ "map for each realization)",
91
+ kind="str",
92
+ )
93
+ axes: str = param(
94
+ "map",
95
+ doc="map (the orientations of the file are brought into the axes of the image of "
96
+ "the map, those of the domain: the first to the right, the second upwards, the "
97
+ "third towards the viewer) or file (they are taken as the file gives them)",
98
+ kind="str",
99
+ )
100
+ setting: int = param(
101
+ 1,
102
+ doc="Setting of the axes of the orientations of an .ang file: their first axis "
103
+ "points down the image (1, the usual one), up (2), to the right (3) or to the "
104
+ "left (4)",
105
+ kind="int",
106
+ )
107
+ turn: tuple[float, ...] | None = param(
108
+ None,
109
+ doc="Bunge angles (degrees) of other axes of the sample in those of the "
110
+ "orientations: the orientations are brought into these axes (another setting "
111
+ "of the system)",
112
+ kind="floats",
113
+ )
114
+
115
+ def _validate(self) -> None:
116
+ if not self.file:
117
+ raise ValueError("file: the orientation map (.ang or .ctf)")
118
+ if not 0.0 < self.threshold < 180.0:
119
+ raise ValueError("threshold: an angle between 0 and 180 degrees")
120
+ if self.min_size < 1:
121
+ raise ValueError("min_size: a positive number of points")
122
+ if self.window not in WINDOWS:
123
+ raise ValueError(f"window: one of {WINDOWS}")
124
+ if self.axes not in ("map", "file"):
125
+ raise ValueError("axes: map or file")
126
+ if self.setting not in (1, 2, 3, 4):
127
+ raise ValueError("setting: 1, 2, 3 or 4")
128
+ if self.turn is not None and len(self.turn) != 3:
129
+ raise ValueError("turn: three Bunge angles (degrees)")
130
+
131
+ def path(self) -> str:
132
+ """The file of the map: ``file``, or the map of its name that comes with
133
+ morphoGen where there is no such file."""
134
+ from morphogen.io.ebsd import example_map
135
+
136
+ path = os.path.abspath(os.path.expanduser(self.file))
137
+ if not os.path.isfile(path):
138
+ try:
139
+ path = str(example_map(os.path.basename(path)))
140
+ except ValueError:
141
+ raise ValueError(f"file: no orientation map at {self.file!r}") from None
142
+ return path
143
+
144
+ def grains(self):
145
+ """The grains of the whole map (:class:`morphogen.io.ebsd.Grains`)."""
146
+ path = self.path()
147
+ turn = None if self.turn is None else tuple(float(v) for v in self.turn)
148
+ return _grains_of(path, os.path.getmtime(path), float(self.threshold),
149
+ int(self.min_size), self.axes, int(self.setting), turn) # fmt: skip
150
+
151
+ def active_phases(self) -> dict[int, str]:
152
+ grains = self.grains()
153
+ return {k: (p.name or f"phase {k}") for k, p in enumerate(grains.phases, start=1)
154
+ if np.any(grains.phase == k)} # fmt: skip
155
+
156
+ def _window(self, domain: Domain) -> tuple[int, int]:
157
+ """The numbers of columns and rows of the window of a domain in the map."""
158
+ grains = self.grains()
159
+ ny, nx = grains.labels.shape
160
+ check_positive(domain.size[0], "domain.size")
161
+ columns = max(1, round(domain.size[0] / grains.step[0]))
162
+ rows = max(1, round(domain.size[1] / grains.step[1]))
163
+ if columns > nx or rows > ny:
164
+ width, height = nx * grains.step[0], ny * grains.step[1]
165
+ raise ValueError(
166
+ f"domain: {domain.size[0]:g} x {domain.size[1]:g} is larger than the map "
167
+ f"({width:g} x {height:g} {grains.unit})"
168
+ )
169
+ return columns, rows
170
+
171
+ def generate(self, domain: Domain, seed: SeedLike = None) -> LatticeField:
172
+ if domain.periodic:
173
+ raise ValueError("ebsd: a window of a map is not periodic (domain.periodic: false)")
174
+ rng, seed_info = make_rng(seed)
175
+ grains = self.grains()
176
+ ny, nx = grains.labels.shape
177
+ columns, rows = self._window(domain)
178
+ x0 = int(rng.integers(nx - columns + 1)) if self.window == "random" else 0
179
+ y0 = int(rng.integers(ny - rows + 1)) if self.window == "random" else 0
180
+ part = grains.labels[y0 : y0 + rows, x0 : x0 + columns]
181
+ present, inverse = np.unique(part[part >= 0], return_inverse=True)
182
+ labels = np.full(part.shape, -1, dtype=np.int32)
183
+ labels[part >= 0] = inverse
184
+ # (the rows of the map from the top; the second axis of the domain upwards)
185
+ cells = np.ascontiguousarray(labels[::-1].T[:, :, None])
186
+ phase = grains.phase[present]
187
+ phases = np.where(cells >= 0, phase[np.maximum(cells, 0)], 0).astype(np.uint8)
188
+ attributes = {
189
+ "file": os.path.basename(self.file),
190
+ "window": [x0, y0, columns, rows],
191
+ "step": list(grains.step),
192
+ "grain_phase": phase.tolist(),
193
+ "grain_spread": grains.spread[present].tolist(),
194
+ }
195
+ return LatticeField(domain, phases, labels=cells,
196
+ orientations=grains.orientations[present], attributes=attributes,
197
+ model=self, seed=seed_info) # fmt: skip
198
+
199
+ def expected_count(self, domain: Domain) -> float | None:
200
+ grains = self.grains()
201
+ ny, nx = grains.labels.shape
202
+ columns, rows = self._window(domain)
203
+ return grains.count * (columns * rows) / (nx * ny)
204
+
205
+
206
+ __all__ = ["EBSD", "WINDOWS"]