O_SESSAME::TiltedDipoleMagneticModel Class Reference
[Environment Models]

#include <TiltedDipoleMagneticModel.h>

Inheritance diagram for O_SESSAME::TiltedDipoleMagneticModel:

[legend]Collaboration diagram for O_SESSAME::TiltedDipoleMagneticModel:

[legend]List of all members.

---

Detailed Description

Define the model of a magnetic field using a tilted dipole model.

Definition at line 22 of file TiltedDipoleMagneticModel.h.

Public Member Functions
	TiltedDipoleMagneticModel ()
virtual	~TiltedDipoleMagneticModel ()
virtual Vector	GetMagneticField (const ssfTime &_currentTime, const Vector &_PositionVector)
	Calculates the local magnetic field about a central body used a tilted dipole model.
virtual void	SetMagFieldCoefficients (const MagneticFieldCoefficients &_newMagFieldCoeffs)
Protected Attributes
MagneticFieldCoefficients	m_MagFieldCoeffs

---

Constructor & Destructor Documentation

O_SESSAME::TiltedDipoleMagneticModel::TiltedDipoleMagneticModel (   )  [inline]

Definition at line 25 of file TiltedDipoleMagneticModel.h.

virtual O_SESSAME::TiltedDipoleMagneticModel::~TiltedDipoleMagneticModel (   )  [inline, virtual]

Definition at line 26 of file TiltedDipoleMagneticModel.h.

---

Member Function Documentation

Vector O_SESSAME::TiltedDipoleMagneticModel::GetMagneticField (  const ssfTime &  _currentTime, const Vector &  _PositionVector )  [virtual]

Calculates the local magnetic field about a central body used a tilted dipole model. Implements O_SESSAME::MagneticModel. Definition at line 19 of file TiltedDipoleMagneticModel.cpp. References O_SESSAME::MagneticFieldCoefficients::CBAvgRotationRate, O_SESSAME::MagneticFieldCoefficients::CBRadius, O_SESSAME::MagneticFieldCoefficients::DipoleCoelevation, O_SESSAME::MagneticFieldCoefficients::DipoleEastLongitude, O_SESSAME::ssfTime::GetEpochGreenwichMeanSiderealTime(), O_SESSAME::ssfTime::GetSeconds(), O_SESSAME::MagneticFieldCoefficients::H0, O_SESSAME::MagneticFieldCoefficients::modelEpoch, O_SESSAME::norm2(), O_SESSAME::ssfTime::SecondsSinceEpoch(), O_SESSAME::ssfTime::Set(), and O_SESSAME::Vector.

virtual void O_SESSAME::MagneticModel::SetMagFieldCoefficients (  const MagneticFieldCoefficients &  _newMagFieldCoeffs  )  [inline, virtual, inherited]

Definition at line 39 of file MagneticModel.h. Referenced by O_SESSAME::CentralBody::SetMagneticModel().

---

Member Data Documentation

MagneticFieldCoefficients O_SESSAME::MagneticModel::m_MagFieldCoeffs [protected, inherited]

Definition at line 44 of file MagneticModel.h.

---

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

• TiltedDipoleMagneticModel.h
• TiltedDipoleMagneticModel.cpp

---