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,500 @@
1
+ """Base classes of morphological models and of their realizations (microstructures).
2
+
3
+ A :class:`Model` holds the parameters of a random set (or of a deterministic
4
+ architecture). ``model.generate(domain, seed)`` returns a :class:`Microstructure`, the
5
+ explicit ("vector") description of one realization, which can be voxelized at any
6
+ resolution, queried point-wise, turned into level-set fields and exported.
7
+ """
8
+
9
+ from __future__ import annotations
10
+
11
+ import dataclasses
12
+ from abc import ABC, abstractmethod
13
+ from typing import Any, ClassVar
14
+
15
+ import numpy as np
16
+
17
+ from morphogen._utils import to_jsonable
18
+ from morphogen._version import __version__
19
+ from morphogen.distributions import Distribution, distribution_from_config
20
+ from morphogen.domain import Domain, Grid
21
+ from morphogen.image import VoxelImage
22
+ from morphogen.orientations import OrientationDistribution, orientation_from_config
23
+ from morphogen.seeding import SeedLike
24
+
25
+ # ----------------------------------------------------------------------------------
26
+ # Parameters
27
+
28
+
29
+ def param(
30
+ default=dataclasses.MISSING,
31
+ *,
32
+ doc: str,
33
+ kind: str = "float",
34
+ unit: str = "",
35
+ kw_only: bool = False,
36
+ ):
37
+ """Dataclass field carrying the metadata used by configs, the CLI and the GUI.
38
+
39
+ ``kind`` is one of: float, int, bool, str, fraction, distribution, distributions (a
40
+ list of them), orientation, vector, floats, ints, json (nested lists), model (a model
41
+ given as a mapping with a ``type`` key), models (a list of them), anisotropy (an
42
+ affine anisotropy, :mod:`morphogen.models.affine`).
43
+ """
44
+ metadata = {"doc": doc, "kind": kind, "unit": unit}
45
+ if kw_only: # after the positional parameters of the subclasses too
46
+ return dataclasses.field(default=default, metadata=metadata, kw_only=True)
47
+ return dataclasses.field(default=default, metadata=metadata)
48
+
49
+
50
+ def _int(value) -> int:
51
+ if isinstance(value, bool) or int(value) != value:
52
+ raise TypeError
53
+ return int(value)
54
+
55
+
56
+ def _convert(kind: str, value: Any, name: str):
57
+ if value is None:
58
+ return None
59
+ if kind == "models": # errors of the nested models keep their own messages
60
+ if isinstance(value, (dict, Model)):
61
+ raise ValueError(f"{name}: expected a list of models")
62
+ return tuple(v if isinstance(v, Model) else model_from_config(v) for v in value)
63
+ if kind == "json": # nested lists of numbers or strings, kept as tuples
64
+
65
+ def frozen(v):
66
+ return tuple(frozen(x) for x in v) if isinstance(v, (list, tuple)) else v
67
+
68
+ return frozen(value)
69
+ if kind == "model":
70
+ if isinstance(value, Model):
71
+ return value
72
+ if not isinstance(value, dict):
73
+ raise ValueError(f"{name}: expected a model (a mapping with a 'type' key)")
74
+ return model_from_config(value)
75
+ if kind == "distributions":
76
+ if isinstance(value, (dict, str, int, float, Distribution)):
77
+ raise ValueError(f"{name}: expected a list of distributions (numbers or mappings)")
78
+ return tuple(distribution_from_config(v, f"{name}[{k}]") for k, v in enumerate(value))
79
+ try:
80
+ if kind == "distribution":
81
+ return distribution_from_config(value, name)
82
+ if kind == "orientation":
83
+ return orientation_from_config(value, name)
84
+ if kind == "anisotropy":
85
+ from morphogen.models.affine import anisotropy_from_config
86
+
87
+ return anisotropy_from_config(value, name)
88
+ if kind in ("float", "fraction"):
89
+ if isinstance(value, bool):
90
+ raise TypeError
91
+ return float(value)
92
+ if kind == "int":
93
+ return _int(value)
94
+ if kind == "ints":
95
+ return tuple(_int(v) for v in value)
96
+ if kind == "bool":
97
+ if not isinstance(value, bool):
98
+ raise TypeError
99
+ return value
100
+ if kind == "str":
101
+ return str(value)
102
+ if kind == "vector":
103
+ if np.ndim(value) == 0:
104
+ return float(value)
105
+ return tuple(float(v) for v in value)
106
+ if kind == "floats":
107
+ return tuple(float(v) for v in value)
108
+ except (TypeError, ValueError) as exc:
109
+ detail = f" ({exc})" if str(exc) else ""
110
+ raise ValueError(
111
+ f"{name}: invalid value {value!r} for a {kind} parameter{detail}"
112
+ ) from None
113
+ raise ValueError(f"{name}: unsupported parameter kind {kind!r}")
114
+
115
+
116
+ # ----------------------------------------------------------------------------------
117
+ # Models
118
+
119
+ _REGISTRY: dict[str, type[Model]] = {}
120
+
121
+
122
+ def register(cls: type[Model]) -> type[Model]:
123
+ """Class decorator adding a model to the registry under ``cls.name``."""
124
+ if not cls.name:
125
+ raise ValueError(f"{cls.__name__} has no registry name")
126
+ _REGISTRY[cls.name] = cls
127
+ return cls
128
+
129
+
130
+ def get_model(name: str) -> type[Model]:
131
+ """The class of a registered model, by its name (:func:`list_models`)."""
132
+ try:
133
+ return _REGISTRY[name]
134
+ except KeyError:
135
+ raise ValueError(
136
+ f"unknown model type {name!r}; available models: {', '.join(list_models())}"
137
+ ) from None
138
+
139
+
140
+ def list_models() -> list[str]:
141
+ """The names of the registered models, sorted."""
142
+ return sorted(_REGISTRY)
143
+
144
+
145
+ def model_from_config(cfg: dict) -> Model:
146
+ """Build a model from a mapping ``{"type": name, **parameters}``."""
147
+ if not isinstance(cfg, dict) or "type" not in cfg:
148
+ raise ValueError("model: expected a mapping with a 'type' key")
149
+ return get_model(str(cfg["type"])).from_config(cfg)
150
+
151
+
152
+ @dataclasses.dataclass(frozen=True)
153
+ class Model(ABC):
154
+ """Morphological model (random set or deterministic architecture)."""
155
+
156
+ name: ClassVar[str] = ""
157
+ #: Meaning of the phase indices of the voxel images.
158
+ phases: ClassVar[dict[int, str]] = {0: "matrix", 1: "inclusions"}
159
+ #: False for models that cannot be periodic (e.g. infinite Poisson fibres).
160
+ supports_periodic: ClassVar[bool] = True
161
+ #: Whether one level set, that of the phase 1, describes the realizations (two phases:
162
+ #: the extended finite elements, the contours of the sections). False for the models
163
+ #: of more phases, or of other phases than 0 and 1 (cells of a tessellation, coated
164
+ #: inclusions, osteons...): each of their phases has its implicit function
165
+ #: (:meth:`Microstructure.phase_level_set`), from which they are meshed conformingly.
166
+ has_level_set: ClassVar[bool] = True
167
+ #: True for models whose realizations are meshed grain by grain from exact cells
168
+ #: (Voronoi and Laguerre tessellations, see :mod:`morphogen.mesh.polycrystal`).
169
+ meshed_by_grains: ClassVar[bool] = False
170
+ #: Objects counted by :meth:`expected_count` (fibres, spheres, cells...).
171
+ count_label: ClassVar[str] = ""
172
+ #: The parameters that are paths of files (or the keys of parameters that are
173
+ #: mappings: ``texture.file``): a configuration file gives them from its own folder
174
+ #: (:func:`morphogen.config.load_config`).
175
+ path_parameters: ClassVar[tuple[str, ...]] = ()
176
+
177
+ def __post_init__(self) -> None:
178
+ # accept plain values (numbers, mappings, strings) for every parameter kind
179
+ for f in dataclasses.fields(self):
180
+ value = getattr(self, f.name)
181
+ kind = f.metadata.get("kind", "float")
182
+ converted = _convert(kind, value, f.name)
183
+ if converted is not value:
184
+ object.__setattr__(self, f.name, converted)
185
+ self._validate()
186
+
187
+ def _validate(self) -> None: # noqa: B027 (optional hook)
188
+ """Check parameter values (raise ValueError with an explicit message)."""
189
+
190
+ @abstractmethod
191
+ def generate(self, domain: Domain, seed: SeedLike = None) -> Microstructure:
192
+ """One realization of the model in ``domain``."""
193
+
194
+ def theory(self, domain: Domain | None = None) -> dict[str, float]:
195
+ """Theoretical morphological characteristics known in closed form (may be empty).
196
+
197
+ Some values depend on the domain (e.g. the intensity implied by a number of cells).
198
+ """
199
+ return {}
200
+
201
+ def active_phases(self) -> dict[int, str]:
202
+ """Phases the realizations of this model can contain, with their names (the
203
+ :attr:`phases` of the model, unless its parameters choose them)."""
204
+ return dict(self.phases)
205
+
206
+ def expected_count(self, domain: Domain) -> float | None:
207
+ """Mean number of objects of the model in ``domain`` (None when undefined).
208
+
209
+ Used to express RVE sizes as numbers of fibres, grains or cells
210
+ (Dirrenberger et al. 2014, Table 10).
211
+ """
212
+ return None
213
+
214
+ # -- configuration -------------------------------------------------------------
215
+
216
+ def to_config(self) -> dict:
217
+ cfg: dict[str, Any] = {"type": self.name}
218
+ for f in dataclasses.fields(self):
219
+ value = getattr(self, f.name)
220
+ if value is None:
221
+ continue
222
+ if isinstance(value, (Distribution, OrientationDistribution)):
223
+ value = value.to_config()
224
+ if f.metadata.get("kind") == "anisotropy":
225
+ value = value.to_config()
226
+ if f.metadata.get("kind") == "distributions":
227
+ value = [d.to_config() for d in value]
228
+ if f.metadata.get("kind") == "models":
229
+ value = [m.to_config() for m in value]
230
+ elif f.metadata.get("kind") == "model":
231
+ value = value.to_config()
232
+ cfg[f.name] = to_jsonable(value)
233
+ return cfg
234
+
235
+ @classmethod
236
+ def from_config(cls, cfg: dict) -> Model:
237
+ cfg = dict(cfg)
238
+ cfg.pop("type", None)
239
+ fields = {f.name: f for f in dataclasses.fields(cls)}
240
+ unknown = sorted(set(cfg) - set(fields))
241
+ if unknown:
242
+ raise ValueError(
243
+ f"model {cls.name}: unknown parameters {unknown}; "
244
+ f"valid parameters: {', '.join(fields)}"
245
+ )
246
+ kwargs = {}
247
+ for key, value in cfg.items():
248
+ kind = fields[key].metadata.get("kind", "float")
249
+ kwargs[key] = _convert(kind, value, f"model.{key}")
250
+ missing = [
251
+ f.name
252
+ for f in fields.values()
253
+ if f.name not in kwargs
254
+ and f.default is dataclasses.MISSING
255
+ and f.default_factory is dataclasses.MISSING
256
+ ]
257
+ if missing:
258
+ raise ValueError(f"model {cls.name}: missing parameters {missing}")
259
+ try:
260
+ return cls(**kwargs)
261
+ except ValueError as exc:
262
+ raise ValueError(f"model {cls.name}: {exc}") from None
263
+
264
+ @classmethod
265
+ def parameters(cls) -> list[dict]:
266
+ """Description of the parameters (name, kind, default, unit, doc)."""
267
+ out = []
268
+ for f in dataclasses.fields(cls):
269
+ default = None if f.default is dataclasses.MISSING else f.default
270
+ if isinstance(default, (Distribution, OrientationDistribution)):
271
+ default = default.to_config()
272
+ out.append(
273
+ {
274
+ "name": f.name,
275
+ "kind": f.metadata.get("kind", "float"),
276
+ "default": to_jsonable(default),
277
+ "required": f.default is dataclasses.MISSING,
278
+ "unit": f.metadata.get("unit", ""),
279
+ "doc": f.metadata.get("doc", ""),
280
+ }
281
+ )
282
+ return out
283
+
284
+ def _check_domain(self, domain: Domain) -> None:
285
+ if domain.periodic and not self.supports_periodic:
286
+ raise ValueError(
287
+ f"model {self.name} cannot generate periodic microstructures; "
288
+ "use a non-periodic domain (periodic: false)"
289
+ )
290
+
291
+
292
+ # ----------------------------------------------------------------------------------
293
+ # Microstructures
294
+
295
+ _KINDS: dict[str, type[Microstructure]] = {}
296
+
297
+
298
+ def register_kind(cls: type[Microstructure]) -> type[Microstructure]:
299
+ """Registers a kind of microstructure (a class decorator), which
300
+ :meth:`Microstructure.from_dict` then reads back."""
301
+ _KINDS[cls.kind] = cls
302
+ return cls
303
+
304
+
305
+ class Microstructure(ABC):
306
+ """One realization of a model in a domain."""
307
+
308
+ kind: ClassVar[str] = ""
309
+
310
+ def __init__(
311
+ self,
312
+ domain: Domain,
313
+ *,
314
+ model: Model | None = None,
315
+ seed: dict | None = None,
316
+ metadata: dict | None = None,
317
+ ) -> None:
318
+ self.domain = domain
319
+ self.model = model
320
+ self.seed = seed
321
+ self.metadata = dict(metadata or {})
322
+
323
+ # -- discretization ------------------------------------------------------------
324
+
325
+ def grid(self, shape=None, *, voxel_size=None, grid: Grid | None = None) -> Grid:
326
+ """Resolve the voxel grid from ``shape``, ``voxel_size`` or an explicit grid."""
327
+ if grid is not None:
328
+ if shape is not None or voxel_size is not None:
329
+ raise ValueError("give either 'grid' or 'shape'/'voxel_size', not both")
330
+ return grid
331
+ return Grid.for_domain(self.domain, shape=shape, voxel_size=voxel_size)
332
+
333
+ @abstractmethod
334
+ def voxelize(
335
+ self, shape=None, *, voxel_size=None, grid: Grid | None = None, supersampling: int = 1
336
+ ) -> VoxelImage:
337
+ """Phase image (uint8), or partial volume fractions of phase 1 (float32) when
338
+ ``supersampling > 1`` (``supersampling**3`` sub-samples per voxel)."""
339
+
340
+ def level_set(self, shape=None, *, voxel_size=None, grid: Grid | None = None) -> VoxelImage:
341
+ """Field negative inside phase 1, positive outside and zero on its boundary."""
342
+ raise NotImplementedError(f"{type(self).__name__} has no level-set representation")
343
+
344
+ def implicit_phases(self) -> list[int]:
345
+ """The phases of the realization, each described by an implicit function
346
+ (:meth:`phase_level_set`), in increasing order: phase 1 and what surrounds it
347
+ (the structures of more phases, or of others, say theirs)."""
348
+ return [0, 1]
349
+
350
+ def phase_level_set(
351
+ self, phase: int, shape=None, *, voxel_size=None, grid: Grid | None = None
352
+ ) -> VoxelImage:
353
+ """The implicit function of a phase: a field negative inside ``phase``, positive
354
+ outside and zero on its boundary, at the centres of the voxels of a grid. The
355
+ interfaces are those of the model (see :mod:`morphogen.models.implicit`): the
356
+ conforming meshes, the surfaces and the sections of the phase are cut from it.
357
+ Phase 1 is :meth:`level_set`; the other phase of a structure of two phases, its
358
+ opposite; the structures of more phases give each of theirs."""
359
+ phase = int(phase)
360
+ phases = self.implicit_phases()
361
+ if phase not in phases:
362
+ raise ValueError(f"phase {phase}: the phases of this structure are {phases}")
363
+ if phase == 1:
364
+ return self.level_set(shape, voxel_size=voxel_size, grid=grid)
365
+ if len(phases) == 2 and 1 in phases:
366
+ field = self.level_set(shape, voxel_size=voxel_size, grid=grid)
367
+ return field.with_data(-np.asarray(field.data))
368
+ raise NotImplementedError(
369
+ f"{type(self).__name__} has no implicit function of its phase {phase}"
370
+ )
371
+
372
+ def implicit_at(self, phase: int, points, band: float) -> np.ndarray | None:
373
+ """The implicit function of one phase at arbitrary points (rows of ``points``),
374
+ clipped to ``[-band, band]``: that of :meth:`phase_level_sets_at`; None for the
375
+ structures whose functions are those of the points of grids only
376
+ (:meth:`phase_level_set`), and for a phase they do not have."""
377
+ try:
378
+ values = self.phase_level_sets_at(points, float(band))
379
+ except NotImplementedError:
380
+ return None
381
+ if int(phase) not in values:
382
+ return None
383
+ return np.clip(np.asarray(values[int(phase)], dtype=float), -float(band), float(band))
384
+
385
+ def implicit_pieces(self, depth: float = 0.0) -> tuple[list, int] | None:
386
+ """The smooth pieces of the phases, for the structures whose implicit functions
387
+ have folds (the unions of spheres and segments and their coatings, whose surfaces
388
+ have a sharp edge where two primitives meet): pieces in the order of the cuts of
389
+ a mesher that follows these edges, and the phase of what they leave (see
390
+ :mod:`morphogen.models.pieces`). A point belongs to the phase of the first piece
391
+ that holds it. Two primitives that enter each other by more than ``depth`` are
392
+ in different pieces. None for the other structures."""
393
+ return None
394
+
395
+ def contains(self, points) -> np.ndarray:
396
+ """Whether points lie in phase 1."""
397
+ raise NotImplementedError(f"{type(self).__name__} does not support point queries")
398
+
399
+ #: A bound of the slope of the functions of :meth:`phase_level_sets_at` (1 for signed
400
+ #: distances, and for their minima and maxima): the adaptive meshes leave unrefined
401
+ #: the edges that an interface cannot reach at this slope
402
+ lipschitz: float = 1.0
403
+
404
+ def level_set_at(self, points, reach: float = np.inf) -> np.ndarray:
405
+ """The function of phase 1 at points of space (:meth:`level_set` at any point),
406
+ negative in phase 1, whose zero set is its boundary: the signed distance to it,
407
+ exact within ``reach`` of it and at least ``reach`` beyond, when the structure knows
408
+ it (the others: a function with the same zero set, about a distance near it). The
409
+ structures of several phases give the function of their phase 1
410
+ (:meth:`phase_level_sets_at`), if they have one."""
411
+ raise NotImplementedError(
412
+ f"{type(self).__name__} has no point-wise level set (no exact mesh but its "
413
+ "convex pieces, if any)"
414
+ )
415
+
416
+ def phase_level_sets_at(self, points, reach: float = np.inf) -> dict[int, np.ndarray]:
417
+ """The implicit functions of all the phases at points of space (rows of
418
+ ``points``): ``{k: phi_k}`` for each phase ``k`` of :meth:`implicit_phases`, negative
419
+ in it, positive outside and zero on its boundary, exact within ``reach`` of the
420
+ interfaces and at least ``reach`` beyond (or about a distance near them, as
421
+ :meth:`level_set_at`). It is :meth:`phase_level_set` at any point: the same values
422
+ at the centres of the voxels of a grid, within the band of the grid. Two phases:
423
+ ``{1: phi, 0: -phi}`` of :meth:`level_set_at`. The exact meshes
424
+ (:mod:`morphogen.mesh.exact`) cut them, and the curved elements
425
+ (:mod:`morphogen.mesh.curved`) put their nodes on their zeros. Raises
426
+ NotImplementedError for the structures whose functions are those of the points of
427
+ grids only."""
428
+ if self.implicit_phases() != [0, 1]:
429
+ raise NotImplementedError(
430
+ f"{type(self).__name__} has no point-wise functions of its phases"
431
+ )
432
+ phi = np.asarray(self.level_set_at(points, reach), dtype=float)
433
+ return {0: -phi, 1: phi}
434
+
435
+ @property
436
+ def has_labels(self) -> bool:
437
+ """Whether ``labels(...)`` gives an image of cell indices (cells, grains)."""
438
+ return False
439
+
440
+ # -- description ---------------------------------------------------------------
441
+
442
+ @property
443
+ def phase_names(self) -> dict[int, str]:
444
+ return dict(self.model.phases) if self.model is not None else {0: "0", 1: "1"}
445
+
446
+ def image_metadata(self) -> dict:
447
+ return to_jsonable(
448
+ {
449
+ "morphogen": __version__,
450
+ "model": self.model.to_config() if self.model is not None else None,
451
+ "domain": self.domain.to_dict(),
452
+ "seed": self.seed,
453
+ "phases": {str(k): v for k, v in self.phase_names.items()},
454
+ }
455
+ )
456
+
457
+ def summary(self) -> dict:
458
+ """Counts and sizes describing the realization."""
459
+ return {}
460
+
461
+ @abstractmethod
462
+ def _geometry(self) -> dict:
463
+ """JSON-able explicit geometry."""
464
+
465
+ @classmethod
466
+ @abstractmethod
467
+ def _from_geometry(cls, domain: Domain, geometry: dict, **kwargs) -> Microstructure:
468
+ """Inverse of :meth:`_geometry`."""
469
+
470
+ def to_dict(self) -> dict:
471
+ return to_jsonable(
472
+ {
473
+ "morphogen": __version__,
474
+ "kind": self.kind,
475
+ "domain": self.domain.to_dict(),
476
+ "model": self.model.to_config() if self.model is not None else None,
477
+ "seed": self.seed,
478
+ "metadata": self.metadata,
479
+ "geometry": self._geometry(),
480
+ }
481
+ )
482
+
483
+ @staticmethod
484
+ def from_dict(data: dict) -> Microstructure:
485
+ kind = data.get("kind")
486
+ if kind not in _KINDS:
487
+ raise ValueError(f"unknown microstructure kind {kind!r}")
488
+ model = model_from_config(data["model"]) if data.get("model") else None
489
+ return _KINDS[kind]._from_geometry(
490
+ Domain.from_dict(data["domain"]),
491
+ data["geometry"],
492
+ model=model,
493
+ seed=data.get("seed"),
494
+ metadata=data.get("metadata"),
495
+ )
496
+
497
+ def __repr__(self) -> str:
498
+ name = self.model.name if self.model is not None else self.kind
499
+ info = ", ".join(f"{k}={v}" for k, v in self.summary().items())
500
+ return f"<{type(self).__name__} {name} {info}>"