tetmag

a micromagnetic finite-element solver

https://github.com/r-hertel/tetmag

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (15.9%) to scientific vocabulary

Last synced: 10 months ago · JSON representation ·

Repository

a micromagnetic finite-element solver

Basic Info

Host: GitHub
Owner: R-Hertel
License: agpl-3.0
Language: C++
Default Branch: main
Size: 62.6 MB

Statistics

Stars: 14
Watchers: 0
Forks: 2
Open Issues: 0
Releases: 2

Created almost 5 years ago · Last pushed over 1 year ago

Metadata Files

Readme License Citation Authors Codemeta

README.md

GitHub Forks GitHub Stars GitHub Release Date

tetmag is a finite-element software for general-purpose micromagnetic simulations.

Installation

Requirements

For ubuntu 22.04: Install the following

bash sudo apt-get install build-essential cmake git wget sudo apt-get install libboost-all-dev libeigen3-dev libnetcdf-dev libvtk9-dev sudo apt-get install liblapack-dev libglu1 libpthread-stubs0-dev sudo apt-get install libxrender-dev libxcursor-dev libxft-dev libxinerama-dev sudo apt-get install qtbase5-dev qtdeclarative5-dev

Optional:
- GPU-acceleration with CUDA (version 10.1 or higher needed)

For more detailed installation instructions, see the tetmag documentation.

Compilation

bash git clone https://github.com/R-Hertel/tetmag.git cd tetmag && mkdir build && cd build cmake .. make -j$(nproc)

Notes:
- Installation on Windows and other linux distributions should be possible, but hasn't been tested.
- The software can be compiled and run on MacOS (tested on macOS 13.3.1 with Apple M1 processor) if the required libraries are installed.
- An internet connection is necessary during the build process.

Additional software

Although tetmag is a standalone software that -unlike plugin-type applications- does not require a specific framework to operate, its workflow involves a series of processes that must be handled by other applications. This concerns two categories of operations:

Preprocessing - Definition of the sample geometry and finite-element mesh generation
Postprocessing - Visualization and analysis of the results

The following software can accomplish these tasks:

ParaView - Data visualization
gmsh or netgen - Finite-element mesh generation
FreeCAD - Design of three-dimensional objects

The documentation describes the required pre- and postprocessing steps and shows how tetmag interacts with this external software.

Usage

For a short introduction to the usage of tetmag see the documentation at https://tetmag.readthedocs.io.
Examples of simple simulation studies with tetmag can be found in the examples directory.

Credits

The tetmag software is powered by these awesome projects: - AMGCL - Iterative solution of sparse systems - SUNDIALS / CVODE - Solution of ordinary differential equation systems - Eigen - Linear algebra - H2Lib - Hierarchical matrix data compression - VTK and gmsh - I/O of finite-element mesh data

CUDA / Thrust - GPU acceleration
boost - Powerful C++ libraries
CMake - Build system generator

Owner

Login: R-Hertel
Kind: user

Repositories: 1
Profile: https://github.com/R-Hertel

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: tetmag
message: >-
  a finite-element software for general-purpose
  micromagnetic simulations
type: software
authors:
  - given-names: Riccardo
    family-names: Hertel
    email: riccardo.hertel@ipcms.unistra.fr
    affiliation: CNRS - IPCMS and Université Strasbourg
    orcid: 'https://orcid.org/0000-0002-0646-838X'
repository-code: 'https://github.com/R-Hertel/tetmag'
license: AGPL-3.0

CodeMeta (codemeta.json)

{
  "@context": "https://w3id.org/codemeta/3.0",
  "type": "SoftwareSourceCode",
  "applicationCategory": "Physics, Nanomagnetism",
  "author": [
    {
      "id": "https://orcid.org/0000-0002-0646-838X",
      "type": "Person",
      "affiliation": {
        "type": "Organization",
        "name": "CNRS, Universit de Strasbourg, Institut de Physique et Chimie des Matriaux de Strasbourg (IPCMS), 67000 Strasbourg, France"
      },
      "email": "riccardo.hertel@ipcms.unistra.fr",
      "familyName": "Hertel",
      "givenName": "Riccardo"
    },
    {
      "type": "Role",
      "schema:author": "https://orcid.org/0000-0002-0646-838X",
      "roleName": "Primary developer and creator of tetmag",
      "startDate": "2016-10-01"
    }
  ],
  "codeRepository": "https://github.com/R-Hertel/tetmag",
  "datePublished": "2023-03-14",
  "description": "\"tetmag\" is a micromagnetic finite-element simulation software designed to simulate the magnetic properties of three-dimensional ferromagnetic nanostructures. It is capable of handling a wide range of micromagnetic simulation tasks, including static magnetization textures, hysteresis loops, dynamic switching processes, high-frequency oscillations, and current-driven magnetization dynamics. Development started in 2016 and the first public release was in 2023.",
  "keywords": [
    "Micromagnetism",
    "GPU acceleration",
    "Finite-Element Method",
    "FEM-BEM coupling"
  ],
  "license": "https://spdx.org/licenses/AGPL-3.0-or-later",
  "name": "tetmag",
  "operatingSystem": [
    "Linux",
    "macOS"
  ],
  "programmingLanguage": [
    "C++",
    "CUDA",
    "C",
    "CMake"
  ],
  "relatedLink": "https://tetmag.readthedocs.io/",
  "softwareRequirements": "VTK, ParaView",
  "version": "1.7.8",
  "issueTracker": "https://github.com/R-Hertel/tetmag/issues"
}

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science