OpenMD::LegendrePolynomial Class Reference

A collection of Legendre Polynomials. More...

#include <LegendrePolynomial.hpp>

Public Member Functions
	LegendrePolynomial (int maxPower)
RealType	evaluate (int n, RealType x)
	Calculates the value of the nth Legendre Polynomial evaluated at the given x value.
RealType	evaluateDerivative (int n, RealType x)
	Returns the first derivative of the nth Legendre Polynomial.
const DoublePolynomial &	getLegendrePolynomial (int n) const
	Returns the nth Legendre Polynomial.

Protected Attributes
std::vector< DoublePolynomial >	polyList_

Detailed Description

A collection of Legendre Polynomials.

Todo

document

Definition at line 70 of file LegendrePolynomial.hpp.

Constructor & Destructor Documentation

LegendrePolynomial()

OpenMD::LegendrePolynomial::LegendrePolynomial

(

int

maxPower

)

Definition at line 51 of file LegendrePolynomial.cpp.

~LegendrePolynomial()

virtual OpenMD::LegendrePolynomial::~LegendrePolynomial ( )

inlinevirtual

Definition at line 73 of file LegendrePolynomial.hpp.

Member Function Documentation

evaluate()

RealType OpenMD::LegendrePolynomial::evaluate ( int n, RealType x )

inline

Calculates the value of the nth Legendre Polynomial evaluated at the given x value.

Returns

The value of the nth Legendre Polynomial evaluates at the given x value

Parameters

n
x	the value of the independent variable for the nth Legendre Polynomial function

Definition at line 84 of file LegendrePolynomial.hpp.

evaluateDerivative()

RealType OpenMD::LegendrePolynomial::evaluateDerivative ( int n, RealType x )

inline

Returns the first derivative of the nth Legendre Polynomial.

Returns

the first derivative of the nth Legendre Polynomial

Parameters

n
x	the value of the independent variable for the nth Legendre Polynomial function

Definition at line 96 of file LegendrePolynomial.hpp.

getLegendrePolynomial()

const DoublePolynomial & OpenMD::LegendrePolynomial::getLegendrePolynomial ( int n ) const

inline

Returns the nth Legendre Polynomial.

Returns

the nth Legendre Polynomial

Parameters

n

Definition at line 106 of file LegendrePolynomial.hpp.

Member Data Documentation

polyList_

std::vector<DoublePolynomial> OpenMD::LegendrePolynomial::polyList_

protected

Definition at line 112 of file LegendrePolynomial.hpp.

---

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

• math/LegendrePolynomial.hpp
• math/LegendrePolynomial.cpp