NumBAT - The Numerical Brillouin Analysis Tool - User Guide

Release date: 11 September 2024

Contents:

• 1. Introduction to NumBAT
  • 1.1. Introduction
  • 1.2. Goals
  • 1.3. Development team
  • 1.4. Citing NumBAT
  • 1.5. Contributing to NumBAT
  • 1.6. Seeking assistance
  • 1.7. Release notes
  • 1.8. About our mascot
  • 1.9. Acknowledgements
• 2. Background theory
  • 2.1. What does NumBAT actually calculate?
  • 2.2. The finite element method in NumBAT
  • 2.3. Suggested reading on SBS and opto-elastic interactions in nanophotonics
• 3. Installing NumBAT
  • 3.1. Information for all platforms
  • 3.2. Installing on Linux
  • 3.3. Installing on MacOS
  • 3.4. Installing on Windows
  • 3.5. Building the documentation
  • 3.6. Seeking help with building NumBAT
• 4. Basic Usage
  • 4.1. A First Calculation
  • 4.2. General Simulation Procedures
  • 4.3. Script Structure
  • 4.4. Materials
  • 4.5. Waveguide Geometries
  • 4.6. User-defined waveguide geometries
  • 4.7. Mesh parameters
  • 4.8. Viewing the mesh
• 5. Tutorial
  • 5.1. Some Key Symbols
  • 5.2. Elementary Tutorials
  • 5.3. Intermediate tutorials
• 6. JOSA-B Tutorial Paper
  • 6.1. Introduction
• 7. Additional Literature Examples
  • 7.1. Example 1 – BSBS in a silica rectangular waveguide
  • 7.2. Example 2 – BSBS in a rectangular silicon waveguide
  • 7.3. Example 3 – BSBS in a tapered fibre - scanning widths
  • 7.4. Example 4 – FSBF in a waveguide on a pedestal
  • 7.5. Example 5 – FSBF in a waveguide without a pedestal
  • 7.6. Example 6 – BSBS self-cancellation in a tapered fibre (small fibre)
  • 7.7. Example 6b – BSBS self-cancellation in a tapered fibre (large fibre)
  • 7.8. Example 7 – FSBF in a silicon rib waveguide
  • 7.9. Example 8 – Intermodal FSBF in a silicon waveguide
  • 7.10. Example 9 – BSBS in a chalcogenide rib waveguide
  • 7.11. Example 10 – SBS in the mid-infrared
• 8. Technical details
  • 8.1. Supported crystal classes
  • 8.2. Required tensor components
• 9. Python Interface API
  • 9.1. numbat module
  • 9.2. materials module
  • 9.3. objects module
  • 9.4. mode_calcs module
  • 9.5. integration module
  • 9.6. plotting module
• 10. References
• 11. Indices and tables