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,361 @@
1
+ """Viscous flow through the pores of a voxel image: the permeability of Darcy's law.
2
+
3
+ A fluid of viscosity ``eta`` creeps through the pores of a rigid solid under a
4
+ macroscopic pressure gradient ``G``: the Stokes problem ``eta lap(v) - grad p = G``,
5
+ ``div v = 0`` in the pores, ``v = 0`` on their walls, the pressure ``p`` and the velocity
6
+ periodic. Its mean velocity over the whole cell (the filtration velocity) obeys Darcy's
7
+ law,
8
+
9
+ <v> = -(k / eta) G,
10
+
11
+ with the permeability tensor ``k`` (a squared length: that of the pores), symmetric and
12
+ positive, independent of the fluid.
13
+
14
+ **Method.** The lattice Boltzmann method with two relaxation times (Ginzburg 2005) on the
15
+ voxels themselves (lattice D3Q19): populations ``f_i`` move along the 19 velocities
16
+ ``c_i`` and relax towards the linear equilibrium of a Stokes flow, ``w_i (rho + 3 c_i . j)``
17
+ — their symmetric parts ``(f_i + f_-i) / 2`` at the rate ``1 / tau+``, which sets the
18
+ viscosity ``nu = (tau+ - 1/2) / 3``, their antisymmetric parts at the rate ``1 / tau-``
19
+ — and bounce back from the solid voxels (no slip). The product ``(tau+ - 1/2)(tau- -
20
+ 1/2)`` is kept at 3/16, for which the wall of a channel along the lattice lies exactly
21
+ midway between the last fluid node and the first solid one, and the steady solution does
22
+ not depend on the viscosity: the permeability is a property of the voxels alone. The
23
+ flow is driven by a uniform body force (the pressure gradient), with the half-force
24
+ correction of the momentum, and marched to its steady state; its mean velocity is the
25
+ mass flux of the populations that move between the nodes of the pores, conserved exactly
26
+ (the same through every section, zero where the pores are closed), which takes a number of
27
+ steps of the order of ``w^2 / nu`` for pores ``w`` voxels wide (hence a large ``tau+``,
28
+ 4 by default); the changes of the mean velocity decay geometrically, which gives the
29
+ error left and the limit itself (Aitken's extrapolation), accepted when it holds at two
30
+ checks in a row.
31
+
32
+ A channel of ``H`` voxels between two plane walls has the exact parabolic profile at its
33
+ nodes and the permeability ``H^2 / 12 + 1 / 24`` (per unit of its width, in voxels: the
34
+ mean of the parabola sampled at the nodes). Curved walls are drawn as stairs: a few
35
+ percent of error when the pores are ten voxels wide, less when they are wider.
36
+
37
+ The voxels must be cubic. The pores are the void phases of the materials (a fluid has no
38
+ `Material`); closed pores hold a fluid at rest.
39
+
40
+ References: H. Darcy (1856); I. Ginzburg, Adv. Water Resour. 28 (2005) 1171; I. Ginzburg,
41
+ F. Verhaeghe, D. d'Humières, Commun. Comput. Phys. 3 (2008) 427; L. Talon et al., Water
42
+ Resour. Res. 48 (2012) W04526; A. A. Zick, G. M. Homsy, J. Fluid Mech. 115 (1982) 13; A.
43
+ S. Sangani, A. Acrivos, Int. J. Multiphase Flow 8 (1982) 193.
44
+ """
45
+
46
+ from __future__ import annotations
47
+
48
+ import logging
49
+ import time
50
+ from dataclasses import dataclass, field
51
+
52
+ import numpy as np
53
+ from numba import njit, prange
54
+
55
+ from morphogen.homogenization.core import VOIGT_NAMES
56
+ from morphogen.homogenization.elements import VOIGT
57
+ from morphogen.image import VoxelImage
58
+ from morphogen.stopping import checkpoint
59
+
60
+ log = logging.getLogger("morphogen")
61
+
62
+ __all__ = [
63
+ "ENTRIES",
64
+ "MAGIC",
65
+ "StokesFlow",
66
+ "permeability_tensor",
67
+ "pore_mask",
68
+ "stokes_flow",
69
+ ]
70
+
71
+ #: The scalar results of :func:`permeability_tensor` (columns of the tables of results and
72
+ #: quantities of the statistics of RVE studies)
73
+ ENTRIES = ("mean", "porosity", *(f"k{name}" for name in VOIGT_NAMES))
74
+ #: The product ``(tau+ - 1/2)(tau- - 1/2)`` of the two relaxation times: walls midway
75
+ #: between the nodes for the flow of a channel along the lattice
76
+ MAGIC = 3.0 / 16.0
77
+
78
+ # D3Q19: the rest velocity, the six of the axes, the twelve of the diagonals of the faces
79
+ _C = np.array(
80
+ [[0, 0, 0],
81
+ [1, 0, 0], [-1, 0, 0], [0, 1, 0], [0, -1, 0], [0, 0, 1], [0, 0, -1],
82
+ [1, 1, 0], [-1, -1, 0], [1, -1, 0], [-1, 1, 0],
83
+ [1, 0, 1], [-1, 0, -1], [1, 0, -1], [-1, 0, 1],
84
+ [0, 1, 1], [0, -1, -1], [0, 1, -1], [0, -1, 1]],
85
+ dtype=np.int64,
86
+ ) # fmt: skip
87
+ _W = np.array([1.0 / 3.0] + [1.0 / 18.0] * 6 + [1.0 / 36.0] * 12)
88
+ #: The velocity opposite to each one (they come in pairs after the rest velocity)
89
+ _OPP = np.array([0, 2, 1, 4, 3, 6, 5, 8, 7, 10, 9, 12, 11, 14, 13, 16, 15, 18, 17], dtype=np.int64)
90
+
91
+
92
+ @njit(cache=True, parallel=True)
93
+ def _step(old, new, fluid, force, om_plus, om_minus, c, w, opp): # pragma: no cover
94
+ """One step of the populations (x, y, z, 19): those of ``old`` (after their
95
+ collision) pulled along their velocities, or bounced back from the solid, then
96
+ collided into ``new``."""
97
+ nx, ny, nz = fluid.shape
98
+ gx, gy, gz = force[0], force[1], force[2]
99
+ source = 1.0 - 0.5 * om_minus
100
+ for x in prange(nx):
101
+ p = np.empty(19)
102
+ # the neighbours x - c for c = -1, 0, 1 (periodic)
103
+ xa = np.array([(x + 1) % nx, x, (x - 1) % nx])
104
+ ya = np.empty(3, dtype=np.int64)
105
+ za = np.empty(3, dtype=np.int64)
106
+ for y in range(ny):
107
+ ya[0], ya[1], ya[2] = (y + 1) % ny, y, (y - 1) % ny
108
+ for z in range(nz):
109
+ if not fluid[x, y, z]:
110
+ continue
111
+ za[0], za[1], za[2] = (z + 1) % nz, z, (z - 1) % nz
112
+ for i in range(19):
113
+ xs = xa[c[i, 0] + 1]
114
+ ys = ya[c[i, 1] + 1]
115
+ zs = za[c[i, 2] + 1]
116
+ if fluid[xs, ys, zs]:
117
+ p[i] = old[xs, ys, zs, i]
118
+ else:
119
+ p[i] = old[x, y, z, opp[i]]
120
+ rho = 0.0
121
+ jx = 0.5 * gx
122
+ jy = 0.5 * gy
123
+ jz = 0.5 * gz
124
+ for i in range(19):
125
+ rho += p[i]
126
+ jx += c[i, 0] * p[i]
127
+ jy += c[i, 1] * p[i]
128
+ jz += c[i, 2] * p[i]
129
+ new[x, y, z, 0] = p[0] - om_plus * (p[0] - w[0] * rho)
130
+ for i in range(1, 19, 2):
131
+ o = i + 1 # the opposite velocity
132
+ sym = 0.5 * (p[i] + p[o]) - w[i] * rho
133
+ cj = c[i, 0] * jx + c[i, 1] * jy + c[i, 2] * jz
134
+ anti = 0.5 * (p[i] - p[o]) - 3.0 * w[i] * cj
135
+ cg = c[i, 0] * gx + c[i, 1] * gy + c[i, 2] * gz
136
+ push = source * 3.0 * w[i] * cg
137
+ new[x, y, z, i] = p[i] - om_plus * sym - om_minus * anti + push
138
+ new[x, y, z, o] = p[o] - om_plus * sym + om_minus * anti - push
139
+
140
+
141
+ @njit(cache=True, parallel=True)
142
+ def _momentum(pops, fluid, force, c, out): # pragma: no cover
143
+ """The momentum of each fluid node (``out``: x, y, z, 3; zero in the solid) from its
144
+ populations after their collision: the collision has added the whole force to the
145
+ momentum of the populations that arrived, and the momentum of the fluid is theirs
146
+ plus half of it."""
147
+ nx, ny, nz = fluid.shape
148
+ for x in prange(nx):
149
+ for y in range(ny):
150
+ for z in range(nz):
151
+ if not fluid[x, y, z]:
152
+ out[x, y, z, 0] = out[x, y, z, 1] = out[x, y, z, 2] = 0.0
153
+ continue
154
+ jx = -0.5 * force[0]
155
+ jy = -0.5 * force[1]
156
+ jz = -0.5 * force[2]
157
+ for i in range(1, 19):
158
+ v = pops[x, y, z, i]
159
+ jx += c[i, 0] * v
160
+ jy += c[i, 1] * v
161
+ jz += c[i, 2] * v
162
+ out[x, y, z, 0] = jx
163
+ out[x, y, z, 1] = jy
164
+ out[x, y, z, 2] = jz
165
+
166
+
167
+ @njit(cache=True, parallel=True)
168
+ def _flux(pops, fluid, c, out): # pragma: no cover
169
+ """The mass flux of the fluid (``out``: its three components summed over the nodes):
170
+ that of the populations which, after their collision, leave a node for a neighbour in
171
+ the pores. Mass is conserved exactly: at the steady state this flux is the same
172
+ through every section of the cell, and zero where the pores are closed (which the
173
+ momentum of the nodes is not, next to a wall that the force pushes on)."""
174
+ nx, ny, nz = fluid.shape
175
+ sx = np.zeros(nx)
176
+ sy = np.zeros(nx)
177
+ sz = np.zeros(nx)
178
+ for x in prange(nx):
179
+ ax, ay, az = 0.0, 0.0, 0.0
180
+ for y in range(ny):
181
+ for z in range(nz):
182
+ if not fluid[x, y, z]:
183
+ continue
184
+ for i in range(1, 19):
185
+ if fluid[(x + c[i, 0]) % nx, (y + c[i, 1]) % ny, (z + c[i, 2]) % nz]:
186
+ v = pops[x, y, z, i]
187
+ ax += c[i, 0] * v
188
+ ay += c[i, 1] * v
189
+ az += c[i, 2] * v
190
+ sx[x], sy[x], sz[x] = ax, ay, az
191
+ out[0], out[1], out[2] = sx.sum(), sy.sum(), sz.sum()
192
+
193
+
194
+ def pore_mask(image: VoxelImage, materials=None, pores=None) -> np.ndarray:
195
+ """The voxels of the pores of an image (a boolean array): those of the phases
196
+ ``pores`` (a phase or several), or of the void phases of ``materials``."""
197
+ if not isinstance(image, VoxelImage):
198
+ raise TypeError("the flow through the pores is solved on a VoxelImage")
199
+ data = np.asarray(image.data)
200
+ if data.dtype.kind not in "iub":
201
+ raise ValueError("the flow needs an integer phase image")
202
+ if pores is None:
203
+ if materials is None:
204
+ raise ValueError("give the materials (their voids are the pores) or the pores")
205
+ pores = [p for p, m in materials.items() if getattr(m, "void", False)]
206
+ if not pores:
207
+ raise ValueError("flow: no pore (a void phase) in the materials")
208
+ phases = np.atleast_1d(np.asarray(pores)).astype(np.int64)
209
+ return np.isin(data, phases)
210
+
211
+
212
+ @dataclass
213
+ class StokesFlow:
214
+ """The steady creeping flow of a periodic voxel image under a unit macroscopic
215
+ pressure gradient along ``-direction`` (a unit vector), in the units of the image:
216
+ ``velocity``, the filtration velocity times the viscosity (``-k . G``: a row of the
217
+ permeability for a direction along an axis); ``porosity``; ``steps`` of the lattice
218
+ Boltzmann method and the estimated relative ``error`` of the mean velocity left;
219
+ ``field``: ``eta v`` at each voxel (x, y, z, 3; zero in the solid) when asked for."""
220
+
221
+ direction: np.ndarray
222
+ velocity: np.ndarray
223
+ porosity: float
224
+ steps: int
225
+ error: float
226
+ time: float = 0.0
227
+ field: np.ndarray | None = field(default=None, repr=False)
228
+
229
+
230
+ def stokes_flow(
231
+ image: VoxelImage,
232
+ direction,
233
+ *,
234
+ materials=None,
235
+ pores=None,
236
+ tol: float = 1e-4,
237
+ max_steps: int | None = None,
238
+ relaxation: float = 4.0,
239
+ fields: bool = False,
240
+ ) -> StokesFlow:
241
+ """The creeping flow through the pores of a periodic image driven along
242
+ ``direction`` (see the module). ``pores``: the phases of the fluid (by default the
243
+ void phases of ``materials``); ``tol``: the relative error of the mean velocity at
244
+ which the march to the steady state stops; ``max_steps``: at most that many steps (by
245
+ default 200 times the largest size of the image in voxels, at least 20000);
246
+ ``relaxation``: the time ``tau+`` (viscosity ``(tau+ - 1/2) / 3`` of the lattice: the
247
+ steady flow does not depend on it, the number of steps does); ``fields``: keep the
248
+ velocity field."""
249
+ fluid = np.ascontiguousarray(pore_mask(image, materials, pores))
250
+ spacing = np.asarray(image.spacing, dtype=float)
251
+ if not np.allclose(spacing, spacing[0], rtol=1e-9):
252
+ raise ValueError(f"flow: cubic voxels (the lattice), got the spacing {tuple(spacing)}")
253
+ if not image.periodic:
254
+ log.info("flow: the image is treated as the cell of a periodic medium")
255
+ if not relaxation > 0.5:
256
+ raise ValueError("relaxation: tau+ > 1/2")
257
+ g = np.asarray(direction, dtype=float).ravel()
258
+ if g.shape != (3,) or not np.linalg.norm(g) > 0:
259
+ raise ValueError("direction: a vector of three components")
260
+ g = g / np.linalg.norm(g)
261
+ h = float(spacing[0])
262
+ porosity = float(fluid.mean())
263
+ t0 = time.perf_counter()
264
+ if porosity == 0.0:
265
+ return StokesFlow(g, np.zeros(3), 0.0, 0, 0.0)
266
+ nu = (relaxation - 0.5) / 3.0
267
+ om_plus = 1.0 / relaxation
268
+ om_minus = 1.0 / (0.5 + MAGIC / (relaxation - 0.5))
269
+ scale = 1e-6 # of the force: the flow is linear, the populations stay near rest
270
+ force = scale * g
271
+ old = np.empty((*fluid.shape, 19))
272
+ old[...] = _W
273
+ new = np.empty_like(old)
274
+ total = np.zeros(3)
275
+ limit = int(max_steps) if max_steps else max(20000, 200 * max(fluid.shape))
276
+ check = 50
277
+ previous = np.zeros(3) # the mean momentum at the last check, and its change
278
+ change = np.zeros(3)
279
+ limit_value, error, steps = None, float("inf"), 0
280
+ reached = False # the tolerance at the last check: it must hold twice in a row
281
+ velocity = np.zeros(3)
282
+ while steps < limit:
283
+ checkpoint()
284
+ for _ in range(check // 2): # the two arrays in turn
285
+ _step(old, new, fluid, force, om_plus, om_minus, _C, _W, _OPP)
286
+ _step(new, old, fluid, force, om_plus, om_minus, _C, _W, _OPP)
287
+ steps += check
288
+ _flux(old, fluid, _C, total)
289
+ mean = total / fluid.size
290
+ delta = mean - previous
291
+ along, d, dc = float(mean @ g), float(delta @ g), float(change @ g)
292
+ velocity = mean
293
+ if steps >= 200 and abs(along) * nu / scale < 1e-9:
294
+ # no path through the pores (a permeability below 1e-9 voxel^2): a fluid at rest
295
+ velocity, error = np.zeros(3), 0.0
296
+ break
297
+ if along > 0.0 and dc != 0.0:
298
+ ratio = d / dc
299
+ if 0.0 <= ratio < 1.0:
300
+ # the changes decay geometrically: what is left of them (Aitken), added
301
+ # to the mean unless the field itself is asked for
302
+ rest = ratio / (1.0 - ratio)
303
+ error = abs(d) * rest / along
304
+ if not fields:
305
+ velocity = mean + delta * rest
306
+ value = float(velocity @ g)
307
+ if limit_value is not None and value != 0.0:
308
+ error = min(error, abs(value - limit_value) / abs(value))
309
+ limit_value = value
310
+ else:
311
+ error, limit_value = abs(d) / along, None
312
+ if error <= tol and reached:
313
+ break
314
+ reached = error <= tol
315
+ previous, change = mean, delta
316
+ velocity = velocity * (nu / scale) * h * h
317
+ out = StokesFlow(g, velocity, porosity, steps, float(error), time.perf_counter() - t0)
318
+ if fields:
319
+ momentum = np.empty((*fluid.shape, 3))
320
+ _momentum(old, fluid, force, _C, momentum)
321
+ out.field = momentum * (nu / scale) * h * h
322
+ return out
323
+
324
+
325
+ def permeability_tensor(
326
+ image: VoxelImage, materials=None, *, pores=None, axes=(0, 1, 2), **options
327
+ ) -> dict:
328
+ """The permeability tensor of a periodic voxel image (see the module): one flow per
329
+ axis of ``axes`` (the others are left out: their rows and columns zero), symmetrized.
330
+
331
+ Returns ``"tensor"`` (3 x 3, in the squared unit of the spacing of the image), its
332
+ entries ``k11`` ... ``k12``, ``"mean"`` (the mean of the diagonal over the ``axes``),
333
+ the ``"porosity"``, the ``"steps"`` of the three flows and the largest ``"error"``
334
+ estimated. ``options``: those of :func:`stokes_flow` (``tol``, ``max_steps``,
335
+ ``relaxation``)."""
336
+ axes = tuple(int(a) for a in axes)
337
+ if not axes or any(a not in (0, 1, 2) for a in axes) or len(set(axes)) != len(axes):
338
+ raise ValueError("axes: among 0, 1, 2")
339
+ tensor = np.zeros((3, 3))
340
+ steps, error, porosity = 0, 0.0, 0.0
341
+ for a in axes:
342
+ unit = np.zeros(3)
343
+ unit[a] = 1.0
344
+ flow = stokes_flow(image, unit, materials=materials, pores=pores, **options)
345
+ tensor[:, a] = flow.velocity
346
+ steps += flow.steps
347
+ error = max(error, flow.error)
348
+ porosity = flow.porosity
349
+ keep = np.zeros(3, dtype=bool)
350
+ keep[list(axes)] = True
351
+ tensor[~keep] = 0.0
352
+ tensor = 0.5 * (tensor + tensor.T)
353
+ out = {
354
+ "tensor": tensor,
355
+ "mean": float(np.mean([tensor[a, a] for a in axes])),
356
+ "porosity": porosity,
357
+ "steps": int(steps),
358
+ "error": float(error),
359
+ }
360
+ out.update({f"k{n}": float(tensor[i, j]) for (i, j), n in zip(VOIGT, VOIGT_NAMES, strict=True)})
361
+ return out