FullMag

Last changes: Documentation changelog

FullMag logo

Finite-difference and finite-element micromagnetics

Authors

Dr Mateusz Zelent
RPTU Kaiserslautern-Landau

Dr Mateusz Gołebiewski
Adam Mickiewicz University, Poznań

Prof. Philipp Pirro
RPTU Kaiserslautern-Landau

Documentation organized by ownership

Frontend, backend, and Python API are separate documentation families.

The documentation tree follows the layer that owns a fact. Control Room behavior is documented under Frontend; numerical realization, physics, and runtime contracts under Backend; public authoring commands and parameters under Python API.

How to use this documentation

Question

Canonical branch

How do I operate the browser application?

Frontend

What algorithm and data structure does the solver execute?

Backend

Which Python command or parameter should I use?

Python API

How was a capability validated?

Validation

How do I run a first study?

Getting started

The same concept may appear in more than one branch, but each page has one owner. For example, FEM meshing is split into:

  • Frontend: panels, drafts, Apply/Build transactions, reports, and visualization;

  • Backend: Gmsh/MFEM realization, topology, conformity, fallbacks, and numerical validity;

  • Python API: FEM, PerObjectMeshRecipe, study.universe.mesh(...), object mesh helpers, parameter tables, and ProblemIR lowering.

Simulation data flow

Python API or Control Room
            │
            ▼
      canonical ProblemIR
            │
            ▼
 planner and capability resolution
            │
            ▼
 backend mesh / operators / stages
            │
            ▼
 artifacts, diagnostics, provenance

Requested intent and resolved execution are never treated as the same object. A mesh parameter entered in Python or the UI is a request; the generated mesh, its topology, quality, markers, fallbacks, and digest are backend evidence.

Citation

Until a versioned release with a persistent identifier is available, cite the repository and exact commit used for the reported result.

Bibliography

No independent scientific model is introduced by this navigation page. Use the bibliography on the selected terminal page; this statement is an explicit applicability boundary, not an omitted reference.

Source-code index

This is a navigation page and introduces no standalone implementation symbol. The exact source-code index is maintained by the selected terminal page.