corsika::IMagneticFieldModel< Model > Class Template Reference

An interface for magnetic field models. More...

#include <IMagneticFieldModel.hpp>

Inheritance diagram for corsika::IMagneticFieldModel< Model >:

Public Member Functions
virtual auto	getMagneticField (Point const &) const -> MagneticFieldVector=0
	Evaluate the magnetic field at a given location. More...
virtual	~IMagneticFieldModel ()=default
	A virtual default destructor.

Detailed Description

template<typename Model>
class corsika::IMagneticFieldModel< Model >

An interface for magnetic field models.

This is the base interface for magnetic field model mixins.

Definition at line 24 of file IMagneticFieldModel.hpp.

Member Function Documentation

getMagneticField()

template<typename Model >

virtual auto corsika::IMagneticFieldModel< Model >::getMagneticField ( Point const &  ) const -> MagneticFieldVector

pure virtual

Evaluate the magnetic field at a given location.

Parameters

point

The location to evaluate the field at.

Returns

The magnetic field vector at that point.

---

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

• corsika/media/IMagneticFieldModel.hpp