kim-api  2.3.1-git+v2.3.0-git-2-g378406f9.GNU.GNU.
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
KIM_ComputeCallbackName.hpp
Go to the documentation of this file.
1 //
2 // KIM-API: An API for interatomic models
3 // Copyright (c) 2013--2022, Regents of the University of Minnesota.
4 // All rights reserved.
5 //
6 // Contributors:
7 // Ryan S. Elliott
8 //
9 // SPDX-License-Identifier: LGPL-2.1-or-later
10 //
11 // This library is free software; you can redistribute it and/or
12 // modify it under the terms of the GNU Lesser General Public
13 // License as published by the Free Software Foundation; either
14 // version 2.1 of the License, or (at your option) any later version.
15 //
16 // This library is distributed in the hope that it will be useful,
17 // but WITHOUT ANY WARRANTY; without even the implied warranty of
18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 // Lesser General Public License for more details.
20 //
21 // You should have received a copy of the GNU Lesser General Public License
22 // along with this library; if not, write to the Free Software Foundation,
23 // Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 //
25 
26 //
27 // Release: This file is part of the kim-api.git repository.
28 //
29 
30 
31 #ifndef KIM_COMPUTE_CALLBACK_NAME_HPP_
32 #define KIM_COMPUTE_CALLBACK_NAME_HPP_
33 
34 #include <string>
35 
36 namespace KIM
37 {
49 {
50  public:
62 
67 
73  ComputeCallbackName(int const id);
74 
83  ComputeCallbackName(std::string const & str);
84 
94  bool Known() const;
95 
104  bool operator==(ComputeCallbackName const & rhs) const;
105 
114  bool operator!=(ComputeCallbackName const & rhs) const;
115 
127  std::string const & ToString() const;
128 }; // class ComputeCallbackName
129 
133 namespace COMPUTE_CALLBACK_NAME
134 {
148 
162 
176 
177 
188 void GetNumberOfComputeCallbackNames(int * const numberOfComputeCallbackNames);
189 
205 int GetComputeCallbackName(int const index,
206  ComputeCallbackName * const computeCallbackName);
207 
212 {
218  ComputeCallbackName const & b) const
219  {
221  }
222 }; // struct Comparator
223 } // namespace COMPUTE_CALLBACK_NAME
224 } // namespace KIM
225 
226 #endif // KIM_COMPUTE_CALLBACK_NAME_HPP_
int GetComputeCallbackName(int const index, ComputeCallbackName *const computeCallbackName)
Get the identity of each defined standard ComputeCallbackName.
bool operator==(ComputeCallbackName const &rhs) const
Compares ComputeCallbackName objects for equality.
void GetNumberOfComputeCallbackNames(int *const numberOfComputeCallbackNames)
Get the number of standard ComputeCallbackName&#39;s defined by the KIM API.
bool operator!=(ComputeCallbackName const &rhs) const
Compares ComputeCallbackName objects for inequality.
ComputeCallbackName const ProcessD2EDr2Term
The standard ProcessD2EDr2Term callback.
bool Known() const
Determines if the object is a quantity known to the KIM API.
ComputeCallbackName const GetNeighborList
The standard GetNeighborList callback.
An Extensible Enumeration for the ComputeCallbackName&#39;s supported by the KIM API. ...
int computeCallbackNameID
Integer identifying the specific ComputeCallbackName represented.
ComputeCallbackName const ProcessDEDrTerm
The standard ProcessDEDrTerm callback.
std::string const & ToString() const
Converts the object to a string.
Structure provided for use with std::map.
ComputeCallbackName()
Create an uninitialized ComputeCallbackName object.
bool operator()(ComputeCallbackName const &a, ComputeCallbackName const &b) const
Provides an (logically unmeaningful) ordering for ComputeCallbackName objects so that they can be sto...