FIRM3D Logo

Contents:

  • Installation
    • macOS
    • Perlmutter (NERSC)
    • Manual Installation
  • Magnetic Field Classes
    • Overview
    • BoozerAnalytic
      • Usage Example
    • BoozerRadialInterpolant
      • Usage Example
      • Preparing booz_xform Equilibrium
    • InterpolatedBoozerField
      • Usage Example
    • Field Evaluation
  • Shear Alfvén Wave Field Classes
    • ShearAlfvenHarmonic
      • Usage Example
    • ShearAlfvenWavesSuperposition
      • Usage Example
    • Wave Evaluation
    • Radial Profiles
  • Guiding Center Integration
    • Unperturbed Guiding Center Integration
      • Vacuum Mode (gc_vac)
      • General Mode (gc)
    • Perturbed Guiding Center Integration
      • Vacuum Mode (gc_vac)
      • General Mode (gc)
    • Usage Examples
      • Unperturbed Tracing
      • Perturbed Tracing
  • Poincaré Maps
    • Overview
    • Trapped Poincaré Maps
    • Passing Poincaré Maps
    • Perturbed Passing Poincaré Maps
    • Data Access and Visualization
    • Performance Considerations
  • Stopping Criteria
    • Available Stopping Criteria
      • MaxToroidalFluxStoppingCriterion
      • MinToroidalFluxStoppingCriterion
      • ZetaStoppingCriterion
      • VparStoppingCriterion
      • ToroidalTransitStoppingCriterion
      • IterationStoppingCriterion
      • StepSizeStoppingCriterion
    • Usage Examples
      • Multiple Stopping Criteria
    • Interpreting Results
  • Trajectory Saving
    • Trajectory Data (res_tys)
    • Hits Data (res_hits)
    • Multiple Hit Planes
    • Memory Management
  • Magnetic Axis Handling
    • Standard Boozer Coordinates (axis=0)
    • Pseudo-Cartesian Coordinates (axis=1)
    • Pseudo-Cartesian Coordinates (axis=2)
  • Solvers and Solver Options
    • Default Solver (Runge-Kutta Dormand-Prince 5(4))
    • Symplectic Solver
    • Solver Options Reference
      • Default Solver Options
      • Symplectic Solver Options
  • API Reference
    • Magnetic Field Classes
    • Trajectory Integration
    • Stopping Criteria
    • Shear Alfvén Wave Classes
    • Utility Functions
      • print()
      • proc0_print()
      • setup_logging()
    • Plotting Utilities
      • plot_trajectory_poloidal()
      • plot_trajectory_overhead_cyl()
    • Core Types and Utilities
      • isbool()
      • isnumber()
      • Struct
      • unique()
      • ImmutableId
        • ImmutableId.id
        • ImmutableId.__init__()
      • InstanceCounterMeta
        • InstanceCounterMeta.__init__()
      • RegisterMeta
        • RegisterMeta.__init__()
      • nested_lists_to_array()
      • WeakKeyDefaultDict
        • WeakKeyDefaultDict.__init__()
      • parallel_loop_bounds()
      • align_and_pad()
      • allocate_aligned_and_padded_array()
    • SAW (Shear Alfvén Wave) Module
      • EigModeASCI
        • EigModeASCI.sim_dir
        • EigModeASCI.file_path
        • EigModeASCI.num_eigenmodes
        • EigModeASCI.num_fourier_modes
        • EigModeASCI.num_radial_points
        • EigModeASCI.modes
        • EigModeASCI.egn_values
        • EigModeASCI.s_coords
        • EigModeASCI.egn_vectors
        • EigModeASCI.load_data()
        • EigModeASCI.get_nearest_eigenvector()
        • EigModeASCI.condition_number()
        • EigModeASCI.__init__()
      • AE3DEigenvector
        • AE3DEigenvector.eigenvalue
        • AE3DEigenvector.s_coords
        • AE3DEigenvector.harmonics
        • AE3DEigenvector.from_eig_mode_asci()
        • AE3DEigenvector.export_to_numpy()
        • AE3DEigenvector.export_to_csv()
        • AE3DEigenvector.load_from_numpy()
        • AE3DEigenvector.__init__()
      • plot_ae3d_eigenmode()
      • continuum_from_ae3d()
      • Harmonic
        • Harmonic.m
        • Harmonic.n
        • Harmonic.amplitudes
        • Harmonic.m
        • Harmonic.n
        • Harmonic.amplitudes
        • Harmonic.__init__()
      • ModeContinuum
        • ModeContinuum.__init__()
        • ModeContinuum.set_poloidal_mode()
        • ModeContinuum.set_toroidal_mode()
        • ModeContinuum.set_points()
        • ModeContinuum.get_poloidal_mode()
        • ModeContinuum.get_toroidal_mode()
        • ModeContinuum.get_flux_surfaces()
        • ModeContinuum.get_frequencies()
        • ModeContinuum.add_point()
      • AlfvenSpecData
        • AlfvenSpecData.__new__()
        • AlfvenSpecData.from_dir()
        • AlfvenSpecData.nonzero_beta()
        • AlfvenSpecData.sort_by_s()
        • AlfvenSpecData.get_modes()
        • AlfvenSpecData.condition_number()
    • Class Hierarchy
  • Examples and Tutorials
    • Available Example Scripts
      • Fusion Distribution
      • Fusion Distribution with Perturbations
      • Passing Frequencies
      • Passing Map Analysis
      • Trapped Particle Analysis
      • Trajectory Visualization
      • Resolution Studies
      • Uniform Distributions
      • AE3D Integration
    • Running All Examples
  • Contributing to FIRM3D
    • Quick Start
    • Code Style
    • Development Workflow
FIRM3D
  • Search

© Copyright 2024, FIRM3D Contributors.

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