Class inertialsim::geodesy::ConstantMagneticField

ClassList > inertialsim > geodesy > ConstantMagneticField

Constant magnetic field model. More...

• #include <magnetic_field.h>

Inherits the following classes: inertialsim::geodesy::Field

Public Functions

Type	Name
	ConstantMagneticField (const Vector3D & magnetic_field) Construct from a magnetic field vector.
virtual Scalar1D	Magnitude (const Coordinates & coordinates) const Return magnitude at the given coordinates.
Scalar1D	Magnitude (const Array3D & coordinates, CoordinateSystem default_frame=CoordinateSystem::GEODETIC) const Return magnitude at the given coordinates.
Scalar1D	Magnitude (const geometry::Vector & coordinates, CoordinateSystem default_frame=CoordinateSystem::LOCAL) const Return magnitude at the given coordinates.
Scalar1D	Magnitude (const Vector3D & coordinates, CoordinateSystem default_frame=CoordinateSystem::LOCAL) const Return magnitude at the given coordinates.
Vector3D	Vector (const Coordinates & coordinates, const std::optional< CoordinateSystem > & basis=std::nullopt) const Return the vector field at the given coordinates.
Vector3D	Vector (const Array3D & coordinates, CoordinateSystem default_frame=CoordinateSystem::GEODETIC, const std::optional< CoordinateSystem > & basis=std::nullopt) const Return the vector field at the given coordinates.
Vector3D	Vector (const geometry::Vector & coordinates, CoordinateSystem default_frame=CoordinateSystem::LOCAL, const std::optional< CoordinateSystem > & basis=std::nullopt) const Return the vector field at the given coordinates.
Vector3D	Vector (const Vector3D & coordinates, CoordinateSystem default_frame=CoordinateSystem::LOCAL, const std::optional< CoordinateSystem > & basis=std::nullopt) const Return the vector field at the given coordinates.

Public Functions inherited from inertialsim::geodesy::Field

See inertialsim::geodesy::Field

Type	Name
virtual Scalar1D	Magnitude (const Coordinates & coordinates) const Return magnitude at the given coordinates.
Scalar1D	Magnitude (const Array3D & coordinates, CoordinateSystem default_frame=CoordinateSystem::GEODETIC) const Return magnitude at the given coordinates.
Scalar1D	Magnitude (const geometry::Vector & coordinates, CoordinateSystem default_frame=CoordinateSystem::LOCAL) const Return magnitude at the given coordinates.
Scalar1D	Magnitude (const Vector3D & coordinates, CoordinateSystem default_frame=CoordinateSystem::LOCAL) const Return magnitude at the given coordinates.
Vector3D	Vector (const Coordinates & coordinates, const std::optional< CoordinateSystem > & basis=std::nullopt) const Return the vector field at the given coordinates.
Vector3D	Vector (const Array3D & coordinates, CoordinateSystem default_frame=CoordinateSystem::GEODETIC, const std::optional< CoordinateSystem > & basis=std::nullopt) const Return the vector field at the given coordinates.
Vector3D	Vector (const geometry::Vector & coordinates, CoordinateSystem default_frame=CoordinateSystem::LOCAL, const std::optional< CoordinateSystem > & basis=std::nullopt) const Return the vector field at the given coordinates.
Vector3D	Vector (const Vector3D & coordinates, CoordinateSystem default_frame=CoordinateSystem::LOCAL, const std::optional< CoordinateSystem > & basis=std::nullopt) const Return the vector field at the given coordinates.
virtual	~Field () = default Virtual destructor.

Detailed Description

Returns a constant magnetic field value regardless of coordinates. Useful for testing and simple simulations.

Public Functions Documentation

function ConstantMagneticField

Construct from a magnetic field vector.

explicit inertialsim::geodesy::ConstantMagneticField::ConstantMagneticField (
    const  Vector3D & magnetic_field
) 

Parameters:

• magnetic_field 3x1 magnetic field vector in Tesla.

---

function Magnitude [1/4]

Return magnitude at the given coordinates.

