1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
//
// KIM-API: An API for interatomic models
// Copyright (c) 2013--2022, Regents of the University of Minnesota.
// All rights reserved.
//
// Contributors:
// Ryan S. Elliott
//
// SPDX-License-Identifier: LGPL-2.1-or-later
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this library; if not, write to the Free Software Foundation,
// Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
//
//
// Release: This file is part of the kim-api.git repository.
//
#ifndef KIM_MODEL_COMPUTE_HPP_
#define KIM_MODEL_COMPUTE_HPP_
#include <sstream>
#include <string>
namespace KIM
{
// Forward declarations
class LogVerbosity;
class ModelComputeImplementation;
/// \brief Provides the interface to a %KIM API Model object for use by models
/// within their MODEL_ROUTINE_NAME::Compute routine.
///
/// \sa KIM_ModelCompute,
/// kim_model_compute_module::kim_model_compute_handle_type
///
/// \since 2.0
class ModelCompute
{
public:
/// \brief Get the \ref cache_buffer_pointers "Model's buffer pointer"
/// within the Model object.
///
/// The model buffer pointer may be used by the Model to associate
/// a memory buffer with the Model object.
///
/// \param[out] ptr The model buffer data pointer.
///
/// \note `ptr == NULL` if the model has not previously called
/// ModelCreate::SetModelBufferPointer or
/// ModelDriverCreate::SetModelBufferPointer.
///
/// \sa KIM_ModelCompute_GetModelBufferPointer,
/// kim_model_compute_module::kim_get_model_buffer_pointer
///
/// \since 2.0
void GetModelBufferPointer(void ** const ptr) const;
/// \brief Write a log entry into the log file.
///
/// This results in a no-op if \c logVerbosity is LOG_VERBOSITY::silent or if
/// \c logVerbosity is greater-than the Log object's top LogVerbosity on its
/// stack.
///
/// \param[in] logVerbosity The LogVerbosity level for the entry.
/// \param[in] message The body text of the log entry.
/// \param[in] lineNumber The source code file line number.
/// \param[in] fileName The source code file name.
///
/// \sa KIM_ModelCompute_LogEntry, kim_model_compute_module::kim_log_entry
///
/// \since 2.0
void LogEntry(LogVerbosity const logVerbosity,
std::string const & message,
int const lineNumber,
std::string const & fileName) const;
/// \overload
void LogEntry(LogVerbosity const logVerbosity,
std::stringstream const & message,
int const lineNumber,
std::string const & fileName) const;
/// \brief Get a string representing the internal state of the Model object.
///
/// This string is primarily meant for use as a debugging tool. The string
/// may be quite long. It begins and ends with lines consisting only of \c
/// ='s.
///
/// \sa KIM_ModelCompute_ToString, kim_model_compute_module::kim_to_string
///
/// \since 2.0
std::string const & ToString() const;
private:
// do not allow copy constructor or operator=
ModelCompute(ModelCompute const &);
void operator=(ModelCompute const &);
ModelCompute();
~ModelCompute();
ModelComputeImplementation * pimpl;
}; // class ModelCompute
} // namespace KIM
#endif // KIM_MODEL_COMPUTE_HPP_
|
