corsika::GeomagneticModel Class Reference

A magnetic field calculated with the WMM or IGRF model. More...

#include <GeomagneticModel.hpp>

Public Member Functions
	GeomagneticModel (Point const &center, boost::filesystem::path const path=corsika::corsika_data("GeoMag/WMM.COF"))
	Construct a new World Magnetic Model object. More...
MagneticFieldVector	getField (double const year, LengthType const altitude, double const latitude, double const longitude)
	Calculates the value of the magnetic field. More...

Detailed Description

A magnetic field calculated with the WMM or IGRF model.

WMM: https://geomag.bgs.ac.uk/documents/WMM2020_Report.pdf IGRF: https://www.ngdc.noaa.gov/IAGA/vmod/igrf.html

Definition at line 27 of file GeomagneticModel.hpp.

Constructor & Destructor Documentation

GeomagneticModel()

corsika::GeomagneticModel::GeomagneticModel	(	Point const &	center,
		boost::filesystem::path const	path = corsika::corsika_data("GeoMag/WMM.COF")
	)

Construct a new World Magnetic Model object.

Parameters

center	Center of Earth.
data	Data table to read.

Member Function Documentation

getField()

MagneticFieldVector corsika::GeomagneticModel::getField	(	double const	year,
		LengthType const	altitude,
		double const	latitude,
		double const	longitude
	)

Calculates the value of the magnetic field.

Parameters

year	Year of the evaluation, between 2020 and 2025.
altitude	Height of the location to evaluate the field at, in km between -1 and 850.
latitude	Latitude of the location to evaluate the field at, in degrees between -90 and 90 (negative for southern hemisphere).
longitute	Longitude of the location to evaluate the field at, in degrees between -180 and 180 (negative for western hemisphere).

Returns

The magnetic field vector in nT.

---

The documentation for this class was generated from the following file:

• corsika/media/GeomagneticModel.hpp