SSAGES::BasisFunction Class Reference

Abstract class for all BasisFunction inheritance. More...

#include <Basis.h>

Inheritance diagram for SSAGES::BasisFunction:

Public Member Functions
	BasisFunction (unsigned int polyOrd, unsigned int nbins, bool isFinite, bool zeroOrder, double boundLow, double boundUp)
	Constructor. More...
unsigned int	GetOrder ()
	Gets the order of the current polynomial. More...
unsigned int	GetBins ()
	Gets the number of bins for the discretization. More...
bool	GetZeroOrder ()
	Gets the flag for constant-order polynomials. More...
double	GetLower ()
	Gets the lower bound on the CV. More...
double	GetUpper ()
	Gets the upper bound on the CV. More...
double	GetRange ()
	Gets the magnitude of the range of bounds. More...
virtual double	GetNorm (int)
	Gets the norm of the basis function. More...
virtual double	Evaluate (double, int)
	Calculates the output of the basis function. More...
virtual double	EvalGrad (double, int)
	Calculates the gradient of the basis function. More...
virtual double	Weight (double)
	Calculates the weight of the basis function. More...
virtual	~BasisFunction ()
	Destructor.

Static Public Member Functions
static BasisFunction *	Build (const Json::Value &json, const std::string &path, unsigned int nbins)
	Build BasisFunction from JSON value. More...

Protected Attributes
unsigned int	polyOrd_
	Order of the polynomial.
unsigned int	nbins_
	Number of bins.
bool	isFinite_
	Flag for finite-range polynomials.
bool	zeroOrder_
	Flag for constant-order polynomials.
double	boundLow_
	Lower bound on CV.
double	boundUp_
	Upper bound on CV.

Detailed Description

Abstract class for all BasisFunction inheritance.

Definition at line 59 of file Basis.h.

Constructor & Destructor Documentation

BasisFunction()

SSAGES::BasisFunction::BasisFunction ( unsigned int  polyOrd, unsigned int  nbins, bool  isFinite, bool  zeroOrder, double  boundLow, double  boundUp  )

inline

Constructor.

Parameters

polyOrd	Order of polynomial.
nbins	Number of bins.
isFinite	Flag for finite-range polynomials.
zeroOrder	Flag for constant-order polynomials.
boundLow	Lower bounds of restraint springs.
boundUp	Upper bounds of restraint springs.

Constructs an instance of the Basis function class, which can have multiple different inherited forms.

Definition at line 82 of file Basis.h.

                                      :
        polyOrd_(polyOrd), nbins_(nbins), isFinite_(isFinite), zeroOrder_(zeroOrder),
        boundLow_(boundLow), boundUp_(boundUp)
        {
        }

Member Function Documentation

Build()

BasisFunction * SSAGES::BasisFunction::Build ( const Json::Value &  json, const std::string &  path, unsigned int  nbins  )

static

Build BasisFunction from JSON value.

Parameters

json	JSON value node.
path	Path for JSON path specification.
nbins	Number of bins.

Returns

Pointer to new BasisFunction.

Definition at line 9 of file Basis.cpp.

    {
        auto type = json.get("type","none").asString();
        if(type == "Legendre")
            return Legendre::Build(json, path, nbins);
        else if (type == "Chebyshev")
            return Chebyshev::Build(json, path, nbins);
        else if (type == "Fourier")
            return Fourier::Build(json, path, nbins);
        else
            throw std::invalid_argument("Invalid basis set type \"" + type + "\".");
    }

References SSAGES::Chebyshev::Build(), SSAGES::Legendre::Build(), and SSAGES::Fourier::Build().

Here is the call graph for this function:

EvalGrad()

virtual double SSAGES::BasisFunction::EvalGrad ( double  , int    )

inlinevirtual

Calculates the gradient of the basis function.

Parameters

val	Input value for function.
order	Order of the polynomial.

Returns

Gradient for function.

Reimplemented in SSAGES::Fourier, SSAGES::Legendre, and SSAGES::Chebyshev.

Definition at line 164 of file Basis.h.

                                                 {
            return 0;
        }

Evaluate()

virtual double SSAGES::BasisFunction::Evaluate ( double  , int    )

inlinevirtual

Calculates the output of the basis function.

Parameters

val	Input value for function.
order	Order of the polynomial.

Returns

Output value for function.

Reimplemented in SSAGES::Fourier, SSAGES::Legendre, and SSAGES::Chebyshev.

Definition at line 153 of file Basis.h.

                                                 {
            return 0;
        }

GetBins()

unsigned int SSAGES::BasisFunction::GetBins ( )

inline

Gets the number of bins for the discretization.

Returns

Number of bins.

Definition at line 103 of file Basis.h.

{return nbins_;}

References nbins_.

GetLower()

double SSAGES::BasisFunction::GetLower ( )

inline

Gets the lower bound on the CV.

Returns

Lower bound on CV.

Definition at line 115 of file Basis.h.

{return boundLow_;}

References boundLow_.

GetNorm()

virtual double SSAGES::BasisFunction::GetNorm ( int  )

inlinevirtual

Gets the norm of the basis function.

Parameters

order

Order of the polynomial.

Returns

Norm of a specific order of polynomial.

Reimplemented in SSAGES::Fourier, SSAGES::Chebyshev, and SSAGES::Legendre.

Definition at line 142 of file Basis.h.

                                      {
            return 0;
        }

GetOrder()

unsigned int SSAGES::BasisFunction::GetOrder ( )

inline

Gets the order of the current polynomial.

Returns

Order of current polynomial.

Definition at line 97 of file Basis.h.

{return polyOrd_;}

References polyOrd_.

GetRange()

double SSAGES::BasisFunction::GetRange ( )

inline

Gets the magnitude of the range of bounds.

Returns

Magnitude of range of bounds on CV.

Definition at line 127 of file Basis.h.

        {
            if(isFinite_) 
                return boundUp_ - boundLow_;
            // No infinitely bounded basis functions are included currently so this is going to return nothing for right now
            else
                return 0.0;
        }

References boundLow_, boundUp_, and isFinite_.

GetUpper()

double SSAGES::BasisFunction::GetUpper ( )

inline

Gets the upper bound on the CV.

Returns

Upper bound on CV.

Definition at line 121 of file Basis.h.

{return boundUp_;}

References boundUp_.

GetZeroOrder()

bool SSAGES::BasisFunction::GetZeroOrder ( )

inline

Gets the flag for constant-order polynomials.

Returns

Flag for constant-order polynomials.

Definition at line 109 of file Basis.h.

{return zeroOrder_;}

References zeroOrder_.

Weight()

virtual double SSAGES::BasisFunction::Weight ( double  )

inlinevirtual

Calculates the weight of the basis function.

Parameters

val	Input value for function.

Returns

Weight of function.

Reimplemented in SSAGES::Chebyshev.

Definition at line 174 of file Basis.h.

                                        {
            return 1;
        }

---

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

• /home/michael/development/SSAGES/src/Utility/Basis.h
• /home/michael/development/SSAGES/src/Utility/Basis.cpp