OpenMD  2.5
Molecular Dynamics in the Open
OpenMD::SphericalHarmonic Class Reference

#include <SphericalHarmonic.hpp>

Public Member Functions

 SphericalHarmonic ()
 
virtual ~SphericalHarmonic ()
 
void setL (int theL)
 
int getL ()
 
void setM (int theM)
 
int getM ()
 
ComplexType getValueAt (RealType costheta, RealType phi)
 

Protected Member Functions

RealType LegendreP (int l, int m, RealType x)
 
RealType Legendre (int l, int m, RealType x)
 
RealType Ptilde (int l, int m, RealType x)
 
RealType mpow (int j)
 
RealType Fact (int j)
 

Protected Attributes

int L
 
int M
 

Detailed Description

Definition at line 65 of file SphericalHarmonic.hpp.

Constructor & Destructor Documentation

◆ SphericalHarmonic()

SphericalHarmonic::SphericalHarmonic ( )

Definition at line 53 of file SphericalHarmonic.cpp.

◆ ~SphericalHarmonic()

virtual OpenMD::SphericalHarmonic::~SphericalHarmonic ( )
inlinevirtual

Definition at line 69 of file SphericalHarmonic.hpp.

Member Function Documentation

◆ Fact()

RealType SphericalHarmonic::Fact ( int  j)
protected

Definition at line 209 of file SphericalHarmonic.cpp.

References errorStruct::errMsg, factorial_list, errorStruct::isFatal, painCave, and simError().

Referenced by getM(), Legendre(), and Ptilde().

◆ getL()

int OpenMD::SphericalHarmonic::getL ( )
inline

Definition at line 72 of file SphericalHarmonic.hpp.

References L.

◆ getM()

int OpenMD::SphericalHarmonic::getM ( )
inline

Definition at line 75 of file SphericalHarmonic.hpp.

References Fact(), getValueAt(), Legendre(), LegendreP(), M, mpow(), and Ptilde().

◆ getValueAt()

ComplexType SphericalHarmonic::getValueAt ( RealType  costheta,
RealType  phi 
)

Definition at line 56 of file SphericalHarmonic.cpp.

References L, M, and Ptilde().

Referenced by getM(), OpenMD::BOPofR::process(), and OpenMD::BondOrderParameter::process().

◆ Legendre()

RealType SphericalHarmonic::Legendre ( int  l,
int  m,
RealType  x 
)
protected

Definition at line 122 of file SphericalHarmonic.cpp.

References Fact(), LegendreP(), and mpow().

Referenced by getM(), and Ptilde().

◆ LegendreP()

RealType SphericalHarmonic::LegendreP ( int  l,
int  m,
RealType  x 
)
protected

Definition at line 70 of file SphericalHarmonic.cpp.

Referenced by getM(), and Legendre().

◆ mpow()

RealType SphericalHarmonic::mpow ( int  j)
protected

Definition at line 153 of file SphericalHarmonic.cpp.

Referenced by getM(), Legendre(), and Ptilde().

◆ Ptilde()

RealType SphericalHarmonic::Ptilde ( int  l,
int  m,
RealType  x 
)
protected

Definition at line 139 of file SphericalHarmonic.cpp.

References Fact(), Legendre(), mpow(), and OpenMD::Constants::PI.

Referenced by getM(), and getValueAt().

◆ setL()

void OpenMD::SphericalHarmonic::setL ( int  theL)
inline

Definition at line 71 of file SphericalHarmonic.hpp.

References L.

Referenced by OpenMD::BOPofR::process(), and OpenMD::BondOrderParameter::process().

◆ setM()

void OpenMD::SphericalHarmonic::setM ( int  theM)
inline

Definition at line 74 of file SphericalHarmonic.hpp.

References M.

Referenced by OpenMD::BOPofR::process(), and OpenMD::BondOrderParameter::process().

Member Data Documentation

◆ L

int OpenMD::SphericalHarmonic::L
protected

Definition at line 87 of file SphericalHarmonic.hpp.

Referenced by getL(), getValueAt(), and setL().

◆ M

int OpenMD::SphericalHarmonic::M
protected

Definition at line 88 of file SphericalHarmonic.hpp.

Referenced by getM(), getValueAt(), and setM().


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