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,427 @@
1
+ """Harmonic (frequency-domain) homogenization of periodic voxel images: effective
2
+ properties of phases whose laws are complex, in the quasi-static regime where the
3
+ wavelengths are much longer than the microstructure.
4
+
5
+ A harmonic excitation ``exp(i omega t)`` of linear dissipative phases has complex laws:
6
+
7
+ * **viscoelastic solids** (the correspondence principle): the complex moduli ``K*(omega)``
8
+ and ``G*(omega)`` of the Prony series of each phase (:class:`~morphogen.homogenization.
9
+ laws.Viscoelasticity`) give the effective complex stiffness ``C*(omega) = C' + i C''``:
10
+ storage and loss moduli, loss factors (:func:`dynamic_stiffness`);
11
+ * **conductors and dielectrics** (quasi-static electromagnetism): the complex conductivity
12
+ ``sigma* = sigma + i omega eps`` of each phase gives the effective conductivity and
13
+ permittivity of the composite at each frequency, with the interfacial polarization of
14
+ Maxwell, Wagner and Sillars where conducting inclusions charge their interfaces
15
+ (:func:`complex_conductivity`);
16
+ * **optics** in the long-wavelength limit: the complex permittivities ``(n + i k)^2`` of
17
+ the phases at a wavelength give the effective permittivity tensor of the composite, its
18
+ refractive indices and its absorption (form birefringence, effective media of
19
+ nanocomposites: :func:`effective_index`).
20
+
21
+ All are the same problem (:func:`harmonic_tensor`): the periodic problem of a field with
22
+ a complex symmetric law ``L = L' + i L''``, whose real form doubles the field,
23
+
24
+ [ L' -L''] [Z'] [ S']
25
+ [-L'' -L' ] [Z''] = [-S''],
26
+
27
+ a real symmetric law that is not definite, solved by the coupled solver of
28
+ :mod:`morphogen.homogenization.coupled` (MINRES preconditioned in Fourier space) for the
29
+ unit real loadings. The laws are first turned by a phase ``exp(i theta)`` that centres
30
+ them about the real axis, so that their real parts are positive definite whenever the
31
+ laws of the phases lie in an open half of the complex plane (dielectrics and metals of
32
+ negative permittivity together, lossy phases with lossless ones). The effective tensors
33
+ are complex symmetric; :func:`~morphogen.homogenization.coupled.laminate` gives those of
34
+ layers exactly.
35
+ """
36
+
37
+ from __future__ import annotations
38
+
39
+ import logging
40
+ from dataclasses import dataclass
41
+
42
+ import numpy as np
43
+
44
+ from morphogen.homogenization.coupled import CoupledProblem, layout_sizes
45
+ from morphogen.homogenization.materials import (
46
+ Material,
47
+ bulk_shear,
48
+ isotropic_matrix,
49
+ material_table,
50
+ )
51
+ from morphogen.image import VoxelImage
52
+
53
+ log = logging.getLogger("morphogen")
54
+
55
+
56
+ def _half_plane(laws) -> float:
57
+ """The angle ``theta`` whose phase ``exp(i theta)`` centres the eigenvalues of complex
58
+ symmetric laws about the positive real axis."""
59
+ values = np.concatenate([np.linalg.eigvals(law) for law in laws])
60
+ values = values[np.abs(values) > 0]
61
+ if not values.size:
62
+ return 0.0
63
+ args = np.sort(np.angle(values))
64
+ # the widest gap of the arguments around the circle: the half plane opposite to it
65
+ gaps = np.diff(np.concatenate([args, [args[0] + 2.0 * np.pi]]))
66
+ k = int(np.argmax(gaps))
67
+ if gaps[k] <= np.pi * (1.0 + 1e-12):
68
+ raise ValueError(
69
+ "harmonic laws: the eigenvalues of the laws of the phases must lie in an open "
70
+ "half of the complex plane (a gain medium beside a lossy one, or opposite signs "
71
+ "without losses, have no such problem)"
72
+ )
73
+ centre = args[k] + 0.5 * gaps[k] + np.pi # the middle of the arc that holds them all
74
+ return float(-centre)
75
+
76
+
77
+ def harmonic_tensor(image: VoxelImage, laws, mat, layout=("potential",), *,
78
+ tol: float = 1e-8, maxiter: int | None = None): # fmt: skip
79
+ """The effective complex symmetric tensor of a periodic voxel image whose materials
80
+ have the complex symmetric laws ``laws[m]`` (the components of the ``layout`` of
81
+ fields: 3 x 3 for a potential, 6 x 6 in the Voigt order for a displacement), ``mat``
82
+ the material of each voxel (-1: none); see the module. Returns the tensor and the
83
+ :class:`~morphogen.homogenization.coupled.CoupledProblem` solved (its iterations)."""
84
+ layout = tuple(layout)
85
+ _, nz = layout_sizes(layout)
86
+ laws = np.asarray(laws, dtype=complex).reshape(-1, nz, nz)
87
+ if not np.allclose(laws, np.swapaxes(laws, 1, 2), rtol=1e-10,
88
+ atol=1e-12 * max(np.abs(laws).max(initial=0.0), 1e-300)): # fmt: skip
89
+ raise ValueError("harmonic laws: complex symmetric matrices (not Hermitian ones)")
90
+ mat = np.asarray(mat).ravel()
91
+ used = [laws[m] for m in np.unique(mat[mat >= 0])]
92
+ theta = _half_plane(used)
93
+ turned = np.exp(1j * theta) * laws
94
+ real = np.zeros((len(laws), 2 * nz, 2 * nz))
95
+ real[:, :nz, :nz] = turned.real
96
+ real[:, nz:, nz:] = -turned.real
97
+ real[:, :nz, nz:] = real[:, nz:, :nz] = -turned.imag
98
+ for m in np.unique(mat[mat >= 0]):
99
+ if np.linalg.eigvalsh(turned[m].real).min() <= 0:
100
+ raise ValueError(
101
+ "harmonic laws: an anisotropic law whose real part is not definite once "
102
+ "centred with the others (its principal axes of storage and loss differ too "
103
+ "much)"
104
+ )
105
+ problem = CoupledProblem(image, real, layout + layout, mat, tol=tol, maxiter=maxiter,
106
+ pairs=True) # fmt: skip
107
+ out = np.zeros((nz, nz), dtype=complex)
108
+ for j in range(nz):
109
+ unit = np.zeros(2 * nz)
110
+ unit[j] = 1.0
111
+ flux = problem.solve(unit).flux
112
+ out[:, j] = flux[:nz] - 1j * flux[nz:]
113
+ out *= np.exp(-1j * theta)
114
+ return 0.5 * (out + out.T), problem
115
+
116
+
117
+ @dataclass
118
+ class HarmonicResponse:
119
+ """The effective complex tensors of a sample at angular ``frequencies`` (rad per unit
120
+ time; wavelengths for :func:`effective_index`): ``tensors`` (frequencies x d x d,
121
+ complex symmetric; 6 x 6 in the Voigt order 11 22 33 23 31 12 with engineering shears
122
+ for a stiffness, 3 x 3 for a transport), the ``kind`` of the law (``"stiffness"``,
123
+ ``"conductivity"`` or ``"permittivity"``) and the iterations of the solver at each
124
+ frequency."""
125
+
126
+ kind: str
127
+ frequencies: np.ndarray
128
+ tensors: np.ndarray
129
+ iterations: np.ndarray
130
+
131
+ @property
132
+ def storage(self) -> np.ndarray:
133
+ """The real parts of the tensors (the storage moduli of a stiffness)."""
134
+ return self.tensors.real
135
+
136
+ @property
137
+ def loss(self) -> np.ndarray:
138
+ """The imaginary parts of the tensors (the loss moduli of a stiffness)."""
139
+ return self.tensors.imag
140
+
141
+ # -- stiffness ---------------------------------------------------------------------
142
+
143
+ def _need(self, kind: str) -> None:
144
+ if self.kind != kind:
145
+ raise ValueError(f"a {self.kind} has no such quantity (a {kind} has)")
146
+
147
+ @property
148
+ def bulk(self) -> np.ndarray:
149
+ """The complex bulk moduli of the isotropic parts of the stiffnesses."""
150
+ self._need("stiffness")
151
+ c = self.tensors
152
+ return (c[:, :3, :3].sum(axis=(1, 2))) / 9.0
153
+
154
+ @property
155
+ def shear(self) -> np.ndarray:
156
+ """The complex shear moduli of the isotropic parts of the stiffnesses."""
157
+ self._need("stiffness")
158
+ c = self.tensors
159
+ d = c[:, 0, 0] + c[:, 1, 1] + c[:, 2, 2]
160
+ o = c[:, 0, 1] + c[:, 0, 2] + c[:, 1, 2]
161
+ s = c[:, 3, 3] + c[:, 4, 4] + c[:, 5, 5]
162
+ return (d - o + 3.0 * s) / 15.0
163
+
164
+ def young(self, axis: int = 0) -> np.ndarray:
165
+ """The complex Young's moduli along an axis: ``1 / S*_ii`` of the compliances."""
166
+ self._need("stiffness")
167
+ return np.array([1.0 / np.linalg.inv(c)[axis, axis] for c in self.tensors])
168
+
169
+ @staticmethod
170
+ def loss_factor(modulus) -> np.ndarray:
171
+ """``tan delta``: the loss over the storage of complex moduli."""
172
+ modulus = np.asarray(modulus)
173
+ return modulus.imag / modulus.real
174
+
175
+ # -- transport ---------------------------------------------------------------------
176
+
177
+ @property
178
+ def conductivity(self) -> np.ndarray:
179
+ """The effective conductivity tensors (the real parts of ``sigma*``)."""
180
+ self._need("conductivity")
181
+ return self.tensors.real
182
+
183
+ @property
184
+ def permittivity(self) -> np.ndarray:
185
+ """The effective permittivity tensors: ``Im(sigma*) / omega`` of a complex
186
+ conductivity; the complex tensors themselves for :func:`effective_index`."""
187
+ if self.kind == "permittivity":
188
+ return self.tensors
189
+ self._need("conductivity")
190
+ return self.tensors.imag / self.frequencies[:, None, None]
191
+
192
+ @property
193
+ def index(self) -> np.ndarray:
194
+ """The complex refractive indices ``n + i k`` along the three axes (frequencies x
195
+ 3): the square roots of the diagonal of the permittivity tensors (non-magnetic
196
+ media; ``k >= 0``: absorption)."""
197
+ self._need("permittivity")
198
+ diag = np.einsum("nii->ni", self.tensors)
199
+ n = np.sqrt(diag)
200
+ return np.where(n.imag < 0, -n, n)
201
+
202
+ @property
203
+ def absorption(self) -> np.ndarray:
204
+ """The absorption coefficients ``4 pi k / lambda`` along the three axes, for the
205
+ wavelengths of :func:`effective_index` (the inverse of their unit)."""
206
+ return 4.0 * np.pi * self.index.imag / self.frequencies[:, None]
207
+
208
+ def to_dict(self) -> dict:
209
+ """The response as plain arrays (for JSON) and the scalar :meth:`entries`: the
210
+ ``frequencies`` (``wavelengths`` of a permittivity), the ``storage`` and ``loss``
211
+ parts of the tensors, the ``iterations``; of a conductivity, its ``conductivity``
212
+ and ``permittivity`` tensors; of a permittivity, the ``index``, ``extinction`` and
213
+ ``absorption`` along the axes."""
214
+ name = "wavelengths" if self.kind == "permittivity" else "frequencies"
215
+ out = {"kind": self.kind, name: self.frequencies, "storage": self.storage,
216
+ "loss": self.loss, "iterations": self.iterations} # fmt: skip
217
+ if self.kind == "conductivity":
218
+ out.update(conductivity=self.conductivity, permittivity=self.permittivity)
219
+ elif self.kind == "permittivity":
220
+ out.update(index=self.index.real, extinction=self.index.imag,
221
+ absorption=self.absorption) # fmt: skip
222
+ out.update(self.entries())
223
+ return out
224
+
225
+ def entries(self) -> dict[str, float]:
226
+ """Scalar entries for the tables of results, the frequencies numbered from 1:
227
+ of a stiffness ``bulk_storage_1``, ``bulk_loss_1``, ``shear_storage_1``,
228
+ ``shear_loss_1``, ``shear_tan_delta_1``, ``young_storage_1``, ``young_loss_1``
229
+ (along x); of a conductivity ``conductivity_1``, ``permittivity_1`` (the means of
230
+ their diagonals); of a permittivity ``index_1``, ``extinction_1`` (the means of
231
+ ``n`` and ``k``)."""
232
+ out: dict[str, float] = {}
233
+ for i in range(len(self.frequencies)):
234
+ k = i + 1
235
+ if self.kind == "stiffness":
236
+ for name, value in (("bulk", self.bulk[i]), ("shear", self.shear[i]),
237
+ ("young", self.young()[i])): # fmt: skip
238
+ out[f"{name}_storage_{k}"] = float(value.real)
239
+ out[f"{name}_loss_{k}"] = float(value.imag)
240
+ out[f"shear_tan_delta_{k}"] = float(self.shear[i].imag / self.shear[i].real)
241
+ elif self.kind == "conductivity":
242
+ out[f"conductivity_{k}"] = float(np.trace(self.conductivity[i]) / 3.0)
243
+ out[f"permittivity_{k}"] = float(np.trace(self.permittivity[i]) / 3.0)
244
+ else:
245
+ out[f"index_{k}"] = float(self.index[i].real.mean())
246
+ out[f"extinction_{k}"] = float(self.index[i].imag.mean())
247
+ return out
248
+
249
+
250
+ #: The kind of the tensors of each harmonic property
251
+ KINDS = {
252
+ "dynamic_stiffness": "stiffness",
253
+ "complex_conductivity": "conductivity",
254
+ "refractive_index": "permittivity",
255
+ }
256
+
257
+
258
+ def entry_names(prop: str, count: int) -> tuple[str, ...]:
259
+ """The names of the scalar entries (:meth:`HarmonicResponse.entries`) of a harmonic
260
+ property (``dynamic_stiffness``, ``complex_conductivity``, ``refractive_index``) at
261
+ ``count`` frequencies or wavelengths, numbered from 1: the columns of the tables of
262
+ results and the quantities of the statistics of RVE studies."""
263
+ if prop not in KINDS:
264
+ raise ValueError(f"harmonic property: one of {tuple(KINDS)}, got {prop!r}")
265
+ stems = {
266
+ "stiffness": ("bulk_storage", "bulk_loss", "shear_storage", "shear_loss",
267
+ "young_storage", "young_loss", "shear_tan_delta"),
268
+ "conductivity": ("conductivity", "permittivity"),
269
+ "permittivity": ("index", "extinction"),
270
+ }[KINDS[prop]] # fmt: skip
271
+ return tuple(f"{stem}_{k}" for k in range(1, int(count) + 1) for stem in stems)
272
+
273
+
274
+ def _frequencies(values, name: str = "frequencies") -> np.ndarray:
275
+ f = np.atleast_1d(np.asarray(values, dtype=float))
276
+ if f.ndim != 1 or not f.size or np.any(~np.isfinite(f)) or np.any(f <= 0):
277
+ raise ValueError(f"{name}: positive values")
278
+ return f
279
+
280
+
281
+ def _image(image) -> np.ndarray:
282
+ if not isinstance(image, VoxelImage):
283
+ raise TypeError("harmonic homogenization: a periodic VoxelImage (the FFT solver)")
284
+ if image.data.dtype.kind not in "iub":
285
+ raise ValueError("homogenization needs an integer phase image")
286
+ return np.asarray(image.data).ravel().astype(np.int64)
287
+
288
+
289
+ def dynamic_stiffness(image: VoxelImage, materials: dict[int, Material], frequencies, *,
290
+ dtemp: float = 0.0, grains=None, orientations=None, tol: float = 1e-8,
291
+ maxiter: int | None = None) -> HarmonicResponse: # fmt: skip
292
+ """The effective complex stiffness of a periodic voxel image at the angular
293
+ ``frequencies`` (rad per unit time): the phases with a ``viscoelasticity`` have the
294
+ complex moduli of their Prony series (at the change of temperature ``dtemp`` from
295
+ their reference: their shifted times), the others their elasticity (crystals turned
296
+ by the orientations of their ``grains``). :class:`HarmonicResponse`: the storage and
297
+ loss stiffnesses, the complex bulk, shear and Young's moduli, the loss factors."""
298
+ phase = _image(image)
299
+ freqs = _frequencies(frequencies)
300
+ table = material_table(image.data, materials, "elastic", grains=grains,
301
+ orientations=orientations) # fmt: skip
302
+ viscous = {}
303
+ for p in table.phases:
304
+ m = materials[p]
305
+ if m.void or m.viscoelasticity is None:
306
+ continue
307
+ rows = np.unique(table.mat[phase == p])
308
+ viscous[p] = (rows[rows >= 0], m)
309
+ if not viscous:
310
+ log.info("dynamic stiffness: no viscoelastic phase, the stiffness is real")
311
+ tensors = np.zeros((freqs.size, 6, 6), dtype=complex)
312
+ iterations = np.zeros(freqs.size, dtype=int)
313
+ for i, omega in enumerate(freqs):
314
+ laws = table.matrices.astype(complex)
315
+ for rows, m in viscous.values():
316
+ k, g = m.viscoelasticity.complex_moduli(omega, *bulk_shear(m.young, m.poisson), dtemp)
317
+ law = (k - 2.0 * g / 3.0) * isotropic_matrix(1.0, 0.0) + g * isotropic_matrix(0.0, 1.0)
318
+ laws[rows] = law
319
+ tensors[i], problem = harmonic_tensor(image, laws, table.mat, ("displacement",),
320
+ tol=tol, maxiter=maxiter) # fmt: skip
321
+ iterations[i] = problem.iterations
322
+ return HarmonicResponse("stiffness", freqs, tensors, iterations)
323
+
324
+
325
+ def _transport_laws(image, materials, physics, grains, orientations):
326
+ """The real tensors of the phases for a transport physics (zero where a phase has no
327
+ coefficient for it), one per phase or per grain of an oriented phase, on the material
328
+ indices shared by the physics: (indices of the voxels, tensors)."""
329
+ phase = _image(image)
330
+ present = [int(p) for p in np.unique(phase)]
331
+ missing = [p for p in present if p not in materials]
332
+ if missing:
333
+ raise ValueError(f"no material for phase(s) {missing}; phases present: {present}")
334
+ oriented = grains is not None and orientations is not None
335
+ if oriented:
336
+ grains = np.asarray(grains.data if isinstance(grains, VoxelImage) else grains).ravel()
337
+ mat = np.full(phase.size, -1, dtype=np.int64)
338
+ tensors = {name: [] for name in physics}
339
+ count = 0
340
+ for p in present:
341
+ m = materials[p]
342
+ if m.void:
343
+ continue
344
+ sel = np.flatnonzero(phase == p)
345
+ turn = oriented and any(m.has(ph) and m.oriented(ph) for ph in physics)
346
+ if turn:
347
+ ids, inverse = np.unique(grains[sel], return_inverse=True)
348
+ mat[sel] = count + inverse
349
+ euler = np.asarray(orientations, dtype=float)[ids]
350
+ n = len(ids)
351
+ else:
352
+ mat[sel] = count
353
+ euler, n = None, 1
354
+ for name in physics:
355
+ if not m.has(name) or m.inert(name):
356
+ tensors[name].append(np.zeros((n, 3, 3)))
357
+ else:
358
+ tensors[name].append(np.asarray(m.matrix(name, euler)).reshape(n, 3, 3))
359
+ count += n
360
+ empty = np.zeros((0, 3, 3))
361
+ return mat, {name: np.concatenate(v) if v else empty for name, v in tensors.items()}
362
+
363
+
364
+ def complex_conductivity(image: VoxelImage, materials: dict[int, Material], frequencies, *,
365
+ grains=None, orientations=None, tol: float = 1e-8,
366
+ maxiter: int | None = None) -> HarmonicResponse: # fmt: skip
367
+ """The effective complex conductivity ``sigma*(omega)`` of a periodic voxel image at
368
+ the angular ``frequencies``: each phase has ``sigma* = sigma + i omega eps`` of its
369
+ ``electrical_conductivity`` and ``permittivity`` (either may be missing or zero: a
370
+ perfect insulator, a conductor without polarization). :class:`HarmonicResponse`: the
371
+ effective conductivity ``Re(sigma*)`` and permittivity ``Im(sigma*) / omega`` at each
372
+ frequency (the dispersion of Maxwell, Wagner and Sillars)."""
373
+ freqs = _frequencies(frequencies)
374
+ mat, parts = _transport_laws(image, materials, ("electrical", "dielectric"), grains,
375
+ orientations) # fmt: skip
376
+ sigma, eps = parts["electrical"], parts["dielectric"]
377
+ carried = np.abs(sigma).max(axis=(1, 2), initial=0.0)
378
+ carried = carried + np.abs(eps).max(axis=(1, 2), initial=0.0)
379
+ if len(carried) and np.any(carried == 0):
380
+ dead = np.flatnonzero(carried == 0)
381
+ mat = np.where(np.isin(mat, dead), -1, mat) # neither conducts nor polarizes: a void
382
+ tensors = np.zeros((freqs.size, 3, 3), dtype=complex)
383
+ iterations = np.zeros(freqs.size, dtype=int)
384
+ for i, omega in enumerate(freqs):
385
+ tensors[i], problem = harmonic_tensor(image, sigma + 1j * omega * eps, mat,
386
+ tol=tol, maxiter=maxiter) # fmt: skip
387
+ iterations[i] = problem.iterations
388
+ return HarmonicResponse("conductivity", freqs, tensors, iterations)
389
+
390
+
391
+ def effective_index(image: VoxelImage, indices: dict, wavelengths=1.0, *, tol: float = 1e-8,
392
+ maxiter: int | None = None) -> HarmonicResponse: # fmt: skip
393
+ """The effective permittivity of a periodic voxel image in the long-wavelength
394
+ (quasi-static) limit of optics: ``indices`` maps each phase to its complex refractive
395
+ index ``n + i k`` (one value, or one per wavelength; ``k > 0``: absorption; or a
396
+ :class:`~morphogen.homogenization.materials.Material` with a ``refractive_index``) and
397
+ the permittivity of each phase is ``(n + i k)^2``. :class:`HarmonicResponse` (its
398
+ ``frequencies`` are the ``wavelengths``): the complex permittivity tensors, the
399
+ refractive indices along the axes and the absorption coefficients ``4 pi k /
400
+ lambda``. Valid while the wavelengths are much longer than the microstructure;
401
+ resonances of its size (photonic bands) are those of :mod:`morphogen.homogenization.
402
+ waves`."""
403
+ phase = _image(image)
404
+ lengths = _frequencies(wavelengths, "wavelengths")
405
+ present = [int(p) for p in np.unique(phase)]
406
+ missing = [p for p in present if p not in indices]
407
+ if missing:
408
+ raise ValueError(f"no refractive index for phase(s) {missing}")
409
+ values = {}
410
+ for p in present:
411
+ value = indices[p]
412
+ if isinstance(value, Material):
413
+ if value.refractive_index is None:
414
+ raise ValueError(f"phase {p}: the material has no refractive_index")
415
+ value = value.refractive_index
416
+ n = np.atleast_1d(np.asarray(value, dtype=complex))
417
+ if n.size not in (1, lengths.size):
418
+ raise ValueError(f"indices[{p}]: one index, or one per wavelength")
419
+ values[p] = np.broadcast_to(n, lengths.shape)
420
+ mat = np.searchsorted(present, phase)
421
+ tensors = np.zeros((lengths.size, 3, 3), dtype=complex)
422
+ iterations = np.zeros(lengths.size, dtype=int)
423
+ for i in range(lengths.size):
424
+ laws = np.array([values[p][i] ** 2 * np.eye(3) for p in present])
425
+ tensors[i], problem = harmonic_tensor(image, laws, mat, tol=tol, maxiter=maxiter)
426
+ iterations[i] = problem.iterations
427
+ return HarmonicResponse("permittivity", lengths, tensors, iterations)