neso_fame.hypnotoad_interface.equilibrium_trace(equilibrium: TokamakEquilibrium, system: CoordinateSystem = CoordinateSystem.CYLINDRICAL) FieldTrace

Return a field trace from the hypnotoad equilibrium object.

Parameters:
equilibrium: TokamakEquilibrium

The equilibrium magnetic field from Hypnotoad.

system: CoordinateSystem = CoordinateSystem.CYLINDRICAL

The coordinate system to use for the result. This normally would not be changed, but when exporting the poloidal cross-section of the mesh it can be useful to set it to be Cartesian.

Returns:

Function following a magnetic field line.

Return type:

FieldTrace


Last update: Nov 07, 2024