3 User manual

• 3.1 Mathematical basics
  • 3.1.1 Curvilinear coordinates
    • 3.1.1.1 Polar coordinates
    • 3.1.1.2 Spherical coordinates
    • 3.1.1.3 Cylindrical coordinates
  • 3.1.2 Spatial discretization
  • 3.1.3 Temporal evolution
• 3.2 Basic usage
  • 3.2.1 Defining the geometry
  • 3.2.2 Initializing a field
  • 3.2.3 Specifying the PDE
  • 3.2.4 Running the simulation
  • 3.2.5 Analyzing the results
• 3.3 Advanced usage
  • 3.3.1 Boundary conditions
  • 3.3.2 Expressions
  • 3.3.3 Custom PDE classes
  • 3.3.4 Low-level operators
    • 3.3.4.1 Differential operators
    • 3.3.4.2 Field integration
    • 3.3.4.3 Field interpolation
    • 3.3.4.4 Inner products
  • 3.3.5 Numba-accelerated PDEs
  • 3.3.6 Configuration parameters
• 3.4 Performance
  • 3.4.1 Measuring performance
  • 3.4.2 Improving performance
  • 3.4.3 Multiprocessing using MPI
• 3.5 Contributing code
  • 3.5.1 Structure of the package
  • 3.5.2 Extending functionality
  • 3.5.3 Design choices
  • 3.5.4 Coding style
  • 3.5.5 Running unit tests
• 3.6 Citing the package
• 3.7 Code of Conduct
  • 3.7.1 Our Pledge
  • 3.7.2 Our Standards
  • 3.7.3 Our Responsibilities
  • 3.7.4 Scope
  • 3.7.5 Enforcement
  • 3.7.6 Attribution