virtual Scalar1D inertialsim::geodesy::ConstantMagneticField::Magnitude (
    const  Coordinates & coordinates
) const

Parameters:

• coordinates Array of coordinates.

Returns:

Magnitudes.

Implements inertialsim::geodesy::Field::Magnitude

---

function Magnitude [2/4]

Return magnitude at the given coordinates.

Scalar1D inertialsim::geodesy::ConstantMagneticField::Magnitude (
    const  Array3D & coordinates,
    CoordinateSystem default_frame=CoordinateSystem::GEODETIC
) const

Parameters:

• coordinates Coordinates in raw form (e.g. geodetic).
• default_frame Coordinate system corresponding to the coordinate input.

Returns:

Magnitudes.

---

function Magnitude [3/4]

Return magnitude at the given coordinates.

Scalar1D inertialsim::geodesy::ConstantMagneticField::Magnitude (
    const  geometry::Vector & coordinates,
    CoordinateSystem default_frame=CoordinateSystem::LOCAL
) const

Parameters:

• coordinates Coordinates.
• default_frame Coordinate system corresponding to the coordinate input.

Returns:

Magnitudes.

---

function Magnitude [4/4]

Return magnitude at the given coordinates.

Scalar1D inertialsim::geodesy::ConstantMagneticField::Magnitude (
    const  Vector3D & coordinates,
    CoordinateSystem default_frame=CoordinateSystem::LOCAL
) const

Parameters:

• coordinates Coordinates in raw form (e.g. local xyz).
• default_frame Coordinate system corresponding to the coordinate input.

Returns:

Magnitudes.

---

function Vector [1/4]

Return the vector field at the given coordinates.

inline Vector3D inertialsim::geodesy::ConstantMagneticField::Vector (
    const  Coordinates & coordinates,
    const std::optional< CoordinateSystem > & basis=std::nullopt
) const

By default, the vector components will be expressed in the basis associated with the coordinates. For curvilinear systems (e.g. geodetic), the basis is the local basis at the given coordinates. If basis is supplied, it will be used instead.

Note

For curvilinear coordinate systems like geodetic coordinates, the default basis is the local tangent plane basis at each coordinate location. For Cartesian systems like ECEF, the basis is constant.

Parameters:

• coordinates Array of coordinates.
• basis Optional basis in which to return the vector. If not specified, uses the basis associated with the coordinates.

Returns:

Vectors.

---

function Vector [2/4]

Return the vector field at the given coordinates.

Vector3D inertialsim::geodesy::ConstantMagneticField::Vector (
    const  Array3D & coordinates,
    CoordinateSystem default_frame=CoordinateSystem::GEODETIC,
    const std::optional< CoordinateSystem > & basis=std::nullopt
) const

Parameters:

• coordinates Coordinates in raw form (e.g. geodetic).
• default_frame Coordinate system corresponding to the coordinate input.
• basis Optional basis in which to return the vector.

Returns:

Vectors.

---

function Vector [3/4]

Return the vector field at the given coordinates.

Vector3D inertialsim::geodesy::ConstantMagneticField::Vector (
    const  geometry::Vector & coordinates,
    CoordinateSystem default_frame=CoordinateSystem::LOCAL,
    const std::optional< CoordinateSystem > & basis=std::nullopt
) const

Parameters:

• coordinates Coordinates.
• default_frame Coordinate system corresponding to the coordinate input.
• basis Optional basis in which to return the vector.

Returns:

Vectors.

---

function Vector [4/4]

Return the vector field at the given coordinates.

Vector3D inertialsim::geodesy::ConstantMagneticField::Vector (
    const  Vector3D & coordinates,
    CoordinateSystem default_frame=CoordinateSystem::LOCAL,
    const std::optional< CoordinateSystem > & basis=std::nullopt
) const

Parameters:

• coordinates Coordinates in raw form (e.g. local xyz).
• default_frame Coordinate system corresponding to the coordinate input.
• basis Optional basis in which to return the vector.

Returns:

Vectors.

---

---

The documentation for this class was generated from the following file cpp/include/inertialsim/geodesy/magnetic_field.h