.. tetmag documentation master file, created by
   sphinx-quickstart on Thu Jun 29 14:08:16 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

tetmag documentation
=====================

tetmag is a micromagnetic finite-element simulation software.
It simulates the magnetization field and its evolution in time in three-dimensional ferromagnetic nanostructures of arbitrary shape.
As a general-purpose micromagnetic solver, tetmag can treat a large
variety of standard tasks in micromagnetic simulations, such as calculating
static magnetization textures, hysteresis loops, dynamic switching processes,
magnetic high-frequency oscillations, or the current-driven magnetization dynamics.

By exploiting advanced data compression methods, highly efficient solvers and
integrators, as well as GPU acceleration, tetmag is suitable for
high-performance computations and large-scale micromagnetic simulations.

The source code is available under AGPL-3.0 license at https://github.com/R-Hertel/tetmag .


.. toctree::
   :maxdepth: 2

   ./usage/installation
   ./usage/quickstart
   ./examples/example1
   ./examples/example2
   ./examples/example3
   ./examples/example4
   ./issues/compile