get_dipole_model_on_lfm_grid

rbinvariantslib.models.get_dipole_model_on_lfm_grid(lfm_hdf4_path) → MagneticFieldModel

Get a dipole field on a LFM grid. Uses an LFM HDF4 file to obtain the grid.

Parameters:

lfm_hdf4_pathstr

Path to LFM file in HDF4 format

Returns:

modelMagneticFieldModel

Mesh on LFM grid with dipole field values. Grid is in units of Re and magnetic field is is units of Gauss