kim-api  2.1.4-git+v2.1.3-git-1-g7847914a.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
KIM_ModelRefresh.hpp
Go to the documentation of this file.
1 //
2 // CDDL HEADER START
3 //
4 // The contents of this file are subject to the terms of the Common Development
5 // and Distribution License Version 1.0 (the "License").
6 //
7 // You can obtain a copy of the license at
8 // http://www.opensource.org/licenses/CDDL-1.0. See the License for the
9 // specific language governing permissions and limitations under the License.
10 //
11 // When distributing Covered Code, include this CDDL HEADER in each file and
12 // include the License file in a prominent location with the name LICENSE.CDDL.
13 // If applicable, add the following below this CDDL HEADER, with the fields
14 // enclosed by brackets "[]" replaced with your own identifying information:
15 //
16 // Portions Copyright (c) [yyyy] [name of copyright owner]. All rights reserved.
17 //
18 // CDDL HEADER END
19 //
20 
21 //
22 // Copyright (c) 2016--2019, Regents of the University of Minnesota.
23 // All rights reserved.
24 //
25 // Contributors:
26 // Ryan S. Elliott
27 //
28 
29 //
30 // Release: This file is part of the kim-api.git repository.
31 //
32 
33 
34 #ifndef KIM_MODEL_REFRESH_HPP_
35 #define KIM_MODEL_REFRESH_HPP_
36 
37 #include <sstream>
38 #include <string>
39 
40 namespace KIM
41 {
42 // Forward declarations
43 class LogVerbosity;
44 class ModelRefreshImplementation;
45 
46 
55 {
56  public:
73  void SetInfluenceDistancePointer(double const * const influenceDistance);
74 
98  int const numberOfNeighborLists,
99  double const * const cutoffs,
100  int const * const modelWillNotRequestNeighborsOfNoncontributingParticles);
101 
118  void GetModelBufferPointer(void ** const ptr) const;
119 
134  void LogEntry(LogVerbosity const logVerbosity,
135  std::string const & message,
136  int const lineNumber,
137  std::string const & fileName) const;
138 
140  void LogEntry(LogVerbosity const logVerbosity,
141  std::stringstream const & message,
142  int const lineNumber,
143  std::string const & fileName) const;
144 
154  std::string const & ToString() const;
155 
156  private:
157  // do not allow copy constructor or operator=
158  ModelRefresh(ModelRefresh const &);
159  void operator=(ModelRefresh const &);
160 
161  ModelRefresh();
162  ~ModelRefresh();
163 
164  ModelRefreshImplementation * pimpl;
165 }; // class ModelRefresh
166 } // namespace KIM
167 
168 #endif // KIM_MODEL_REFRESH_HPP_
Provides the interface to a KIM API Model object for use by models within their MODEL_ROUTINE_NAME::R...
std::string const & ToString() const
Get a string representing the internal state of the Model object.
void LogEntry(LogVerbosity const logVerbosity, std::string const &message, int const lineNumber, std::string const &fileName) const
Write a log entry into the log file.
An Extensible Enumeration for the LogVerbosity&#39;s supported by the KIM API.
void SetInfluenceDistancePointer(double const *const influenceDistance)
Set the Model&#39;s influence distance data pointer.
void GetModelBufferPointer(void **const ptr) const
Get the Model&#39;s buffer pointer within the Model object.
void SetNeighborListPointers(int const numberOfNeighborLists, double const *const cutoffs, int const *const modelWillNotRequestNeighborsOfNoncontributingParticles)
Set the Model&#39;s neighbor list data pointers.