SymFncBaseCompAng.h

Go to the documentation of this file.

// n2p2 - A neural network potential package
// Copyright (C) 2018 Andreas Singraber (University of Vienna)
// Copyright (C) 2020 Martin P. Bircher
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
#ifndef SYMFNCBASECOMPANG_H
#define SYMFNCBASECOMPANG_H
 
#include "SymFncBaseComp.h"
#include <cstddef> // std::size_t
#include <string>  // std::string
#include <vector>  // std::vector
 
namespace nnp
{
 
class SymFncBaseCompAng : public SymFncBaseComp
{
public:
    virtual void        setParameters(std::string const& parameterString);
    virtual void        changeLengthUnit(double convLength);
    virtual std::string getSettingsLine() const;
    // Core fcts
    void                getCompactAngle(double const x,
                                        double&      fx,
                                        double&      dfx) const;
    void                getCompactRadial(double const x,
                                         double&      fx,
                                         double&      dfx) const;
    virtual std::string parameterLine() const;
    virtual std::vector<
    std::string>        parameterInfo() const;
    std::size_t         getE1() const;
    std::size_t         getE2() const;
    double              getAngleLeft() const;
    double              getAngleRight() const;
    virtual double      calculateRadialPart(double distance) const;
    virtual double      calculateAngularPart(double angle) const;
    virtual bool        checkRelevantElement(std::size_t index) const;
#ifndef N2P2_NO_SF_CACHE
    virtual std::vector<
    std::string>        getCacheIdentifiers() const;
#endif
 
protected:
    std::size_t     e1;
    std::size_t     e2;
    double          angleLeft;
    double          angleRight;
    double          angleLeftRadians;
    double          angleRightRadians;
    CompactFunction ca;
 
    SymFncBaseCompAng(std::size_t type, ElementMap const&);
};
 
// Inlined function definitions //
 
inline std::size_t SymFncBaseCompAng::getE1() const { return e1; }
inline std::size_t SymFncBaseCompAng::getE2() const { return e2; }
inline double SymFncBaseCompAng::getAngleLeft() const { return angleLeft; }
inline double SymFncBaseCompAng::getAngleRight() const { return angleRight; }
 
inline void SymFncBaseCompAng::getCompactAngle(double const x,
                                               double&      fx,
                                               double&      dfx) const
{
    ca.fdf(x, fx, dfx);
    return;
}
 
inline void SymFncBaseCompAng::getCompactRadial(double const x,
                                                double&      fx,
                                                double&      dfx) const
{
    cr.fdf(x, fx, dfx);
    return;
}
 
}
 
#endif