API Reference¶
Auto-generated from module docstrings by mkdocstrings.
The reference is organized per top-level composite, mirroring the session object's layout:
| Page | Access | Purpose |
|---|---|---|
| Session | apeGmsh(...) |
Top-level session lifecycle and composite wiring |
| Model | g.model |
OCC geometry (geometry, boolean, transforms, io, queries) |
| Parts | g.parts |
Part registry and assembly bookkeeping |
| Mesh | g.mesh |
Meshing (generation, sizing, field, structured, editing, queries, partitioning) |
| Constraints | g.constraints |
Solver-agnostic constraint defs, records, resolver |
| Loads | g.loads |
Load defs, records, resolver |
| Masses | g.masses |
Mass defs, records, resolver |
| FEM Broker | g.mesh.queries.get_fem_data() |
FEMData snapshot container |
| OpenSees | apeSees(fem) |
OpenSees bridge — post-session explicit-constructor (nDMaterial, element, fix, mass, pattern, recorders, tcl/py/h5/run) |
| Results | Results |
Post-processing container |
| Selection | .select() |
Unified daisy-chainable selection idiom across all four levels |
| Viewers | Qt/PyVista model and mesh viewers | |
| Viz | g.plot, etc. |
Matplotlib, selection, VTK export |
Note
Private members (names starting with _) are filtered out by
default. Sub-composite implementation modules (_mesh_generation,
_model_geometry, etc.) are documented under their parent
composite page.
Utilities¶
Top-level helpers re-exported from apeGmsh that don't have a
dedicated composite page:
apeGmsh.workdir— context manager for the working directory.apeGmsh.preview— notebook viewer.apeGmsh.settings,apeGmsh.theme_editor— viewer preferences and theme editor (see Viewers).SelectionPickeris a back-compat alias forModelViewer.