kim-api 2.3.0+AppleClang.AppleClang.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
Loading...
Searching...
No Matches
KIM_ModelComputeArgumentsCreate.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_ARGUMENTS_CREATE_H_
32#define KIM_MODEL_COMPUTE_ARGUMENTS_CREATE_H_
33
34/* Forward declarations */
35#ifndef KIM_LOG_VERBOSITY_DEFINED_
36#define KIM_LOG_VERBOSITY_DEFINED_
43#endif
44
45#ifndef KIM_SUPPORT_STATUS_DEFINED_
46#define KIM_SUPPORT_STATUS_DEFINED_
53#endif
54
55#ifndef KIM_COMPUTE_ARGUMENT_NAME_DEFINED_
56#define KIM_COMPUTE_ARGUMENT_NAME_DEFINED_
63#endif
64
65#ifndef KIM_COMPUTE_CALLBACK_NAME_DEFINED_
66#define KIM_COMPUTE_CALLBACK_NAME_DEFINED_
73#endif
74
75
76#ifndef KIM_MODEL_COMPUTE_ARGUMENTS_CREATE_DEFINED_
77#define KIM_MODEL_COMPUTE_ARGUMENTS_CREATE_DEFINED_
88#endif
89
90
100 KIM_ModelComputeArgumentsCreate * const modelComputeArgumentsCreate,
101 KIM_ComputeArgumentName const computeArgumentName,
102 KIM_SupportStatus const supportStatus);
103
113 KIM_ModelComputeArgumentsCreate * const modelComputeArgumentsCreate,
114 KIM_ComputeCallbackName const computeCallbackName,
115 KIM_SupportStatus const supportStatus);
116
126 KIM_ModelComputeArgumentsCreate * const modelComputeArgumentsCreate,
127 void * const ptr);
128
138 KIM_ModelComputeArgumentsCreate const * const modelComputeArgumentsCreate,
139 KIM_LogVerbosity const logVerbosity,
140 char const * const message,
141 int const lineNumber,
142 char const * const fileName);
143
153 KIM_ModelComputeArgumentsCreate const * const modelComputeArgumentsCreate);
154
155#endif /* KIM_MODEL_COMPUTE_ARGUMENTS_CREATE_H_ */
struct KIM_ModelComputeArgumentsCreate KIM_ModelComputeArgumentsCreate
Forward declaration.
void KIM_ModelComputeArgumentsCreate_SetModelBufferPointer(KIM_ModelComputeArgumentsCreate *const modelComputeArgumentsCreate, void *const ptr)
Set the Model's buffer pointer within the ComputeArguments object.
int KIM_ModelComputeArgumentsCreate_SetCallbackSupportStatus(KIM_ModelComputeArgumentsCreate *const modelComputeArgumentsCreate, KIM_ComputeCallbackName const computeCallbackName, KIM_SupportStatus const supportStatus)
Set the SupportStatus of a ComputeCallbackName.
void KIM_ModelComputeArgumentsCreate_LogEntry(KIM_ModelComputeArgumentsCreate const *const modelComputeArgumentsCreate, 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_ModelComputeArgumentsCreate_ToString(KIM_ModelComputeArgumentsCreate const *const modelComputeArgumentsCreate)
Get a string representing the internal state of the ComputeArguments object.
int KIM_ModelComputeArgumentsCreate_SetArgumentSupportStatus(KIM_ModelComputeArgumentsCreate *const modelComputeArgumentsCreate, KIM_ComputeArgumentName const computeArgumentName, KIM_SupportStatus const supportStatus)
Set the SupportStatus of a ComputeArgumentName.
An Extensible Enumeration for the ComputeArgumentName's supported by the KIM API.
An Extensible Enumeration for the ComputeCallbackName's supported by the KIM API.
An Extensible Enumeration for the LogVerbosity's supported by the KIM API.
An Extensible Enumeration for the SupportStatus's supported by the KIM API.