kim-api  2.1.2+v2.1.2.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
KIM_ModelDestroy.h
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 */
5 /* Development 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 */
13 /* LICENSE.CDDL. */
14 /* If applicable, add the following below this CDDL HEADER, with the fields */
15 /* enclosed by brackets "[]" replaced with your own identifying information: */
16 /* */
17 /* Portions Copyright (c) [yyyy] [name of copyright owner]. */
18 /* All rights reserved. */
19 /* */
20 /* CDDL HEADER END */
21 /* */
22 
23 /* */
24 /* Copyright (c) 2016--2019, Regents of the University of Minnesota. */
25 /* All rights reserved. */
26 /* */
27 /* Contributors: */
28 /* Ryan S. Elliott */
29 /* */
30 
31 /* */
32 /* Release: This file is part of the kim-api-2.1.2 package. */
33 /* */
34 
35 
36 #ifndef KIM_MODEL_DESTROY_H_
37 #define KIM_MODEL_DESTROY_H_
38 
39 /* Forward declarations */
40 #ifndef KIM_LOG_VERBOSITY_DEFINED_
41 #define KIM_LOG_VERBOSITY_DEFINED_
42 
48 #endif
49 
50 
51 #ifndef KIM_MODEL_DESTROY_DEFINED_
52 #define KIM_MODEL_DESTROY_DEFINED_
53 
62 #endif
63 
73  KIM_ModelDestroy const * const modelDestroy, void ** const ptr);
74 
82 void KIM_ModelDestroy_LogEntry(KIM_ModelDestroy const * const modelDestroy,
83  KIM_LogVerbosity const logVerbosity,
84  char const * const message,
85  int const lineNumber,
86  char const * const fileName);
87 
95 char const *
96 KIM_ModelDestroy_ToString(KIM_ModelDestroy const * const modelDestroy);
97 
98 #endif /* KIM_MODEL_DESTROY_H_ */
void KIM_ModelDestroy_GetModelBufferPointer(KIM_ModelDestroy const *const modelDestroy, void **const ptr)
Get the Model's buffer pointer within the Model object.
void KIM_ModelDestroy_LogEntry(KIM_ModelDestroy const *const modelDestroy, 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_ModelDestroy_ToString(KIM_ModelDestroy const *const modelDestroy)
Get a string representing the internal state of the Model object.
struct KIM_ModelDestroy KIM_ModelDestroy
Forward declaration.
An Extensible Enumeration for the LogVerbosity's supported by the KIM API.