Skip to content

ostk.physics.environment.magnetic.Dipole¶

class Dipole( self: ostk.physics.environment.magnetic.Dipole, arg0: numpy.ndarray[numpy.float64[3, 1]], )¶

Bases: pybind11_object

Magnetic dipole model.

Reference:: https://en.wikipedia.org/wiki/Magnetic_dipole
Reference:: https://en.wikipedia.org/wiki/Magnetic_moment
Reference:: https://en.wikipedia.org/wiki/Vacuum_permeability
Reference:: https://en.wikipedia.org/wiki/Dipole_model_of_the_Earth%27s_magnetic_field

Construct a dipole magnetic model.

Parameters:: magnetic_moment (numpy.ndarray) -- Magnetic moment [A⋅m2].

Methods

get_field_value_at

Get the magnetic field value at a given position and instant.

get_field_value_at( self: ostk.physics.environment.magnetic.Dipole, arg0: numpy.ndarray[numpy.float64[3, 1]], arg1: ostk.physics.time.Instant, ) → numpy.ndarray[numpy.float64[3, 1]]¶

Get the magnetic field value at a given position and instant.

Parameters:

position (numpy.ndarray) -- Position, expressed in the magnetic object frame [m].
instant (Instant) -- Instant.

Returns:

Magnetic field value, expressed in the magnetic object frame [T].

Return type: