Yggdrasil Documentation

View Yggdrasil’s source code at Github

User Guide:

• Introduction
  • Purpose of Yggdrasil
  • Overview of Capabilities
  • Intended Audience
• Installation
• Getting Started
  • First run: a simple example
• Core Concepts
  • Python Scripting of the C++ Modules
  • Dimensionality
  • Units and Constants
  • Fields and Nodelists
  • Generators
  • Physics Packages
  • Equations of State
  • Opacity/Conductivity
  • Mesh/Grid Handling
  • Boundary Conditions
  • Integrators
  • The Controller
  • The Flow of the Script
• Examples
  • cherenkov.py
  • diffractionGrating.py
  • doubleSlit.py
  • imageToStringArt.py
  • phase_coupling.py
  • plinko.py
  • reactionDiffusion.py
  • tsunami.py
  • voronoi_diag.py
  • waveLogo.py
  • Simple Test Cases
• Advanced Topics
  • Periodic Work
  • Calculators and Linear Algebra
  • Implicit vs. Explicit Time integration

Programming Guide:

• Templating
• Class Guides
  • Physics Classes
  • Integrator Classes
  • Equations of State
• Python Binding