OpenMD 3.0
Molecular Dynamics in the Open
Loading...
Searching...
No Matches
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 DoublePolynomialgetLegendrePolynomial (int n) const
 Returns the nth Legendre Polynomial.
 

Protected Attributes

std::vector< DoublePolynomialpolyList_
 

Detailed Description

A collection of Legendre Polynomials.

Todo
document

Definition at line 67 of file LegendrePolynomial.hpp.

Constructor & Destructor Documentation

◆ LegendrePolynomial()

OpenMD::LegendrePolynomial::LegendrePolynomial ( int maxPower)

Definition at line 48 of file LegendrePolynomial.cpp.

◆ ~LegendrePolynomial()

virtual OpenMD::LegendrePolynomial::~LegendrePolynomial ( )
inlinevirtual

Definition at line 70 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
xthe value of the independent variable for the nth Legendre Polynomial function

Definition at line 81 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
xthe value of the independent variable for the nth Legendre Polynomial function

Definition at line 93 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 103 of file LegendrePolynomial.hpp.

Member Data Documentation

◆ polyList_

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

Definition at line 109 of file LegendrePolynomial.hpp.


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