Python API Reference

This page is generated from the Python objects exposed by HASEonGPU. It is the reference page for signatures, class members, functions, and direct object lookup. For workflow-oriented explanations and complete simulation examples, start with the Python Interface Guide.

Public API

Geometry and gain media

`Grid`	Regular rectangular helper that generates a 2D triangular base mesh.
`MeshTopology`	Triangular base mesh extruded through z levels into wedge prisms.
`GainMedium`	Mesh plus material/state properties required by ASE and pump models.
`GainMediumGeometry`
`Gmsh`	gmsh-backed mesh data accepted by `MeshTopology`.

Spectra, pump, and ASE configuration

`CrossSectionData`	Absorption and emission spectra for ASE and pump calculations.
`LaserProperties`	Mutable low-level laser-property store.
`SpectralDecomposition`
`PumpRadiationProfile`	Generic pump-radiation profile consumed by pump transport solvers.
`PumpProperties`	Pump-beam settings used to raise the excited-state fraction `beta`.
`PhiASE`	Configure and run the ASE flux calculation for one gain-medium state.

Simulation and time integration

`Simulation`	High-level pump, ASE, fluorescence, and time-integration loop.
`TimeStepState`	Snapshot handed to `onStep` callbacks after a completed time step.
`TimeSteppedSimulation`
`TimeDerivative`	Derivative evaluation produced during one time-integration stage.
`TimeIntegrationResult`	Return object from `TimeIntegrationSolver.step(...)`.
`TimeIntegrationSolver`	Base protocol for custom beta time-integration solvers.
`ExplicitEuler`	First-order explicit Euler beta update using one RHS evaluation.
`ExponentialEuler`	Euler source update with analytical fluorescence decay over `timeStep`.
`FrozenPhiAseRungeKutta4`	Fourth-order beta update with one frozen ASE transport solve per step.
`Heun`	Second-order predictor-corrector beta update using two RHS evaluations.
`ImplicitEuler`	Fixed-point implicit Euler beta update for stiff beta dynamics.
`Midpoint`	Second-order midpoint beta update using a half-step RHS evaluation.
`RungeKutta4`	Classical fourth-order Runge-Kutta beta update using four RHS evaluations.

Pump solvers and utilities

`BetaInt3PumpSolver`
`BetaIntegrationSolver`
`BetaIntegrationGaussianSolver`	Default `PumpProperties` solver for a super-Gaussian pump beam.
`OneDimensionalZTraversal`	Pump solver using z-aligned 1D traversal.
`oneDimensionalZTraversalPumpRate`	Return frozen-state pump contribution using a 1D z traversal model.
`Constants`	Physical constants used by the pump energy-to-photon conversion.
`LegacyGridDataBetaVolumeMapper`	Map point-centered `betaCells` to prism-centered `betaVolume`.
`calcGainFromState`	Calculate point-shaped local small-signal gain from a `TimeStepState`.
`AlpakaBackends`	Namespace of backend strings accepted by `PhiASE` and `calcPhiASE`.
`vtkWedge`	Write scalar data on a wedge mesh to a legacy ASCII VTK file.
`writeGainMediumVtk`	Write a `GainMedium` as legacy ASCII VTK wedge cells.

Lower-level compatibility helpers

`calcPhiASE`	Run ASE using the historical direct Python signature.
`beta_int3Main`	Run one pump update over all transverse points and z levels.
`integrateLaserPump`	Return `betaCells` after applying the configured pump.
`runLaserPumpStep`	Return `betaCells` after applying the configured pump.

Module Summaries

These modules back the public API. They are documented for users who need to inspect implementation-level helpers or extension points.

`geometry.core`	Geometry, topology, and gain-medium state containers for Python users.
`geometry.msh`	gmsh import helpers for planar triangle meshes.
`geometry.vtk`	Read and write legacy ASCII VTK wedge meshes for gain media.
`laser`	Laser spectra and pump-beam configuration used by the Python interface.
`pumping`	Pump integration routines for evolving the excited-state fraction beta.
`simulation`	High-level Python simulation wrapper around pump, ASE, and time stepping.
`gainMap`	Gain calculation helpers for simulation state snapshots.
`timeIntegration`	Time-integration solvers for the point-level beta population arrays.
`vtkWedge`(file_name[, data, geometry, field, ...])	Write scalar data on a wedge mesh to a legacy ASCII VTK file.
`calcPhiASE`(points, trianglePointIndices, ...)	Run ASE using the historical direct Python signature.