SymFncBaseCutoff.h

Go to the documentation of this file.

// n2p2 - A neural network potential package
// Copyright (C) 2018 Andreas Singraber (University of Vienna)
//
// 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 SYMFNCBASECUTOFF_H
#define SYMFNCBASECUTOFF_H
 
#include "SymFnc.h"
#include "CutoffFunction.h"
#include <cstddef> // std::size_t
#include <string>  // std::string
#include <vector>  // std::vector
 
namespace nnp
{
 
class SymFncBaseCutoff : public SymFnc
{
public:
    virtual
    std::vector<std::string> parameterInfo() const;
    void                     setCutoffFunction(CutoffFunction::
                                          CutoffType cutoffType,
                                          double     cutoffAlpha);
    double                   getCutoffAlpha() const;
    std::string              getSubtype() const;
    CutoffFunction::
    CutoffType               getCutoffType() const;
 
protected:
    double                     cutoffAlpha;
    std::string                subtype;
    CutoffFunction             fc;
    CutoffFunction::CutoffType cutoffType;
 
    SymFncBaseCutoff(std::size_t type, ElementMap const&);
};
 
// Inlined function definitions //
 
inline double SymFncBaseCutoff::getCutoffAlpha() const { return cutoffAlpha; }
inline std::string SymFncBaseCutoff::getSubtype() const { return subtype; } 
 
inline CutoffFunction::CutoffType SymFncBaseCutoff::getCutoffType() const
{
    return cutoffType;
}
 
}
 
#endif