n2p2 - A neural network potential package
SymGrpBaseComp.h
Go to the documentation of this file.
1// n2p2 - A neural network potential package
2// Copyright (C) 2018 Andreas Singraber (University of Vienna)
3// Copyright (C) 2020 Martin P. Bircher
4//
5// This program is free software: you can redistribute it and/or modify
6// it under the terms of the GNU General Public License as published by
7// the Free Software Foundation, either version 3 of the License, or
8// (at your option) any later version.
9//
10// This program is distributed in the hope that it will be useful,
11// but WITHOUT ANY WARRANTY; without even the implied warranty of
12// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13// GNU General Public License for more details.
14//
15// You should have received a copy of the GNU General Public License
16// along with this program. If not, see <https://www.gnu.org/licenses/>.
17
18#ifndef SYMGRPBASECOMP_H
19#define SYMGRPBASECOMP_H
20
21#include "SymGrp.h"
22#include "CutoffFunction.h"
23#include <cstddef> // std::size_t
24#include <string> // std::string
25#include <vector> // std::vector
26
27namespace nnp
28{
29
30class SymGrpBaseComp : public SymGrp
31{
32public:
34 double getRmin() const;
36 double getRmax() const;
37
38protected:
40 double rmin;
42 double rmax;
43
49 SymGrpBaseComp(std::size_t type, ElementMap const& elementMap);
50};
51
53// Inlined function definitions //
55
56inline double SymGrpBaseComp::getRmin() const
57{
58 return rmin;
59}
60
61inline double SymGrpBaseComp::getRmax() const
62{
63 return rmax;
64}
65
66}
67
68#endif
Contains element map.
Definition: ElementMap.h:30
double rmin
Minimum radius within group.
SymGrpBaseComp(std::size_t type, ElementMap const &elementMap)
Constructor, sets type.
double rmax
Maximum radius within group.
double getRmax() const
Getter for rmax.
double getRmin() const
Getter for rmin.
std::size_t type
Symmetry function type.
Definition: SymGrp.h:106
ElementMap elementMap
Copy of element map.
Definition: SymGrp.h:108
Definition: Atom.h:28