.. _magneticfieldcentereddipole:

magneticFieldCenteredDipole
===========================


Executive Summary
-----------------

Evaluate a centered dipole magnetic field model about a planet for a range of spacecraft locations.
For more information on this module see this :download:`PDF Description </../../src/simulation/environment/magneticFieldCenteredDipole/_Documentation/Basilisk-magFieldDipole-20190309.pdf>`.


The module is a sub-class of the :ref:`magneticFieldBase` base class.  See that class for the nominal messages
used and general instructions.



Class MagneticFieldCenteredDipole
---------------------------------

.. doxygenclass:: MagneticFieldCenteredDipole
   :project: basilisk
   :members: