hypnotoad_interface Module¶

G-EQDSK Readers¶

neso_fame.hypnotoad_interface.eqdsk_equilibrium(...) → TokamakEquilibrium

Read in GEQDSK file and creates a hypnotoad TokamakEquilibrium object.

Hypnotoad Wrappers¶

neso_fame.hypnotoad_interface.equilibrium_trace(...) → FieldTrace

Return a field trace from the hypnotoad equilibrium object.

neso_fame.hypnotoad_interface.perpendicular_edge(...) → AcrossFieldCurve

Return a line traveling at right angles to the magnetic field.

neso_fame.hypnotoad_interface.flux_surface_edge(...) → AcrossFieldCurve

Return a line following a flux surface.

neso_fame.hypnotoad_interface.connect_to_o_point(...) → AcrossFieldCurve

Return a line connecting the start point to the o-point.

neso_fame.hypnotoad_interface.get_region_flux_surface_boundary_points(...) → list[Iterator[SliceCoord]]

Get the (ordered) boundary points for flux surface boundaries of a region.

neso_fame.hypnotoad_interface.get_region_perpendicular_boundary_points(...) → list[Iterator[SliceCoord]]

Get the (ordered) boundary points for the perpendicular boundaries of a region.

neso_fame.hypnotoad_interface.get_mesh_boundaries(...) → list[frozenset[Quad]]

Get a list of the boundaries for the mesh.

Integration Tools¶

neso_fame.hypnotoad_interface.Integrand

A (possibly vector) function producing a derivative with respect to t.

neso_fame.hypnotoad_interface.IntegratedFunction

The solution to an ODE.

neso_fame.hypnotoad_interface.integrate_vectorized(...) → Callable[[Integrand], IntegratedFunction]

Return a vectorised numerically-integrated function.