kim-api  2.3.0+v2.3.0.GNU.GNU.
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
KIM_ModelCompute.h
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-2.3.0 package. */
28 /* */
29 
30 
31 #ifndef KIM_MODEL_COMPUTE_H_
32 #define KIM_MODEL_COMPUTE_H_
33 
34 /* Forward declarations */
35 #ifndef KIM_LOG_VERBOSITY_DEFINED_
36 #define KIM_LOG_VERBOSITY_DEFINED_
37 
43 #endif
44 
45 
46 #ifndef KIM_MODEL_COMPUTE_DEFINED_
47 #define KIM_MODEL_COMPUTE_DEFINED_
48 
57 #endif
58 
68  KIM_ModelCompute const * const modelCompute, void ** const ptr);
69 
77 void KIM_ModelCompute_LogEntry(KIM_ModelCompute const * const modelCompute,
78  KIM_LogVerbosity const logVerbosity,
79  char const * const message,
80  int const lineNumber,
81  char const * const fileName);
82 
90 char const *
91 KIM_ModelCompute_ToString(KIM_ModelCompute const * const modelCompute);
92 
93 #endif /* KIM_MODEL_COMPUTE_H_ */
struct KIM_ModelCompute KIM_ModelCompute
Forward declaration.
void KIM_ModelCompute_GetModelBufferPointer(KIM_ModelCompute const *const modelCompute, void **const ptr)
Get the Model's buffer pointer within the Model object.
An Extensible Enumeration for the LogVerbosity's supported by the KIM API.
void KIM_ModelCompute_LogEntry(KIM_ModelCompute const *const modelCompute, KIM_LogVerbosity const logVerbosity, char const *const message, int const lineNumber, char const *const fileName)
Write a log entry into the log file.
char const * KIM_ModelCompute_ToString(KIM_ModelCompute const *const modelCompute)
Get a string representing the internal state of the Model object.