Documentation

Warning This package is experimental and in development phase, breaking API changes may happen at any time.

Magpylib-Material-Response is an extension to the Magpylib library, providing magnetic field analysis for soft materials and demagnetization of hard magnets. Leveraging the Method of Moments, it calculates the self-consistent magnetic material response by meshing sources into an arbitrary number of unit cells.

Key features:

• apply_demag — self-consistent demagnetization of magpylib Collection objects, with per-cell scalar or anisotropic susceptibility and external field support.

• Two solvers, one physics — an exact dense solver and an FFT-accelerated iterative solver that agree to solver tolerance for any input; meshes with tens of thousands of cells solve in seconds.

• Analytical interactions — volume-averaged Newell tensors for cuboid cells (generalized to different cell sizes), point matching for everything else.

• Meshing helpers — cuboids, cylinders, and arbitrary closed surfaces via tetrahedral meshing (mesh_TriangularMesh, using TetGen).

Installation

pip install magpylib-material-response

or with conda:

conda install -c conda-forge magpylib-material-response

Tetrahedral meshing of TriangularMesh magnets requires the optional TetGen dependency:

pip install magpylib-material-response[tetgen]

See the documentation for a quickstart, worked examples, and the method description.

Getting started

• Quickstart
  • Setting material properties
  • Meshing helpers
  • Where to go next
• Examples

Reference

• Method of Moments for Demagnetization
  • 1. Physical model
  • 2. Method of Moments — general formulation
  • 3. The demagnetization tensor
  • 4. Solvers
  • 5. Optimizations
  • 6. Complete algorithm flow
  • 7. Complexity summary
  • 8. References
• API Reference
  • Demagnetization solver — demag
  • Meshing — meshing
  • Coil construction — polyline
  • Structure analysis and FFT kernels — demag_fft
  • Analytical Newell tensors — newell
  • Utilities
• Logging Configuration
  • Default Behavior
  • Enabling Logging
  • Configuration Options
  • Environment Variables
  • Disabling Logging
  • Custom Application-Side Configuration
  • Example Usage
  • See Also
• Saving and loading a demagnetized collection
  • Define sources, mesh and apply demagnetization
  • Save to disk
  • Reload and display
• Changelog
  • Unreleased
  • 0.4.0 - 2026-05-01
  • 0.3.1 - 2025-10-30
  • 0.3.0 - 2024-10-16
  • 0.2.1a0
  • 0.2.0a0

Indices and tables

• Index

• Module Index

• Search Page