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_ModelComputeArgumentsCreate.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.git repository. */
33 /* */
34 
35 
36 #ifndef KIM_MODEL_COMPUTE_ARGUMENTS_CREATE_H_
37 #define KIM_MODEL_COMPUTE_ARGUMENTS_CREATE_H_
38 
39 /* Forward declarations */
40 #ifndef KIM_LOG_VERBOSITY_DEFINED_
41 #define KIM_LOG_VERBOSITY_DEFINED_
42 
48 #endif
49 
50 #ifndef KIM_SUPPORT_STATUS_DEFINED_
51 #define KIM_SUPPORT_STATUS_DEFINED_
52 
58 #endif
59 
60 #ifndef KIM_COMPUTE_ARGUMENT_NAME_DEFINED_
61 #define KIM_COMPUTE_ARGUMENT_NAME_DEFINED_
62 
68 #endif
69 
70 #ifndef KIM_COMPUTE_CALLBACK_NAME_DEFINED_
71 #define KIM_COMPUTE_CALLBACK_NAME_DEFINED_
72 
78 #endif
79 
80 
81 #ifndef KIM_MODEL_COMPUTE_ARGUMENTS_CREATE_DEFINED_
82 #define KIM_MODEL_COMPUTE_ARGUMENTS_CREATE_DEFINED_
83 
93 #endif
94 
95 
105  KIM_ModelComputeArgumentsCreate * const modelComputeArgumentsCreate,
106  KIM_ComputeArgumentName const computeArgumentName,
107  KIM_SupportStatus const supportStatus);
108 
118  KIM_ModelComputeArgumentsCreate * const modelComputeArgumentsCreate,
119  KIM_ComputeCallbackName const computeCallbackName,
120  KIM_SupportStatus const supportStatus);
121 
131  KIM_ModelComputeArgumentsCreate * const modelComputeArgumentsCreate,
132  void * const ptr);
133 
143  KIM_ModelComputeArgumentsCreate const * const modelComputeArgumentsCreate,
144  KIM_LogVerbosity const logVerbosity,
145  char const * const message,
146  int const lineNumber,
147  char const * const fileName);
148 
158  KIM_ModelComputeArgumentsCreate const * const modelComputeArgumentsCreate);
159 
160 #endif /* KIM_MODEL_COMPUTE_ARGUMENTS_CREATE_H_ */
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.
An Extensible Enumeration for the ComputeArgumentName's supported by the KIM API. ...
int KIM_ModelComputeArgumentsCreate_SetCallbackSupportStatus(KIM_ModelComputeArgumentsCreate *const modelComputeArgumentsCreate, KIM_ComputeCallbackName const computeCallbackName, KIM_SupportStatus const supportStatus)
Set the SupportStatus of a ComputeCallbackName.
An Extensible Enumeration for the SupportStatus's supported by the KIM API.
struct KIM_ModelComputeArgumentsCreate KIM_ModelComputeArgumentsCreate
Forward declaration.
int KIM_ModelComputeArgumentsCreate_SetArgumentSupportStatus(KIM_ModelComputeArgumentsCreate *const modelComputeArgumentsCreate, KIM_ComputeArgumentName const computeArgumentName, KIM_SupportStatus const supportStatus)
Set the SupportStatus of a ComputeArgumentName.
void KIM_ModelComputeArgumentsCreate_SetModelBufferPointer(KIM_ModelComputeArgumentsCreate *const modelComputeArgumentsCreate, void *const ptr)
Set the Model's buffer pointer within the ComputeArguments object.
An Extensible Enumeration for the LogVerbosity's supported by the KIM API.
char const * KIM_ModelComputeArgumentsCreate_ToString(KIM_ModelComputeArgumentsCreate const *const modelComputeArgumentsCreate)
Get a string representing the internal state of the ComputeArguments object.
An Extensible Enumeration for the ComputeCallbackName's supported by the KIM API. ...