API reference¶
The Python interface of morphoGen, written from its docstrings. Each package lists its
public names, those of its __all__ (from morphogen.homogenization import Material),
linked to the module that defines them, then its modules; each module documents what it
defines. The commands and the keys of the configuration files are described in the
configuration reference. The graphical interface (morphogen.gui),
the compiled kernels (morphogen.kernels) and the functions behind the commands
(morphogen.cli) are not part of it. Which of these names stay stable from one version
to the next is the subject of Stability of the interface.
The package at a glance¶
import morphogen as mg gives the domains and images (mg.Domain, mg.VoxelImage),
the models (mg.models, mg.model_from_config, mg.list_models), mg.export and the
packages used most (mg.analysis, mg.mesh, mg.io, mg.homogenization, mg.rve…);
the others are imported by name (from morphogen import fracture). The packages follow
the steps of a study:
Step |
Package |
What it holds |
|---|---|---|
Generate |
the 40 models of microstructures, their realizations and their theory |
|
cellular automata and lattice growth processes, on grids and tilings |
||
tile assemblies, strut frameworks and their rigidity, searches of design spaces |
||
topology optimization of periodic cells by inverse homogenization |
||
isogeometric analysis of NURBS geometries and their shape optimization |
||
Describe |
conforming, exact and voxel meshes |
|
images, meshes, geometries and the inputs of other codes, read and written |
||
sections, figures, 3D views and videos |
||
Measure |
the morphological measures of images, percolation, stereology |
|
the closed forms of stochastic geometry used by the models |
||
crystallographic textures and orientation maps |
||
Compute |
apparent properties, materials and behaviours, loading paths, the solvers |
|
cohesive zones, cracks and their growth, the phase field |
||
contact, self-contact and friction of the surfaces of a mesh |
||
micromorphic continua: the microfoam model, micromorphic damage |
||
transient diffusion, oxidation, ageing and hygromorphs |
||
behaviours learned from data |
||
symmetry groups of periodic cells, for the patterns after buckling |
||
the choice of the device of the FFT solvers |
||
Study |
the statistical size of the representative volume element |
|
the database of the results and the Ashby charts |
||
configuration files, their runs, in parallel and on clusters |
||
Applications |
metal sheets architectured by localized laser treatment |
|
explicit dynamics with OpenRadioss |
||
Foundations |
boxes and grids, voxel images, spheres and segments |
|
|
laws of sizes and of orientations, reproducible random numbers |
|
threads, and the stop of long computations |