# μfem

> μfem is a Python finite-element library (built on MFEM) for electromagnetic,
> thermal, and structural simulation. Simulations are written as Python scripts;
> geometry/meshing use gmsh or netgen and post-processing uses ParaView. There
> is no GUI.

If you are an AI agent setting up a simulation: install μfem, read the framework
and model pages below for the physics you need, and copy the closest runnable
case from <https://github.com/Raiden-Numerics/mufem>. Markers bind to mesh
region names, so construct them only after a mesh is loaded. Confirm exact
constructor arguments by introspecting the installed package.

## Start here

- [Installation](https://raiden-numerics.github.io/mufem-doc/getting_started/installation.html): supported platforms and `pip install --pre mufem`.
- [Examples](https://raiden-numerics.github.io/mufem-doc/getting_started/examples.html): worked cases; full sources at github.com/Raiden-Numerics/mufem.
- [Capabilities](https://raiden-numerics.github.io/mufem-doc/getting_started/capabilities.html): what physics and features are supported.

## Framework

- [Simulation](https://raiden-numerics.github.io/mufem-doc/framework/simulation.html): the top-level object, lifecycle, and accessors.
- [Runners](https://raiden-numerics.github.io/mufem-doc/framework/runners.html): steady and unsteady drivers that advance the solution.
- [Mesh](https://raiden-numerics.github.io/mufem-doc/framework/mesh.html): loading, scaling, and querying meshes.
- [Markers](https://raiden-numerics.github.io/mufem-doc/framework/markers.html): the `@ Vol` / `@ Bnd` syntax that binds physics, materials, and conditions to mesh regions.
- [Models](https://raiden-numerics.github.io/mufem-doc/framework/models.html): how physics models are added and managed.
- [Coefficients](https://raiden-numerics.github.io/mufem-doc/framework/coefficients.html): coefficient functions used as model inputs.
- [Reports and Monitors](https://raiden-numerics.github.io/mufem-doc/framework/reports_and_monitors.html): scalar outputs and run-time metrics.
- [Visualization](https://raiden-numerics.github.io/mufem-doc/framework/visualization.html): exporting fields for ParaView.

## Models: Electromagnetics

- [Overview](https://raiden-numerics.github.io/mufem-doc/models/electromagnetics/overview.html): the electromagnetic model family.
- [Electrostatics](https://raiden-numerics.github.io/mufem-doc/models/electromagnetics/electrostatics/model.html): static electric fields; includes the exact coefficient/field names.
- [Time-Domain Magnetic](https://raiden-numerics.github.io/mufem-doc/models/electromagnetics/time_domain_magnetic/model.html): transient magnetics.
- [Time-Harmonic Magnetic](https://raiden-numerics.github.io/mufem-doc/models/electromagnetics/time_harmonic_magnetic/model.html): frequency-domain magnetics.
- [Time-Harmonic Maxwell](https://raiden-numerics.github.io/mufem-doc/models/electromagnetics/time_harmonic_maxwell/model.html): full-wave Maxwell.
- [Excitation Coil](https://raiden-numerics.github.io/mufem-doc/models/electromagnetics/excitation_coil/model.html): coil current excitation.

## Models: Mechanical

- [Solid Mechanics](https://raiden-numerics.github.io/mufem-doc/models/mechanical/solid_mechanics/model.html): linear elastic stress/displacement.
- [Solid Temperature](https://raiden-numerics.github.io/mufem-doc/models/mechanical/solid_temperature/model.html): heat transfer in solids.

## Optional

- [Theory Overview](https://raiden-numerics.github.io/mufem-doc/theory/overview.html): finite-element background (not required to run simulations).
- [Licensing](https://raiden-numerics.github.io/mufem-doc/getting_started/licensing.html): terms and tiers.