scotty.check_input module

Checks input arguments of beam_me_up

scotty.check_input.check_input(mode_flag, poloidal_flux_enter, launch_position, field, poloidal_flux_zero_density)

Parameters

• mode_flag (int) –

• poloidal_flux_enter (float) –

• launch_position (numpy.ndarray[Any, numpy.dtype[numpy.float64]]) –

• field (scotty.geometry.MagneticField) –

• poloidal_flux_zero_density (float) –

Return type

None

scotty.check_input.check_launch_position(poloidal_flux_enter, launch_position, field)

Parameters

• poloidal_flux_enter (float) –

• launch_position (numpy.ndarray[Any, numpy.dtype[numpy.float64]]) –

• field (scotty.geometry.MagneticField) –

Return type

None

scotty.check_input.check_mode_flag(mode_flag)

Mode flag should be either -1 (X-mode) or 1 (O-mode)

Parameters

mode_flag (int) –

Return type

None

scotty.check_input.check_poloidal_flux_arguments(poloidal_flux_enter, poloidal_flux_zero_density)

Parameters

• poloidal_flux_enter (float) –

• poloidal_flux_zero_density (float) –

Return type

None