SSAGES::Fourier Class Reference

Defines the class of Fourier polynomials. More...

#include <Basis.h>

Inheritance diagram for SSAGES::Fourier:

Public Member Functions
	Fourier (unsigned int polyOrd, double boundLow, double boundUp, unsigned int nbins)
	Constructor. More...
double	Evaluate (double x, int n)
	Calculates the output of the basis function. More...
double	EvalGrad (double x, int n)
	Calculates the gradient of the basis function. More...
double	GetNorm (int)
	Gets the norm of the basis function. More...
Public Member Functions inherited from SSAGES::BasisFunction
	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	Weight (double)
	Calculates the weight of the basis function. More...
virtual	~BasisFunction ()
	Destructor.

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

Additional Inherited Members
Protected Attributes inherited from SSAGES::BasisFunction
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

Defines the class of Fourier polynomials.

Definition at line 299 of file Basis.h.

Constructor & Destructor Documentation

Fourier()

SSAGES::Fourier::Fourier ( unsigned int  polyOrd, double  boundLow, double  boundUp, unsigned int  nbins  )

inline

Constructor.

Parameters

polyOrd	Order of Fourier polynomial.
boundLow	Lower bounds of restraint springs.
boundUp	Upper bounds of restraint springs.
nbins	Number of bins.

Constructs an instance of the Fourier function class.

Definition at line 313 of file Basis.h.

                                                                                           :
        BasisFunction(polyOrd, nbins, true, true, boundLow, boundUp)
        {
        }

Referenced by Build().

Here is the caller graph for this function:

Member Function Documentation

Build()

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

static

Build BasisFunction from JSON value.

Build the Fourier polynomial

Parameters

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

Returns

Pointer to new BasisFunction.

Definition at line 49 of file Basis.cpp.

    {
        Json::ObjectRequirement validator;
        Json::Value schema;
        Json::CharReaderBuilder rbuilder;
        Json::CharReader* reader = rbuilder.newCharReader();
 
        reader->parse(JsonSchema::FourierBasis.c_str(),
                      JsonSchema::FourierBasis.c_str() + JsonSchema::FourierBasis.size(),
                      &schema, nullptr);
        validator.Parse(schema, path);
 
        //Validate Inputs
        validator.Validate(json, path);
        if(validator.HasErrors())
            throw BuildException(validator.GetErrors());
 
        return new Fourier(
                json["polynomial_order"].asInt(),
                json["lower_bound"].asDouble(),
                json["upper_bound"].asDouble(),
                nbin
            );
    }

References Fourier(), Json::Requirement::GetErrors(), Json::Requirement::HasErrors(), Json::ObjectRequirement::Parse(), and Json::ObjectRequirement::Validate().

Referenced by SSAGES::BasisFunction::Build().

Here is the call graph for this function:

Here is the caller graph for this function:

EvalGrad()

double SSAGES::Fourier::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 from SSAGES::BasisFunction.

Definition at line 328 of file Basis.h.

        {
            return n == 0 ? 0.0 :
                    n % 2 == 0 ? (-2.0*floor(double(n)*0.5)*M_PI/(boundUp_-boundLow_))*(std::sin(2.0*floor(double(n)*0.5)*M_PI*x/(boundUp_-boundLow_))) : 
                     (2.0*floor(double(n)*0.5)*M_PI/(boundUp_-boundLow_))*std::cos(2.0*floor(double(n)*0.5)*M_PI*x/(boundUp_-boundLow_));
        }

References SSAGES::BasisFunction::boundLow_, and SSAGES::BasisFunction::boundUp_.

Evaluate()

double SSAGES::Fourier::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 from SSAGES::BasisFunction.

Definition at line 321 of file Basis.h.

        {
            return n == 0 ? 0.5 : 
                    n % 2 == 1 ? std::sin(2.0*floor(double(n)*0.5)*M_PI*x/(boundUp_-boundLow_)) :
                      std::cos(2.0*floor(double(n)*0.5)*M_PI*x/(boundUp_-boundLow_));
        }

References SSAGES::BasisFunction::boundLow_, and SSAGES::BasisFunction::boundUp_.

GetNorm()

double SSAGES::Fourier::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 from SSAGES::BasisFunction.

Definition at line 335 of file Basis.h.

        {
            //Assumes the period of the function is the range of the CV
            return 2.0/(boundUp_-boundLow_);
        }

References SSAGES::BasisFunction::boundLow_, and SSAGES::BasisFunction::boundUp_.

---

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