corsika::UniformMagneticField< T > Class Template Reference

A uniform (constant) magnetic field. More...

#include <UniformMagneticField.hpp>

Inheritance diagram for corsika::UniformMagneticField< T >:

Public Member Functions
template<typename... Args>
	UniformMagneticField (MagneticFieldVector const &B, Args &&... args)
	Construct a UniformMagneticField. More...
MagneticFieldVector	getMagneticField (Point const &) const final override
	Evaluate the magnetic field at a given location. More...
auto	setMagneticField (MagneticFieldVector const &Bfield) -> void
	Set the magnetic field returned by this instance. More...

Detailed Description

template<typename T>
class corsika::UniformMagneticField< T >

A uniform (constant) magnetic field.

This class returns the same magnetic field vector for all evaluated locations.

Definition at line 25 of file UniformMagneticField.hpp.

Constructor & Destructor Documentation

UniformMagneticField()

template<typename T >

template<typename... Args>

corsika::UniformMagneticField< T >::UniformMagneticField ( MagneticFieldVector const &  B, Args &&...  args  )

inline

Construct a UniformMagneticField.

This is initialized with a fixed magnetic field and returns this magnetic field at all locations.

Parameters

field

The fixed magnetic field to return.

Definition at line 37 of file UniformMagneticField.hpp.

Member Function Documentation

getMagneticField()

template<typename T >

MagneticFieldVector corsika::UniformMagneticField< T >::getMagneticField ( Point const &  ) const

inlinefinaloverride

Evaluate the magnetic field at a given location.

Parameters

point

The location to evaluate the field at.

Returns

The magnetic field vector.

Definition at line 47 of file UniformMagneticField.hpp.

setMagneticField()

template<typename T >

auto corsika::UniformMagneticField< T >::setMagneticField ( MagneticFieldVector const &  Bfield ) -> void

inline

Set the magnetic field returned by this instance.

Parameters

point

The location to evaluate the field at.

Returns

The magnetic field vector.

Definition at line 55 of file UniformMagneticField.hpp.

---

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

• corsika/media/UniformMagneticField.hpp