Namespace inertialsim::geometry::legendre¶

Namespace List > inertialsim > geometry > legendre

Associated Legendre polynomials (internal API). More...

Public Functions¶

Type	Name
double	AssociatedFunction (int degree, int order, double value) Evaluate associated Legendre functions.
double	SemiNormalizedAssociatedFunction (int degree, int order, double value) Evaluate Schmidt semi-normalized associated Legendre functions.

Detailed Description¶

Internal API

This namespace is part of InertialSim's internal API. Most users should use the MagneticField class and its factory methods rather than calling these functions directly.

Public Functions Documentation¶

function AssociatedFunction¶

Evaluate associated Legendre functions.

double inertialsim::geometry::legendre::AssociatedFunction (
    int degree,
    int order,
    double value
)

Evaluates the associated Legendre function of the input degree and order at the input value. The implementation does not include the Condon-Shortley phase (-1^m) term.

Parameters:

degree Degree of the function.
order Order of the function.
value Value at which to evaluate the function.

Returns:

The value of the associated Legendre function.

function SemiNormalizedAssociatedFunction¶

Evaluate Schmidt semi-normalized associated Legendre functions.

double inertialsim::geometry::legendre::SemiNormalizedAssociatedFunction (
    int degree,
    int order,
    double value
)

Evaluates the Schmidt semi-normalized associated Legendre function of the first kind.

Parameters:

degree Degree of the function.
order Order of the function.
value Value at which to evaluate the function.

Returns:

The value of the Schmidt semi-normalized function.

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