OpenFerro

Getting Started

  • Installation
  • Quickstart

Theory

  • Crystalline system and Lattice Hamiltonian
  • Simulate the dynamics

Use OpenFerro

  • Logic of OpenFerro
  • Library of energy engines
  • Guide to Custom Energy Engine

Others

  • Units
  • Credits
  • FAQ

Contents:

  • OpenFerro Documentation
  • API Reference
OpenFerro
  • Overview: module code

All modules for which code is available

  • openferro.engine.elastic
  • openferro.engine.ewald
  • openferro.engine.ferroelectric
  • openferro.engine.magnetic
  • openferro.engine.multiferroic
  • openferro.field
  • openferro.integrator.base
  • openferro.integrator.llg
  • openferro.integrator.md
  • openferro.interaction
  • openferro.lattice
  • openferro.parallelism
  • openferro.reporter
  • openferro.simulation
  • openferro.system
  • openferro.units
  • openferro.utilities

© Copyright 2025, Pinchen Xie.

Built with Sphinx using a theme provided by Read the Docs.